Interface PeopleSoftJobControlRule

    • Method Detail

      • getAction

        SynchronizeAction getAction()
        Get the value for Action. (Action to take with PeopleSoft jobs that match this rule.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • getDescription

        String getDescription()
        Get the value for Description. (The description of this step)
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • getJobnameMask

        String getJobnameMask()
        Get the value for JobnameMask. (PeopleSoft job name mask.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • isJobnameMaskCaseSensitive

        boolean isJobnameMaskCaseSensitive()
        Get the value for JobnameMaskCaseSensitive. (Is the JobnameMask case sensitive, or should it match regardless of the case?)
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • getProcessingOrder

        Long getProcessingOrder()
        Get the value for ProcessingOrder. (In which order are the JobControlRules applied?) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • getUsernameMask

        String getUsernameMask()
        Get the value for UsernameMask. (PeopleSoft username mask.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • getPriority

        Long getPriority()
        Get the value for Priority. (Priority to assign the job in Crimson.)
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • isRetrieveJoblog

        boolean isRetrieveJoblog()
        Get the value for RetrieveJoblog. (Retrieve joblog of the PeopleSoft job.)
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • isRetrieveOutput

        boolean isRetrieveOutput()
        Get the value for RetrieveOutput. (Retrieve output lists of the PeopleSoft job.)
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • isEnabled

        boolean isEnabled()
        Get the value for Enabled. (Whether this rule is currently enabled or not.)
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • setAction

        void setAction​(SynchronizeAction newAction)
        Set the value for Action. (Action to take with PeopleSoft jobs that match this rule.) This value is mandatory.
        Parameters:
        newAction - the new value for Action. If this is null, then the object cannot be persisted.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • setDescription

        void setDescription​(String newDescription)
        Set the value for Description. (The description of this step) This value is optional.
        Parameters:
        newDescription - the new value for Description.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • setJobnameMask

        void setJobnameMask​(String newJobnameMask)
        Set the value for JobnameMask. (PeopleSoft job name mask.) This value is mandatory.
        Parameters:
        newJobnameMask - the new value for JobnameMask. If this is null, then the object cannot be persisted.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • setJobnameMaskCaseSensitive

        void setJobnameMaskCaseSensitive​(boolean newJobnameMaskCaseSensitive)
        Set the value for JobnameMaskCaseSensitive. (Is the JobnameMask case sensitive, or should it match regardless of the case?)
        Parameters:
        newJobnameMaskCaseSensitive - the new value for JobnameMaskCaseSensitive.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • setProcessingOrder

        void setProcessingOrder​(Long newProcessingOrder)
        Set the value for ProcessingOrder. (In which order are the JobControlRules applied?) This value is mandatory.
        Parameters:
        newProcessingOrder - the new value for ProcessingOrder. If this is null, then the object cannot be persisted.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • setUsernameMask

        void setUsernameMask​(String newUsernameMask)
        Set the value for UsernameMask. (PeopleSoft username mask.) This value is mandatory.
        Parameters:
        newUsernameMask - the new value for UsernameMask. If this is null, then the object cannot be persisted.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • setPriority

        void setPriority​(Long newPriority)
        Set the value for Priority. (Priority to assign the job in Crimson.) This value is optional.
        Parameters:
        newPriority - the new value for Priority.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • setRetrieveJoblog

        void setRetrieveJoblog​(boolean newRetrieveJoblog)
        Set the value for RetrieveJoblog. (Retrieve joblog of the PeopleSoft job.)
        Parameters:
        newRetrieveJoblog - the new value for RetrieveJoblog.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • setRetrieveOutput

        void setRetrieveOutput​(boolean newRetrieveOutput)
        Set the value for RetrieveOutput. (Retrieve output lists of the PeopleSoft job.)
        Parameters:
        newRetrieveOutput - the new value for RetrieveOutput.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • setEnabled

        void setEnabled​(boolean newEnabled)
        Set the value for Enabled. (Whether this rule is currently enabled or not.)
        Parameters:
        newEnabled - the new value for Enabled.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • getPeopleSoftSystem

        PeopleSoftSystem getPeopleSoftSystem()
        Get the PeopleSoftSystem.
        Returns:
        PeopleSoftSystem
        Throws:
        com.redwood.scheduler.api.exception.ObjectDeletedException - If this method is called when the object has been marked for deletion.
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - If this method is called when the object has been removed from it's session.
      • getDefaultQueue

        Queue getDefaultQueue()
        Get the DefaultQueue.
        Returns:
        DefaultQueue
        Throws:
        com.redwood.scheduler.api.exception.ObjectDeletedException - If this method is called when the object has been marked for deletion.
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - If this method is called when the object has been removed from it's session.
      • setDefaultQueue

        void setDefaultQueue​(Queue newDefaultQueue)
        Set the value for DefaultQueue. This value is optional.
        Parameters:
        newDefaultQueue - is the object to set DefaultQueue to. Which queue that jobs should be placed on.