com.ibm.tivoli.maximo.skd.service

Interface SKDAppServiceRemote

    • 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
      • refreshSelectedActivities

        java.util.List refreshSelectedActivities(IMXGanttModel model,
                                                 UserInfo userInfo,
                                                 MboRemote project,
                                                 java.util.List selectedActivities,
                                                 boolean preserveSkdData)
                                          throws MXException,
                                                 java.rmi.RemoteException
        Refresh selected project data with project Mbo
        Parameters:
        model -
        userInfo -
        project -
        selectedActivities -
        preserveSkdData -
        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,
                                        boolean commitConstraintsOnly)
                                 throws MXException,
                                        java.rmi.RemoteException
        Commit modified model changes to the database
        Parameters:
        userInfo -
        projectId -
        commitConstraintsOnly - - Flag used to indicate that the commit action will only persist constraint changes.
        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
      • commitModifiedModelChanges

        void commitModifiedModelChanges(UserInfo userInfo,
                                        java.lang.String projectId,
                                        java.lang.String ids,
                                        java.lang.String objectName,
                                        boolean commitConstraintsOnly)
                                 throws MXException,
                                        java.rmi.RemoteException
        Commit selected modified model changes to the database
        Parameters:
        userInfo -
        projectId -
        ids -
        objectName -
        commitConstraintsOnly - - Flag used to indicate that the commit action will only persist constraint changes.
        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
      • commitMaxSchedule

        void commitMaxSchedule(UserInfo userInfo,
                               java.lang.String projectid,
                               boolean commitConstraintsOnly)
                        throws MXException,
                               java.rmi.RemoteException
        Commit modified Max schedule model changes to the database
        Parameters:
        userInfo -
        projectId -
        Throws:
        MXException
        java.rmi.RemoteException
      • commitMaxSchedule

        void commitMaxSchedule(UserInfo userInfo,
                               java.lang.String projectid,
                               java.lang.String ids,
                               boolean commitConstraintsOnly)
                        throws MXException,
                               java.rmi.RemoteException
        Commit modified Max schedule 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
      • duplicateSKDAlternateAvail

        void duplicateSKDAlternateAvail(UserInfo userInfo,
                                        java.lang.String projectName,
                                        MboRemote duplicateProjectMbo)
                                 throws MXException,
                                        java.rmi.RemoteException
        Duplicates scheduler alternate availability info.
        Parameters:
        userInfo -
        projectName -
        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 taskSACodeMap,
                                      java.util.Map onTheFlyWOIDMap,
                                      java.util.Map resourceStartSACodeMap,
                                      java.util.Map resourceEndSACodeMap,
                                      UserInfo userInfo)
                               throws java.lang.NullPointerException,
                                      java.net.MalformedURLException,
                                      java.io.IOException,
                                      java.lang.Exception
        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
        java.lang.Exception
      • dynamicScheduling

        int dynamicScheduling(UserInfo userInfo,
                              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
      • getSKDDD

        SKDDD getSKDDD()
                throws MXException,
                       java.rmi.RemoteException
        Returns:
        SKDDD object
        Throws:
        MXException
        java.rmi.RemoteException
      • loadTemplate

        java.lang.String loadTemplate(java.lang.String templateName,
                                      MboRemote projectMbo,
                                      SKDTemplateResolver alternateResolver)
                               throws java.rmi.RemoteException,
                                      MXException
        Load a Scheduler Template (ie, text template data) for the given templateName
        Parameters:
        templateName - template name
        projectMbo - main scheduler project mbo
        alternateResolver - resolve to use when no template is found
        Returns:
        Throws:
        java.rmi.RemoteException
        MXException
      • refreshModel

        java.util.List refreshModel(UserInfo userInfo,
                                    MboRemote project,
                                    MXGanttModel model)
                             throws MXException,
                                    java.rmi.RemoteException
        Refresh the Maximo Gantt data model with new and/or updated data retrieved from the DB.
        Parameters:
        userInfo -
        project -
        model -
        Returns:
        Throws:
        MXException
        java.rmi.RemoteException
      • reloadWorkOrders

        java.util.Map reloadWorkOrders(java.lang.String projectID,
                                       UserInfo userInfo)
                                throws java.rmi.RemoteException,
                                       MXException
        Refresh Project Work Orders.
        Parameters:
        projectID -
        userInfo -
        Returns:
        Throws:
        java.rmi.RemoteException
        MXException
      • refreshActivity

        void refreshActivity(IMXActivity activity,
                             java.util.Map workOrdersByID)
                      throws java.rmi.RemoteException,
                             MXException
        Refresh Activity from the Model.
        Parameters:
        activity -
        workOrdersByID -
        Throws:
        java.rmi.RemoteException
        MXException
      • createNewAssignment

        void createNewAssignment(MboRemote assignment,
                                 MboRemote workOrder,
                                 MXGanttModel model,
                                 UserInfo userInfo)
                          throws java.rmi.RemoteException,
                                 MXException
        Creates a new SKDActivity and SKDReservation record for the Assignment.
        Parameters:
        assignment -
        workOrder -
        model -
        userInfo -
        Throws:
        java.rmi.RemoteException
        MXException
      • deleteAssignment

        void deleteAssignment(long objectID,
                              UserInfo userInfo)
                       throws java.rmi.RemoteException,
                              MXException
        Marks SKDActivity and SKDReservation records as DELETED for removed assignment.
        Parameters:
        objectID -
        projectID -
        userInfo -
        Throws:
        java.rmi.RemoteException
        MXException
      • updateAssignment

        void updateAssignment(MboRemote assignment,
                              UserInfo userInfo)
                       throws java.rmi.RemoteException,
                              MXException
        Updates SKDActivity and SKDReservation records.
        Parameters:
        objectID -
        projectID -
        userInfo -
        Throws:
        java.rmi.RemoteException
        MXException
      • deleteUncommitedDuplicateConstraints

        void deleteUncommitedDuplicateConstraints(long skdProjectID,
                                                  UserInfo userInfo)
                                           throws java.rmi.RemoteException,
                                                  MXException
        Removes constraints duplicate and uncommited constraints.
        Parameters:
        skdProjectID -
        userInfo -
        Throws:
        java.rmi.RemoteException
        MXException
      • removeCachedModels

        void removeCachedModels(UserInfo info)
                         throws java.rmi.RemoteException,
                                MXException
        Remove model from memory cache.
        Parameters:
        info -
        Throws:
        java.rmi.RemoteException
        MXException
      • getPopulateDataObjectsWhere

        java.lang.String getPopulateDataObjectsWhere(SKDProject projectMbo)
                                              throws java.rmi.RemoteException,
                                                     MXException
        Throws:
        java.rmi.RemoteException
        MXException
      • runOptimization

        boolean runOptimization(SKDProjectRemote skdProject)
                         throws MXException,
                                java.rmi.RemoteException
        Throws:
        MXException
        java.rmi.RemoteException
        See Also:
        throws MXException, RemoteException