com.ibm.tivoli.maximo.skd.service

Interface SKDAppServiceRemote

All Superinterfaces:

AppServiceRemote, java.rmi.Remote, ServiceRemote

All Known Implementing Classes:

SKDAppService

public interface SKDAppServiceRemote
extends AppServiceRemote

Method Summary

Methods

Modifier and Type	Method and Description
boolean	activitiesInitialized(MboRemote projectMbo) Indicates if project is initialized or not
void	assignLaborCrewFromSuggestSet(MboSetRemote emWOAvailResSet, UserInfo userInfo, java.util.Date currentTime)
boolean	asyncCommitNeeded(MboRemote projectMbo) Check if asynchronous commit is needed or not
void	commitModifiedModelChanges(UserInfo userInfo, java.lang.String projectId) Commit modified model changes to the database
void	commitModifiedModelChanges(UserInfo userInfo, java.lang.String projectId, java.lang.String ids, java.lang.String objectName) Commit selected modified model changes to the database
void	commitScenario(UserInfo userInfo, java.lang.String ScenarioProjectid) qiuping scheduler7520 Commit modified model changes to the database
void	commitScenario(UserInfo userInfo, java.lang.String ScenarioProjectid, java.lang.String ids) qiuping scheduler7520 Commit modified model changes to the database
void	deleteProjectData(UserInfo userInfo, MboRemote projectMbo) Delete project and all its related data
void	duplicateProjectData(UserInfo userInfo, java.lang.String projectId, MboRemote duplicateProjectMbo) Duplicates the project data i.e the same state as of now
int	dynamicScheduling(long skdProjectId, java.lang.String emWhere, boolean autoassign)
ISKDAvailability	getAvailabilities(UserInfo ui, java.lang.String[] availParam) Get availabilities for a workorder
ilog.views.gantt.IlvGanttModel	getCapacityPlanningGapModel(UserInfo userInfo, SKDCapacityPlanningGapRequestParams params) Fetches the Capacity Planning Gap Data from the SKDWORKPLANEXTCAP table and puts it into a Gantt Model
GanttConfigInfo	getGanttConfigInfo(UserInfo userInfo, MboRemote project) Get Gantt configuration information for the project with project mbo
GanttConfigInfo	getGanttConfigInfo(UserInfo userInfo, java.lang.String projectId) Get Gantt configuration information for the project with project id
ISKDItemAvailability	getItemAvailabilities(UserInfo ui, java.lang.String[] availParam) Get availabilities for a workorder
ilog.views.gantt.IlvGanttModel	getModel(UserInfo userInfo, java.lang.String projectId) Get the scenario or baseline/snapshot model
java.util.Date	getServerDate() Get server date
void	getShiftInfoForDispatch(UserInfo userInfo, MXGanttModel model, MboRemote project, boolean trimByProject) fetches shift information for the dispatch applet
SKDAppServiceBeanRemote	getSKDAppServiceBean(UserInfo userInfo) Returns a new instance of the SKDAppServiceBean
ISKDUIInfo	getSKDUIInfo(UserInfo userInfo) Get the ISKDUIInfo for the user
ISKDUIInfo	getSKDUIInfo(UserInfo userInfo, java.lang.String appName) Get the ISKDUIInfo for the user
ISKDUIInfo	getSKDUIInfo(UserInfo userInfo, java.lang.String appName, java.lang.String projectId) Get the ISKDUIInfo for the user
SKDUserLocaleData	getSKDUserLocaleData(UserInfo userInfo) Get the locale data for the user
java.util.Properties	getSKDViewerProperties() Return the user overriden properties from MAXPROPVALUE for SCHEDULER
java.lang.Object	performSkdAction(java.lang.String projectId, UserInfo userInfo, java.lang.String actionId, java.lang.Object actionObject, boolean saveBeforeAction, SKDAppServiceBeanRemote serviceBean) Perform action by calling action class
void	populateProjectData(UserInfo userInfo, MboRemote project) Populate project data with project mbo
void	populateProjectData(UserInfo userInfo, java.lang.String projectId) Populate project data with project id
boolean	PopulateSKDOrigiDestMatrix(MboRemote projectMbo) populate skdorigindestmatrix for project - need call MAP api method
int	updateTravelTimeMatrixFor(java.lang.String orgId, java.util.Map<java.lang.String,SKDMAPInputParamInfo> taskSACodeMap, java.util.Map<java.lang.String,SKDMAPInputParamInfo> onTheFlyWOIDMap, java.util.Map<java.lang.String,SKDMAPInputParamInfo> resourceStartSACodeMap, java.util.Map<java.lang.String,SKDMAPInputParamInfo> resourceEndSACodeMap, UserInfo userInfo) API to update the SKDORIGINDESTMATRIX table with travel times retrieved from the map provider.

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

getSKDAppServiceBean

SKDAppServiceBeanRemote getSKDAppServiceBean(UserInfo userInfo)
                                             throws MXException,
                                                    java.rmi.RemoteException

Returns a new instance of the SKDAppServiceBean

Parameters:

userInfo - user information

Returns:

SKDAppServiceBeanRemote SKD App service bean remote reference, if the bean is successfully created, otherwise throws exception.

Throws:

MXException - when fails to create bean instance.

java.rmi.RemoteException

getModel

ilog.views.gantt.IlvGanttModel getModel(UserInfo userInfo,
                                      java.lang.String projectId)
                                        throws MXException,
                                               java.rmi.RemoteException

Get the scenario or baseline/snapshot model

Parameters:

userInfo -

projectId -

Returns:

model

Throws:

MXException

java.rmi.RemoteException

populateProjectData

void populateProjectData(UserInfo userInfo,
                       java.lang.String projectId)
                         throws MXException,
                                java.rmi.RemoteException

Populate project data with project id

Parameters:

userInfo -

projectId -

Throws:

MXException

java.rmi.RemoteException

populateProjectData

void populateProjectData(UserInfo userInfo,
                       MboRemote project)
                         throws MXException,
                                java.rmi.RemoteException

Populate project data with project mbo

Parameters:

userInfo -

project -

Throws:

MXException

java.rmi.RemoteException

commitModifiedModelChanges

void commitModifiedModelChanges(UserInfo userInfo,
                              java.lang.String projectId)
                                throws MXException,
                                       java.rmi.RemoteException

Commit modified model changes to the database

Parameters:

userInfo -

projectId -

Throws:

MXException

java.rmi.RemoteException

commitModifiedModelChanges

void commitModifiedModelChanges(UserInfo userInfo,
                              java.lang.String projectId,
                              java.lang.String ids,
                              java.lang.String objectName)
                                throws MXException,
                                       java.rmi.RemoteException

Commit selected modified model changes to the database

Parameters:

userInfo -

projectId -

ids -

objectName -

Throws:

MXException

java.rmi.RemoteException

commitScenario

void commitScenario(UserInfo userInfo,
                  java.lang.String ScenarioProjectid)
                    throws MXException,
                           java.rmi.RemoteException

qiuping scheduler7520 Commit modified model changes to the database

Parameters:

userInfo -

projectId -

Throws:

MXException

java.rmi.RemoteException

commitScenario

void commitScenario(UserInfo userInfo,
                  java.lang.String ScenarioProjectid,
                  java.lang.String ids)
                    throws MXException,
                           java.rmi.RemoteException

qiuping scheduler7520 Commit modified model changes to the database

Parameters:

userInfo -

projectId -

ids -

Throws:

MXException

java.rmi.RemoteException

getGanttConfigInfo

GanttConfigInfo getGanttConfigInfo(UserInfo userInfo,
                                 java.lang.String projectId)
                                   throws MXException,
                                          java.rmi.RemoteException

Get Gantt configuration information for the project with project id

Parameters:

userInfo -

projectId -

Returns:

GanttConfigInfo

Throws:

MXException

java.rmi.RemoteException

getGanttConfigInfo

GanttConfigInfo getGanttConfigInfo(UserInfo userInfo,
                                 MboRemote project)
                                   throws MXException,
                                          java.rmi.RemoteException

Get Gantt configuration information for the project with project mbo

Parameters:

userInfo -

project -

Returns:

GanttConfigInfo

Throws:

MXException

java.rmi.RemoteException

getSKDUserLocaleData

SKDUserLocaleData getSKDUserLocaleData(UserInfo userInfo)
                                       throws MXException,
                                              java.rmi.RemoteException

Get the locale data for the user

Parameters:

userInfo -

Returns:

SKDUserLocaleData

Throws:

MXException

java.rmi.RemoteException

getSKDUIInfo

ISKDUIInfo getSKDUIInfo(UserInfo userInfo)
                        throws MXException,
                               java.rmi.RemoteException

Get the ISKDUIInfo for the user

Parameters:

userInfo -

Returns:

ISKDUIInfo

Throws:

MXException

java.rmi.RemoteException

getSKDUIInfo

ISKDUIInfo getSKDUIInfo(UserInfo userInfo,
                      java.lang.String appName)
                        throws MXException,
                               java.rmi.RemoteException

Get the ISKDUIInfo for the user

Parameters:

userInfo -

appName -

Returns:

ISKDUIInfo

Throws:

MXException

java.rmi.RemoteException

getSKDUIInfo

ISKDUIInfo getSKDUIInfo(UserInfo userInfo,
                      java.lang.String appName,
                      java.lang.String projectId)
                        throws MXException,
                               java.rmi.RemoteException

Get the ISKDUIInfo for the user

Parameters:

userInfo -

appName -

projectId -

Returns:

ISKDUIInfo

Throws:

MXException

java.rmi.RemoteException

duplicateProjectData

void duplicateProjectData(UserInfo userInfo,
                        java.lang.String projectId,
                        MboRemote duplicateProjectMbo)
                          throws MXException,
                                 java.rmi.RemoteException

Duplicates the project data i.e the same state as of now

Parameters:

userInfo -

projectId -

duplicateProjectMbo - - Duplicated project Mbo

Throws:

MXException

java.rmi.RemoteException

asyncCommitNeeded

boolean asyncCommitNeeded(MboRemote projectMbo)
                          throws MXException,
                                 java.rmi.RemoteException

Check if asynchronous commit is needed or not

Parameters:

projectMbo -

Returns:

true if asynchronous commit is needed else false

Throws:

MXException

java.rmi.RemoteException

performSkdAction

java.lang.Object performSkdAction(java.lang.String projectId,
                                UserInfo userInfo,
                                java.lang.String actionId,
                                java.lang.Object actionObject,
                                boolean saveBeforeAction,
                                SKDAppServiceBeanRemote serviceBean)
                                  throws java.lang.Exception,
                                         java.rmi.RemoteException

Perform action by calling action class

Parameters:

projectId - - Project id

- - userinfo

actionid - - Unique id of action in skdaction

actionObject - - object on which action will act

saveBeforeAction - - flag to indicate if model need to be saved before action or not.

Throws:

MXException

java.rmi.RemoteException

java.lang.Exception

deleteProjectData

void deleteProjectData(UserInfo userInfo,
                     MboRemote projectMbo)
                       throws MXException,
                              java.rmi.RemoteException

Delete project and all its related data

Parameters:

- - userinfo

- - Project mbo

Throws:

MXException

java.rmi.RemoteException

getServerDate

java.util.Date getServerDate()
                             throws MXException,
                                    java.rmi.RemoteException

Get server date

Returns:

server date

Throws:

MXException

java.rmi.RemoteException

getAvailabilities

ISKDAvailability getAvailabilities(UserInfo ui,
                                 java.lang.String[] availParam)
                                   throws MXException,
                                          java.rmi.RemoteException

Get availabilities for a workorder

Parameters:

ui -

workorder - id, start date,end date, reference object name

Returns:

Throws:

MXException

java.rmi.RemoteException

getItemAvailabilities

ISKDItemAvailability getItemAvailabilities(UserInfo ui,
                                         java.lang.String[] availParam)
                                           throws MXException,
                                                  java.rmi.RemoteException

Get availabilities for a workorder

Parameters:

ui -

workorder - id, start date,end date, reference object name

Returns:

Throws:

MXException

java.rmi.RemoteException

getShiftInfoForDispatch

void getShiftInfoForDispatch(UserInfo userInfo,
                           MXGanttModel model,
                           MboRemote project,
                           boolean trimByProject)
                             throws MXException,
                                    java.rmi.RemoteException

fetches shift information for the dispatch applet

Parameters:

ui -

model -

project -

trimByProject -

Throws:

MXException

java.rmi.RemoteException

activitiesInitialized

boolean activitiesInitialized(MboRemote projectMbo)
                              throws MXException,
                                     java.rmi.RemoteException

Indicates if project is initialized or not

Parameters:

project -

Throws:

MXException

java.rmi.RemoteException

getCapacityPlanningGapModel

ilog.views.gantt.IlvGanttModel getCapacityPlanningGapModel(UserInfo userInfo,
                                                         SKDCapacityPlanningGapRequestParams params)
                                                           throws java.rmi.RemoteException,
                                                                  MXException

Fetches the Capacity Planning Gap Data from the SKDWORKPLANEXTCAP table and puts it into a Gantt Model

Parameters:

userInfo -

projectId -

Returns:

Throws:

java.rmi.RemoteException

MXException

PopulateSKDOrigiDestMatrix

boolean PopulateSKDOrigiDestMatrix(MboRemote projectMbo)
                                   throws MXException,
                                          java.rmi.RemoteException

populate skdorigindestmatrix for project - need call MAP api method

Parameters:

project -

Throws:

MXException

java.rmi.RemoteException

updateTravelTimeMatrixFor

int updateTravelTimeMatrixFor(java.lang.String orgId,
                            java.util.Map<java.lang.String,SKDMAPInputParamInfo> taskSACodeMap,
                            java.util.Map<java.lang.String,SKDMAPInputParamInfo> onTheFlyWOIDMap,
                            java.util.Map<java.lang.String,SKDMAPInputParamInfo> resourceStartSACodeMap,
                            java.util.Map<java.lang.String,SKDMAPInputParamInfo> resourceEndSACodeMap,
                            UserInfo userInfo)
                              throws java.lang.NullPointerException,
                                     java.net.MalformedURLException,
                                     java.io.IOException,
                                     MXException

API to update the SKDORIGINDESTMATRIX table with travel times retrieved from the map provider. The table is updated with all possible combinations of origins and destinations, but combinations where the origin is the same as the destination. Records for which an origin/destination pair already exists will not be updated, only new records can be added, and they are added if at least either the origin or the destination is new in the pair.

Parameters:

orgId -

taskSACodeMap - service address codes and lat/lng points for tasks (used as both origins and destinations)

onTheFlyWOIDMap - work order IDs and lat/lng points for "on the fly" work orders (used as both origins and destinations)

resourceStartSACodeMap - service address codes and lat/lng points of resource start locations (used as origins only)

resourceEndSACodeMap - service address codes and lat/lng points of resource end locations (used as destinations only)

userInfo -

Returns:

int 1 means that the table has been updated; 0 means that there was no need to update the table; -1 means map provider error; -2 means invalid inputs

Throws:

MXException

java.io.IOException

java.lang.NullPointerException

java.net.MalformedURLException

dynamicScheduling

int dynamicScheduling(long skdProjectId,
                    java.lang.String emWhere,
                    boolean autoassign)
                      throws MXException,
                             java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

See Also:

com.ibm.tivoli.maximo.skd.service.SKDAppService#dynamicScheduling()

assignLaborCrewFromSuggestSet

void assignLaborCrewFromSuggestSet(MboSetRemote emWOAvailResSet,
                                 UserInfo userInfo,
                                 java.util.Date currentTime)
                                   throws MXException,
                                          java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

See Also:

com.ibm.tivoli.maximo.skd.service.SKDAppService#assignLaborCrewFromSuggestSet()

getSKDViewerProperties

java.util.Properties getSKDViewerProperties()
                                            throws java.rmi.RemoteException

Return the user overriden properties from MAXPROPVALUE for SCHEDULER

Returns:

Throws:

java.rmi.RemoteException