com.ibm.tivoli.maximo.slroute

Interface SLRouteServiceRemote

All Superinterfaces:

AppServiceRemote, DispatchAppletProperties, java.rmi.Remote, ServiceRemote

All Known Implementing Classes:

SLRouteService

public interface SLRouteServiceRemote
extends AppServiceRemote, DispatchAppletProperties

Field Summary

Fields inherited from interface com.ibm.tivoli.maximo.skd.model.DispatchAppletProperties

FWM_APP_CACHE, FWM_MAPSELECTFLAG, FWM_RESOURCEKEY_PREFIX, FWM_RESOURCEKEY_SKDPROPERTY, FWM_RESOURCEOBJ_PREFIX, FWMRESKEY, FWMTYPE, PROPERTY_ADDRESS, PROPERTY_ASSIGNMENTID, PROPERTY_DURATION_IN_SECS, PROPERTY_FROMASSIGNMENT, PROPERTY_FROMLOCATION, PROPERTY_GISABLE, PROPERTY_HASTRAVELTIME, PROPERTY_LATITUDE, PROPERTY_LONGITUDE, PROPERTY_MBO_JSON, PROPERTY_NEXTASSIGNMENT, PROPERTY_PREVASSIGNMENT, PROPERTY_RES_DESC, PROPERTY_RES_ID, PROPERTY_RES_MOUSEOVER, PROPERTY_RES_START, PROPERTY_RES_TYPE_CRAFT, PROPERTY_RES_TYPE_CREW, PROPERTY_RES_TYPE_CREWTYPE, PROPERTY_RES_TYPE_HIERSTUB, PROPERTY_RES_TYPE_LABOR, PROPERTY_ROUTEINFO, PROPERTY_SHIFTENDDATE, PROPERTY_SHIFTINFO, PROPERTY_SHIFTSTARTDATE, PROPERTY_SITEID, PROPERTY_SLROUTEID, PROPERTY_TOLOCATION, PROPERTY_UIDNAME, PROPERTY_UIDVALUE, PROPERTY_WO_MOUSEOVER, PROPERTY_WO_STATUS, PROPERTY_WONUM, TYPE_ASSIGNMENT, TYPE_ENDLOCATION, TYPE_NONWORKACT, TYPE_STARTLOCATION, TYPE_WORKACT

Method Summary

Modifier and Type	Method and Description
int	applyRoutes(MboRemote slroute)
void	clearSLRTravelTimeData(AssignmentRemote assignment)
void	clearStaticDataCaches()
int	createSLRBasedOnSKDProject(MboRemote skdProj)
MboSetRemote	getCrewAssignments(java.lang.String amcrew, UserInfo userInfo, java.util.Date start, java.util.Date end, java.lang.String orgId, SLRouteServiceCache appCache)
MboSetRemote	getLaborAssignments(java.lang.String labor, UserInfo userInfo, java.util.Date start, java.util.Date end, java.lang.String orgId, SLRouteServiceCache appCache)
ilog.views.gantt.IlvGanttModel	getModel(UserInfo userInfo, java.lang.String skdProjID, boolean addShiftInfo, SLRouteServiceCache appCache)
ilog.views.gantt.IlvGanttModel	getModelForResource(UserInfo userInfo, java.lang.String skdProjID, java.lang.String resObj, java.lang.String resKey, SLRouteServiceCache appCache)
java.util.List<MboSetRemote>	getSKDProjectResources(MboRemote skdProj, boolean useResourceFilter, SLRouteServiceCache appCache)
SLRouteSetRemote	getSLRouteSet(SLRouteRemote slroute)
SLRouteSetRemote	getSLRouteSetFromSelection(SLRouteRemote slroute) Gets the sL route set from selection.
void	recalculateTravelTimeForAssigment(MXGanttModel mxModel, MXActivity fromAssignment, MXActivity toAssignment, MXResource resource, MboRemote project, UserInfo userInfo) Recalculate Travel Time for Moved/Created Assignments.
java.util.List<MXReservation>	refreshModel(ilog.views.gantt.IlvGanttModel model, UserInfo userInfo, SLRouteServiceCache appCache) Refreshes work orders and assignments that are available for this Schedule/Project.
java.lang.String	updateTravelTime(ilog.views.gantt.IlvGanttModel model, java.lang.String toAssignId, java.lang.String fromAssignId, java.lang.String fromLocationId, java.lang.String toLocationId, java.lang.String slrRouteId, java.lang.Double duration, UserInfo userInfo)

Methods inherited from interface psdi.server.AppServiceRemote

checkSecurity, getCriteria, getCurrentState, getLiveObjCount, getMboSet, getName, getSchemaOwner, getSetForRelationship, getSetFromKeys, getStateCmdList, getStateList, getURL, verifyUser, verifyUser

Methods inherited from interface psdi.server.ServiceRemote

isAppService, isSingletonService, restart

Method Detail

createSLRBasedOnSKDProject

int createSLRBasedOnSKDProject(MboRemote skdProj)
                        throws MXException,
                               java.rmi.RemoteException

Returns:

Throws:

MXException

java.rmi.RemoteException

See Also:

SLRouteService.createSLRBasedOnSKDProject(MboRemote)

getCrewAssignments

MboSetRemote getCrewAssignments(java.lang.String amcrew,
                                UserInfo userInfo,
                                java.util.Date start,
                                java.util.Date end,
                                java.lang.String orgId,
                                SLRouteServiceCache appCache)
                         throws MXException,
                                java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

See Also:

SLRouteService.getCrewAssignments(String, UserInfo, Date, Date, String, SLRouteServiceCache)

getLaborAssignments

MboSetRemote getLaborAssignments(java.lang.String labor,
                                 UserInfo userInfo,
                                 java.util.Date start,
                                 java.util.Date end,
                                 java.lang.String orgId,
                                 SLRouteServiceCache appCache)
                          throws MXException,
                                 java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

See Also:

SLRouteService.getLaborAssignments(String, UserInfo, Date, Date, String, SLRouteServiceCache)

getSLRouteSet

SLRouteSetRemote getSLRouteSet(SLRouteRemote slroute)
                        throws java.rmi.RemoteException,
                               MXException

Throws:

java.rmi.RemoteException

MXException

See Also:

SLRouteService.getSLRouteSet(SLRouteRemote)

getSLRouteSetFromSelection

SLRouteSetRemote getSLRouteSetFromSelection(SLRouteRemote slroute)
                                     throws java.rmi.RemoteException,
                                            MXException

Gets the sL route set from selection.

Parameters:

slroute - theSLRoute dialog object containing the selected Slroutes records

Returns:

the a SLRouteSet that mathces the selection criteria

Throws:

java.rmi.RemoteException - the remote exception

MXException - the mX exception

See Also:

SLRouteService.getSLRouteSetFromSelection(SLRouteRemote)

applyRoutes

int applyRoutes(MboRemote slroute)
         throws MXException,
                java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

See Also:

SLRouteService.applyRoutes(MboRemote)

getModel

ilog.views.gantt.IlvGanttModel getModel(UserInfo userInfo,
                                        java.lang.String skdProjID,
                                        boolean addShiftInfo,
                                        SLRouteServiceCache appCache)
                                 throws MXException,
                                        java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

See Also:

SLRouteService#getModel(UserInfo, String, Date, Date)

updateTravelTime

java.lang.String updateTravelTime(ilog.views.gantt.IlvGanttModel model,
                                  java.lang.String toAssignId,
                                  java.lang.String fromAssignId,
                                  java.lang.String fromLocationId,
                                  java.lang.String toLocationId,
                                  java.lang.String slrRouteId,
                                  java.lang.Double duration,
                                  UserInfo userInfo)
                           throws java.rmi.RemoteException,
                                  MXException

Throws:

java.rmi.RemoteException

MXException

clearSLRTravelTimeData

void clearSLRTravelTimeData(AssignmentRemote assignment)
                     throws java.rmi.RemoteException,
                            MXException

Throws:

java.rmi.RemoteException

MXException

getModelForResource

ilog.views.gantt.IlvGanttModel getModelForResource(UserInfo userInfo,
                                                   java.lang.String skdProjID,
                                                   java.lang.String resObj,
                                                   java.lang.String resKey,
                                                   SLRouteServiceCache appCache)
                                            throws MXException,
                                                   java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

See Also:

SLRouteService#getModelForResource(UserInfo, String, String, String)

getSKDProjectResources

java.util.List<MboSetRemote> getSKDProjectResources(MboRemote skdProj,
                                                    boolean useResourceFilter,
                                                    SLRouteServiceCache appCache)
                                             throws MXException,
                                                    java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

See Also:

SLRouteService#getSKDProjectResources(MboRemote, boolean)

clearStaticDataCaches

void clearStaticDataCaches()
                    throws MXException,
                           java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

See Also:

SLRouteService.clearStaticDataCaches()

refreshModel

java.util.List<MXReservation> refreshModel(ilog.views.gantt.IlvGanttModel model,
                                           UserInfo userInfo,
                                           SLRouteServiceCache appCache)
                                    throws MXException,
                                           java.rmi.RemoteException

Refreshes work orders and assignments that are available for this Schedule/Project. This method is going to selectively refresh the model by adding, removing or updating Work Orders that have been updated, since the model has been last loaded.

Parameters:

model -

appCache -

Throws:

MXException

java.rmi.RemoteException

recalculateTravelTimeForAssigment

void recalculateTravelTimeForAssigment(MXGanttModel mxModel,
                                       MXActivity fromAssignment,
                                       MXActivity toAssignment,
                                       MXResource resource,
                                       MboRemote project,
                                       UserInfo userInfo)
                                throws java.rmi.RemoteException,
                                       MXException

Recalculate Travel Time for Moved/Created Assignments.

Parameters:

mxModel -

fromAssignment -

toAssignment -

currentActivity -

slroute -

userInfo -

Throws:

java.rmi.RemoteException

MXException