com.ibm.tivoli.maximo.slroute

Class SLRouteService

java.lang.Object

psdi.server.AppService

com.ibm.tivoli.maximo.slroute.SLRouteService

All Implemented Interfaces:

DispatchAppletProperties, SLRouteServiceRemote, java.rmi.Remote, MboServerInterface, MaxRemoteProxy, AppServiceRemote, Dependable, Service, ServiceRemote, FixedLoggerNames, FixedLoggers

public class SLRouteService
extends AppService
implements SLRouteServiceRemote

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_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

Fields inherited from interface psdi.util.logging.FixedLoggers

APPLOGGER, CRONTASKLOGGER, CRONTASKMGRLOGGER, CRONTASKMGRSQLLOGGER, DBCONNECTIONLOGGER, DDLOGGER, DMLOGGER, EVENTLOGGER, EXCEPTIONLOGGER, MAILLOGGER, MAXIMOLOGGER, MTLOGGER, NULLMBOPOINTER, SECURITY, SENDFAILEDLOGGER, SERVICELOGGER, SQLLOGGER

Fields inherited from interface psdi.util.logging.FixedLoggerNames

appenderPrefix, LOGGERNAME_APP, LOGGERNAME_CRONTASK, LOGGERNAME_CRONTASKMGR, LOGGERNAME_DBCONNECTION, LOGGERNAME_DD, LOGGERNAME_DM, LOGGERNAME_DMPREVIEW, LOGGERNAME_EVENT, LOGGERNAME_EXCEPTION, LOGGERNAME_MAIL, LOGGERNAME_MAXIMO, LOGGERNAME_MT, LOGGERNAME_NULLMBOPOINTER, LOGGERNAME_SECURITY, LOGGERNAME_SENDFAILED, LOGGERNAME_SERVICE, LOGGERNAME_SQL, LOGGERNAME_SQL_CRONTASKMGR, LOGGERNAME_TXN, loggerPrefix

Constructor Summary

Constructors

Constructor and Description
SLRouteService(MXServer mxServer)

Method Summary

Methods

Modifier and Type	Method and Description
int	applyRoutes(MboRemote slroute)
void	clearSLRTravelTimeData(AssignmentRemote assignment)
void	clearStaticDataCaches() clear out the static data caches
int	createSLRBasedOnSKDProject(MboRemote skdProj) Creates the slroute records based on values of the passed on SKDProject record.
MboSetRemote	getCrewAssignments(java.lang.String amcrew, UserInfo userInfo, java.util.Date start, java.util.Date end, java.lang.String orgId)
MboSetRemote	getLaborAssignments(java.lang.String labor, UserInfo userInfo, java.util.Date start, java.util.Date end, java.lang.String orgId)
ilog.views.gantt.IlvGanttModel	getModel(UserInfo userInfo, java.lang.String skdProjID, boolean addShiftInfo, SLRouteServiceCache appCache) Get Gantt model for dispatch view
ilog.views.gantt.IlvGanttModel	getModelForResource(UserInfo userInfo, java.lang.String skdProjID, java.lang.String resObj, java.lang.String resKey, SLRouteServiceCache appCache) loads a subset of the model for a single resource, used for partial model updates.
ilog.views.gantt.IlvGanttModel	getModelNew(UserInfo userInfo, java.lang.String rootActivityName, java.lang.String rootResourceName, java.util.List<MboSetRemote> resMboSetList, java.util.Date startDate, java.util.Date endDate, int shiftMargin, SLRouteServiceCache appCache, boolean addHierachy, MboRemote skdProj) Create the model and calls the function that fetches the resources to be used to get the model.
MboSetRemote	getSkdProjAssignments(MboRemote skdProj)
MboSetRemote	getSkdProjAssignments(MboRemote skdProj, java.util.Date start, java.util.Date end)
java.util.List<MboSetRemote>	getSKDProjectResources(MboRemote skdProj, boolean useResourceFilter, SLRouteServiceCache appCache) Fetches all of the resources to use when fetching the full dispatch model from the database.
SLRouteSetRemote	getSLRouteSet(SLRouteRemote slroute)
SLRouteSetRemote	getSLRouteSetFromSelection(SLRouteRemote slroute) Gets the sL route set from selection.
SLRTravelTimeSetRemote	getSLRTravelTimeRecord(java.lang.String toAssignId, java.lang.String fromAssignId, java.lang.String fromLocationId, java.lang.String toLocationId, long slrRouteId, UserInfo userInfo) Returns the mboset for a single travel time record.
void	updateTravelTime(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 class psdi.server.AppService

checkSecurity, configure, destroy, freeDBConnection, freeMboSet, getCriteria, getCurrentState, getDBConnection, getLiveObjCount, getLoad, getMaximoDD, getMaxVar, getMboSet, getMXServer, getName, getProfile, getProxy, getSchemaOwner, getServiceInfo, getServiceLogger, getSetForRelationship, getSetFromKeys, getStateCmdList, getStateList, getURL, init, initCriteriaList, isAppService, isRunning, isSingletonService, restart, setProxy, setRunning, setURL, verifyUser, verifyUser

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

Constructor Detail

SLRouteService

public SLRouteService(MXServer mxServer)
               throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

Method Detail

createSLRBasedOnSKDProject

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

Creates the slroute records based on values of the passed on SKDProject record. It reuses the functionality of the applyRoutes function which was originally written to handle the Apply Routes dialog. Since we want the routes to be filled in the same way that that dialog works, we now just use the SKDProject settings to setup and then call that function.

Specified by:

createSLRBasedOnSKDProject in interface SLRouteServiceRemote

Returns:

Throws:

MXException

java.rmi.RemoteException

See Also:

createSLRBasedOnSKDProject(MboRemote)

getSKDProjectResources

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

Fetches all of the resources to use when fetching the full dispatch model from the database. The return list contains a new mboset for each of the different resource types found.

Specified by:

getSKDProjectResources in interface SLRouteServiceRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

SLRouteService#getSKDProjectResources(MboRemote, boolean)

getSkdProjAssignments

public MboSetRemote getSkdProjAssignments(MboRemote skdProj)
                                   throws MXException,
                                          java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

getSkdProjAssignments

public MboSetRemote getSkdProjAssignments(MboRemote skdProj,
                                 java.util.Date start,
                                 java.util.Date end)
                                   throws MXException,
                                          java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

getCrewAssignments

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

Specified by:

getCrewAssignments in interface SLRouteServiceRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

getCrewAssignments(String, UserInfo, Date, Date, String)

getLaborAssignments

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

Specified by:

getLaborAssignments in interface SLRouteServiceRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

getLaborAssignments(String, UserInfo, Date, Date, String)

getSLRouteSet

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

Specified by:

getSLRouteSet in interface SLRouteServiceRemote

Throws:

java.rmi.RemoteException

MXException

See Also:

getSLRouteSet(SLRouteRemote)

applyRoutes

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

Specified by:

applyRoutes in interface SLRouteServiceRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

applyRoutes(MboRemote)

getModel

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

Get Gantt model for dispatch view

Specified by:

getModel in interface SLRouteServiceRemote

Parameters:

userInfo - user information

skdProjID - SKDProject unique ID

startDate - Start Date

endDate - End Date

Returns:

IlvGanttModel

Throws:

MXException

java.rmi.RemoteException

See Also:

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

updateTravelTime

public void updateTravelTime(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

Specified by:

updateTravelTime in interface SLRouteServiceRemote

Throws:

java.rmi.RemoteException

MXException

clearSLRTravelTimeData

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

Specified by:

clearSLRTravelTimeData in interface SLRouteServiceRemote

Throws:

java.rmi.RemoteException

MXException

getSLRouteSetFromSelection

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

Description copied from interface: SLRouteServiceRemote

Gets the sL route set from selection.

Specified by:

getSLRouteSetFromSelection in interface SLRouteServiceRemote

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:

getSLRouteSetFromSelection(SLRouteRemote)

getModelNew

public ilog.views.gantt.IlvGanttModel getModelNew(UserInfo userInfo,
                                         java.lang.String rootActivityName,
                                         java.lang.String rootResourceName,
                                         java.util.List<MboSetRemote> resMboSetList,
                                         java.util.Date startDate,
                                         java.util.Date endDate,
                                         int shiftMargin,
                                         SLRouteServiceCache appCache,
                                         boolean addHierachy,
                                         MboRemote skdProj)
                                           throws MXException,
                                                  java.rmi.RemoteException

Create the model and calls the function that fetches the resources to be used to get the model. Returns the gantt model to be returned to the applet.

Parameters:

userInfo -

rootActivityName -

rootResourceName -

resMboSetList -

startDate -

endDate -

Returns:

Throws:

MXException

java.rmi.RemoteException

getModelForResource

public 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

loads a subset of the model for a single resource, used for partial model updates.

Specified by:

getModelForResource in interface SLRouteServiceRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

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

clearStaticDataCaches

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

clear out the static data caches

Specified by:

clearStaticDataCaches in interface SLRouteServiceRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

clearStaticDataCaches()

getSLRTravelTimeRecord

public SLRTravelTimeSetRemote getSLRTravelTimeRecord(java.lang.String toAssignId,
                                            java.lang.String fromAssignId,
                                            java.lang.String fromLocationId,
                                            java.lang.String toLocationId,
                                            long slrRouteId,
                                            UserInfo userInfo)
                                              throws java.rmi.RemoteException,
                                                     MXException

Returns the mboset for a single travel time record. It requires a valid combination of 2 from and to assignments or locations.

Parameters:

toAssignId -

fromAssignId -

fromLocationId -

toLocationId -

slrRouteId -

userInfo -

Returns:

Throws:

java.rmi.RemoteException

MXException