Interface JobDefinitionAlertSourceStatus

    • Method Detail

      • getStatus

        JobStatus getStatus()
        Get the value for Status. (The status 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.
      • getOperatorMessageExpression

        String getOperatorMessageExpression()
        Get the value for OperatorMessageExpression. (Override the operator message expression for the job definition. The operator message expression. If this is set, then the expression is evaluated, and the result is used as the operator message. If not set, a source specific default is used.)
        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.
      • getDelayAmount

        Long getDelayAmount()
        Get the value for DelayAmount. (Amount of time (in time units) that the job must be in this status before the alert is raised.) 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.
      • getDelayUnits

        TimeUnit getDelayUnits()
        Get the value for DelayUnits. (Time units for the amount of time that the job must be in this status before the alert is raised.) 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.
      • setStatus

        void setStatus​(JobStatus newStatus)
        Set the value for Status. (The status to match ) This value is mandatory.
        Parameters:
        newStatus - the new value for Status. 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.
      • setOperatorMessageExpression

        void setOperatorMessageExpression​(String newOperatorMessageExpression)
        Set the value for OperatorMessageExpression. (Override the operator message expression for the job definition. The operator message expression. If this is set, then the expression is evaluated, and the result is used as the operator message. If not set, a source specific default is used.) This value is optional.
        Parameters:
        newOperatorMessageExpression - the new value for OperatorMessageExpression.
        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.
      • setDelayAmount

        void setDelayAmount​(Long newDelayAmount)
        Set the value for DelayAmount. (Amount of time (in time units) that the job must be in this status before the alert is raised.) This value is mandatory.
        Parameters:
        newDelayAmount - the new value for DelayAmount. 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.
      • setDelayUnits

        void setDelayUnits​(TimeUnit newDelayUnits)
        Set the value for DelayUnits. (Time units for the amount of time that the job must be in this status before the alert is raised.) This value is mandatory.
        Parameters:
        newDelayUnits - the new value for DelayUnits. 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.
      • getJobDefinitionAlertSource

        JobDefinitionAlertSource getJobDefinitionAlertSource()
        Get the JobDefinitionAlertSource.
        Returns:
        JobDefinitionAlertSource
        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.