Interface QueueAlertSourceStatus

    • Method Detail

      • getStatus

        QueueStatus 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 queue. 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.
      • setStatus

        void setStatus​(QueueStatus 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 queue. 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.
      • getQueueAlertSource

        QueueAlertSource getQueueAlertSource()
        Get the QueueAlertSource.
        Returns:
        QueueAlertSource
        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.