Package com.redwood.scheduler.api.model

Interface SAPXBPJobControlRule

    • Method Detail

      • getAction

        InterceptAction getAction()
        Get the value for Action. (Action to take with SAP 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.

      • getClientNumberMask

        String getClientNumberMask()
        Get the value for ClientNumberMask. (Client number 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.

      • 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. (SAP 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 SAPXBPJobControlRules 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. (SAP 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 SAP 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.

      • isRetrieveSpool

        boolean isRetrieveSpool()
        Get the value for RetrieveSpool. (Retrieve spool lists of the SAP 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.

      • isRetrieveApplLog

        boolean isRetrieveApplLog()
        Get the value for RetrieveApplLog. (Retrieve application log of the SAP 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.

      • isIgnoreApplReturnCode

        boolean isIgnoreApplReturnCode()
        Get the value for IgnoreApplReturnCode. (Ignore application return code of the SAP 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.

      • getJobClass

        String getJobClass()
        Get the value for JobClass. (This rule applies to jobs of which class.) 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.

      • isSelectScheduled

        boolean isSelectScheduled()
        Get the value for SelectScheduled. (Whether this rule applies to jobs in SAP status Scheduled.)
        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.

      • isSelectReleased

        boolean isSelectReleased()
        Get the value for SelectReleased. (Whether this rule applies to jobs in SAP status Released.)
        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.

      • isSelectReady

        boolean isSelectReady()
        Get the value for SelectReady. (Whether this rule applies to jobs in SAP status Ready.)
        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.

      • isSelectActive

        boolean isSelectActive()
        Get the value for SelectActive. (Whether this rule applies to jobs in SAP status Active.)
        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.

      • isSelectFinished

        boolean isSelectFinished()
        Get the value for SelectFinished. (Whether this rule applies to jobs in SAP status Finished.)
        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.

      • isSelectCanceled

        boolean isSelectCanceled()
        Get the value for SelectCanceled. (Whether this rule applies to jobs in SAP status Canceled.)
        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​(InterceptAction newAction)
        Set the value for Action. (Action to take with SAP 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.

      • setClientNumberMask

        void setClientNumberMask​(String newClientNumberMask)
        Set the value for ClientNumberMask. (Client number mask.) This value is mandatory.
        Parameters:
        newClientNumberMask - the new value for ClientNumberMask. 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. (SAP 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 SAPXBPJobControlRules 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. (SAP 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 SAP 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.

      • setRetrieveSpool

        void setRetrieveSpool​(boolean newRetrieveSpool)
        Set the value for RetrieveSpool. (Retrieve spool lists of the SAP job.)
        Parameters:
        newRetrieveSpool - the new value for RetrieveSpool.
        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.

      • setRetrieveApplLog

        void setRetrieveApplLog​(boolean newRetrieveApplLog)
        Set the value for RetrieveApplLog. (Retrieve application log of the SAP job.)
        Parameters:
        newRetrieveApplLog - the new value for RetrieveApplLog.
        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.

      • setIgnoreApplReturnCode

        void setIgnoreApplReturnCode​(boolean newIgnoreApplReturnCode)
        Set the value for IgnoreApplReturnCode. (Ignore application return code of the SAP job.)
        Parameters:
        newIgnoreApplReturnCode - the new value for IgnoreApplReturnCode.
        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.

      • setJobClass

        void setJobClass​(String newJobClass)
        Set the value for JobClass. (This rule applies to jobs of which class.) This value is mandatory.
        Parameters:
        newJobClass - the new value for JobClass. 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.

      • setSelectScheduled

        void setSelectScheduled​(boolean newSelectScheduled)
        Set the value for SelectScheduled. (Whether this rule applies to jobs in SAP status Scheduled.)
        Parameters:
        newSelectScheduled - the new value for SelectScheduled.
        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.

      • setSelectReleased

        void setSelectReleased​(boolean newSelectReleased)
        Set the value for SelectReleased. (Whether this rule applies to jobs in SAP status Released.)
        Parameters:
        newSelectReleased - the new value for SelectReleased.
        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.

      • setSelectReady

        void setSelectReady​(boolean newSelectReady)
        Set the value for SelectReady. (Whether this rule applies to jobs in SAP status Ready.)
        Parameters:
        newSelectReady - the new value for SelectReady.
        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.

      • setSelectActive

        void setSelectActive​(boolean newSelectActive)
        Set the value for SelectActive. (Whether this rule applies to jobs in SAP status Active.)
        Parameters:
        newSelectActive - the new value for SelectActive.
        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.

      • setSelectFinished

        void setSelectFinished​(boolean newSelectFinished)
        Set the value for SelectFinished. (Whether this rule applies to jobs in SAP status Finished.)
        Parameters:
        newSelectFinished - the new value for SelectFinished.
        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.

      • setSelectCanceled

        void setSelectCanceled​(boolean newSelectCanceled)
        Set the value for SelectCanceled. (Whether this rule applies to jobs in SAP status Canceled.)
        Parameters:
        newSelectCanceled - the new value for SelectCanceled.
        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.

      • getDefaultSAPApplicationServer

        SAPApplicationServer getDefaultSAPApplicationServer()
        Get the DefaultSAPApplicationServer.
        Returns:
        DefaultSAPApplicationServer
        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.

      • getDefaultSAPApplicationServerGroup

        SAPApplicationServerGroup getDefaultSAPApplicationServerGroup()
        Get the DefaultSAPApplicationServerGroup.
        Returns:
        DefaultSAPApplicationServerGroup
        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.

      • getSAPSystem

        SAPSystem getSAPSystem()
        Get the SAPSystem.
        Returns:
        SAPSystem
        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.

      • getCcmsJobDefinition

        JobDefinition getCcmsJobDefinition()
        Get the CcmsJobDefinition.
        Returns:
        CcmsJobDefinition
        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.

      • setDefaultSAPApplicationServer

        void setDefaultSAPApplicationServer​(SAPApplicationServer newDefaultSAPApplicationServer)
        Set the value for DefaultSAPApplicationServer. This value is optional.
        Parameters:
        newDefaultSAPApplicationServer - is the object to set DefaultSAPApplicationServer to. Which target server that jobs should be placed on.

      • setDefaultSAPApplicationServerGroup

        void setDefaultSAPApplicationServerGroup​(SAPApplicationServerGroup newDefaultSAPApplicationServerGroup)
        Set the value for DefaultSAPApplicationServerGroup. This value is optional.
        Parameters:
        newDefaultSAPApplicationServerGroup - is the object to set DefaultSAPApplicationServerGroup to. Which target server group that jobs should be placed on.

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

      • setCcmsJobDefinition

        void setCcmsJobDefinition​(JobDefinition newCcmsJobDefinition)
        Set the value for CcmsJobDefinition. This value is optional.
        Parameters:
        newCcmsJobDefinition - is the object to set CcmsJobDefinition to. Assign a different Ccms Job definition to process control rule