psdi.app.jobplan

Class JobPlanSet

    • Constructor Detail

      • JobPlanSet

        public JobPlanSet(MboServerInterface ms)
                   throws MXException,
                          java.rmi.RemoteException
        Construct the set
        Parameters:
        ms - The Mbo Server interface
        Throws:
        MXException
        java.rmi.RemoteException
    • Method Detail

      • getMboInstance

        protected Mbo getMboInstance(MboSet ms)
                              throws MXException,
                                     java.rmi.RemoteException
        Generate a new Job Plan object
        Specified by:
        getMboInstance in class MboSet
        Parameters:
        ms - MboSet
        Returns:
        the new Job Plan object
        Throws:
        MXException
        java.rmi.RemoteException
      • getJpAsset

        public java.lang.String getJpAsset()
                                    throws MXException,
                                           java.rmi.RemoteException
        Gets the asset setting for WorkAsset of Jobpaln which was set by the user.
        Specified by:
        getJpAsset in interface JobPlanSetRemote
        Returns:
        The userpref setting for the WorkAsset
        Throws:
        MXException
        java.rmi.RemoteException
        See Also:
        JobPlanSet.getJpAsset()
      • getJpItem

        public java.lang.String getJpItem()
                                   throws MXException,
                                          java.rmi.RemoteException
        Gets the item setting for WorkAsset of Jobpaln which was set by the user.
        Specified by:
        getJpItem in interface JobPlanSetRemote
        Returns:
        The userpref setting for the WorkAsset
        Throws:
        MXException
        java.rmi.RemoteException
        See Also:
        JobPlanSet.getJpItem()
      • getJpItemSetID

        public java.lang.String getJpItemSetID()
                                        throws MXException,
                                               java.rmi.RemoteException
        Gets the item set setting for WorkAsset of Jobpaln which was set by the user.
        Returns:
        The userpref setting for the WorkAsset
        Throws:
        MXException
        java.rmi.RemoteException
      • getUserPrefWhere

        public java.lang.String getUserPrefWhere()
        Overrides the MboSet getUserPrefWhere() to return a userpref where clause which is appended to th existing whereClause. This is called by the framework to allow any app specific modifications to the whereClause.
        Overrides:
        getUserPrefWhere in class MboSet
        Returns:
        The userpref where clause.
      • getValidJobPlansForOrgAndSite

        public void getValidJobPlansForOrgAndSite(java.lang.String orgid,
                                                  java.lang.String siteid)
                                           throws MXException,
                                                  java.rmi.RemoteException
        Resets this set to include all the valid ACTIVE job plans for a given organization & site combination.
        When no orgid and no siteid are specified - valid jobplans are:
        all jobplans
        When an orgid is specified and no siteid is specified - valid jobplans are:
        any job plan with the specified orgid or a null orgid
        When an orgid and a siteid is specified - valid jobplans are:
        any job plan with the specified orgid and the specified siteid,
        any job plan with the specified orgid and a null siteid,
        any job plan with a null orgid and a null siteid
        Specified by:
        getValidJobPlansForOrgAndSite in interface JobPlanSetRemote
        Parameters:
        orgid - - organization id
        siteid - - site id
        Throws:
        MXException
        java.rmi.RemoteException
        See Also:
        JobPlanSet.getValidJobPlansForOrgAndSite(java.lang.String, java.lang.String)
      • getValidJobPlansForTaskGivenOrgAndSite

        public void getValidJobPlansForTaskGivenOrgAndSite(java.lang.String orgid,
                                                           java.lang.String siteid,
                                                           java.lang.String status,
                                                           java.lang.Integer jobplanid)
                                                    throws MXException,
                                                           java.rmi.RemoteException
        This is the getValidJobPlansForTaskGivenOrgAndSite method with its original signature, in which jobplanID was declared as an Integer. In fact, it should be a Long. This method is exist simply to prevent the change in the signature of the real method from breaking existing calls. In this method, the integer jobplanid is cast as a long and then the original method is called.
        Specified by:
        getValidJobPlansForTaskGivenOrgAndSite in interface JobPlanSetRemote
        Parameters:
        orgid - - organization id
        siteid - - site id
        status - - Owning Jobplan status
        jobplanid - - Owning Jobplan's unique id
        Throws:
        MXException
        java.rmi.RemoteException
        See Also:
        JobPlanSet.getValidJobPlansForTaskGivenOrgAndSite(java.lang.String, java.lang.String, java.lang.String, java.lang.Integer)
      • getValidJobPlansForTaskGivenOrgAndSite

        public void getValidJobPlansForTaskGivenOrgAndSite(java.lang.String orgid,
                                                           java.lang.String siteid,
                                                           java.lang.String status,
                                                           java.lang.Long jobplanid)
                                                    throws MXException,
                                                           java.rmi.RemoteException
        Resets this set to include all the valid ACTIVE job plans for a given organization & site combination if the owning jobplan status is ACTIVE.
        Resets this set to include all the valid ACTIVE and DRAFT job plans for a given organization & site combination if the owning jobplan status is DRAFT.
        Resets this set to include all the valid job plans for a given organization & site combination if the owning jobplan status is INACTIVE.
        When no orgid and no siteid are specified - valid jobplans are:
        all jobplans
        When an orgid is specified and no siteid is specified - valid jobplans are:
        any job plan with the specified orgid or a null orgid
        When an orgid and a siteid is specified - valid jobplans are:
        any job plan with the specified orgid and the specified siteid,
        any job plan with the specified orgid and a null siteid,
        any job plan with a null orgid and a null siteid
        Specified by:
        getValidJobPlansForTaskGivenOrgAndSite in interface JobPlanSetRemote
        Parameters:
        orgid - - organization id
        siteid - - site id
        status - - Owning Jobplan status
        jobplanid - - Owning Jobplan's unique id
        Throws:
        MXException
        java.rmi.RemoteException
        See Also:
        JobPlanSet.getValidJobPlansForTaskGivenOrgAndSite(java.lang.String, java.lang.String, java.lang.String, java.lang.Integer)
      • getMultiSiteJobPlan

        public void getMultiSiteJobPlan(java.lang.String jpnum,
                                        java.lang.String revisionNum,
                                        java.lang.String orgid,
                                        java.lang.String siteid)
                                 throws MXException,
                                        java.rmi.RemoteException
        Resets this set to include the job plan for a given job plan number,revision, organization & site key combination.
        Use this method to get the jobplan for a specific job plan number,revision, organization & site key combination.
        Specified by:
        getMultiSiteJobPlan in interface JobPlanSetRemote
        Parameters:
        jpnum - - name of the jobplan.
        revisionNum - - revision number
        orgid - - organization id
        siteid - - site id
        Throws:
        MXException
        java.rmi.RemoteException
        See Also:
        JobPlanSet.getMultiSiteJobPlan(java.lang.String, java.lang.String, java.lang.String)