Package com.redwood.scheduler.api.model

Interface JobDefinitionAlertSource

    • Method Detail

      • getNamePattern

        String getNamePattern()
        Get the value for NamePattern. (The Pattern of job definition names to match ) 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.

      • getNameMatchType

        NameMatchType getNameMatchType()
        Get the value for NameMatchType. (The type of pattern match for the Name of the Alert source.) 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.

      • getPartitionPattern

        String getPartitionPattern()
        Get the value for PartitionPattern. (The Pattern of partition name to match)
        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.

      • getPartitionMatchType

        NameMatchType getPartitionMatchType()
        Get the value for PartitionMatchType. (The type of pattern match for the partition name) 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.

      • getAlertAtRestart

        Long getAlertAtRestart()
        Get the value for AlertAtRestart. ( This field allows to change the behavior of alerts raised for restarted jobs. This field can be specified such that 0 or null means to alert on all runs (default), and 1...n is for start 1 through to n, and -1...-n means to alert on the last, second last back to nth last. An example: JobDefinition with restart count of 4. This field is set to -1, then only on the last restart the alert is raised. If this field was 2, it would raise an alert on the first and second restart but not the last 2. )
        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.

      • getAlertBehavior

        AlertingBehavior getAlertBehavior()
        Get the value for AlertBehavior. (Alerting behavior for Job Definition Alert Source.) 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.

      • setNamePattern

        void setNamePattern​(String newNamePattern)
        Set the value for NamePattern. (The Pattern of job definition names to match ) This value is mandatory.
        Parameters:
        newNamePattern - the new value for NamePattern. 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.

      • setNameMatchType

        void setNameMatchType​(NameMatchType newNameMatchType)
        Set the value for NameMatchType. (The type of pattern match for the Name of the Alert source.) This value is mandatory.
        Parameters:
        newNameMatchType - the new value for NameMatchType. 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.

      • setPartitionPattern

        void setPartitionPattern​(String newPartitionPattern)
        Set the value for PartitionPattern. (The Pattern of partition name to match) This value is optional.
        Parameters:
        newPartitionPattern - the new value for PartitionPattern.
        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.

      • setPartitionMatchType

        void setPartitionMatchType​(NameMatchType newPartitionMatchType)
        Set the value for PartitionMatchType. (The type of pattern match for the partition name) This value is mandatory.
        Parameters:
        newPartitionMatchType - the new value for PartitionMatchType. 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.

      • setAlertAtRestart

        void setAlertAtRestart​(Long newAlertAtRestart)
        Set the value for AlertAtRestart. ( This field allows to change the behavior of alerts raised for restarted jobs. This field can be specified such that 0 or null means to alert on all runs (default), and 1...n is for start 1 through to n, and -1...-n means to alert on the last, second last back to nth last. An example: JobDefinition with restart count of 4. This field is set to -1, then only on the last restart the alert is raised. If this field was 2, it would raise an alert on the first and second restart but not the last 2. ) This value is optional.
        Parameters:
        newAlertAtRestart - the new value for AlertAtRestart.
        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.

      • setAlertBehavior

        void setAlertBehavior​(AlertingBehavior newAlertBehavior)
        Set the value for AlertBehavior. (Alerting behavior for Job Definition Alert Source.) This value is mandatory.
        Parameters:
        newAlertBehavior - the new value for AlertBehavior. 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.

      • getJobDefinitionAlertSourceParameterMatchBySearchName

        JobDefinitionAlertSourceParameterMatch getJobDefinitionAlertSourceParameterMatchBySearchName​(String searchName)
        Get the JobDefinitionAlertSourceParameterMatch by SearchName.
        Parameters:
        searchName -
        Returns:
        the JobDefinitionAlertSourceParameterMatch, or null if it could not be found

      • getJobDefinitionAlertSourceRuleByProcessingOrder

        JobDefinitionAlertSourceRule getJobDefinitionAlertSourceRuleByProcessingOrder​(Long processingOrder)
        Get the JobDefinitionAlertSourceRule by ProcessingOrder.
        Parameters:
        processingOrder -
        Returns:
        the JobDefinitionAlertSourceRule, or null if it could not be found

      • getJobDefinitionAlertSourceStatusByStatus

        JobDefinitionAlertSourceStatus getJobDefinitionAlertSourceStatusByStatus​(JobStatus status)
        Get the JobDefinitionAlertSourceStatus by JobDefinitionAlertSourceStatus.
        Parameters:
        status -
        Returns:
        the JobDefinitionAlertSourceStatus, or null if it could not be found

      • checkCreatePrivilege

        RequiredPermission checkCreatePrivilege()
        Check whether or not the create action can be performed on this object.
        Returns:
        a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.

      • checkViewPrivilege

        RequiredPermission checkViewPrivilege()
        Check whether or not the view action can be performed on this object.
        Returns:
        a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.

      • checkEditPrivilege

        RequiredPermission checkEditPrivilege()
        Check whether or not the edit action can be performed on this object.
        Returns:
        a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.

      • checkDeletePrivilege

        RequiredPermission checkDeletePrivilege()
        Check whether or not the delete action can be performed on this object.
        Returns:
        a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.