Interface Alert

    • Method Detail

      • getStatus

        AlertStatus getStatus()
        Get the value for Status. (The status of this alert.) 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.
      • getSourceObject

        SchedulerEntity getSourceObject()
        Get the value for SourceObject. (Get the object that initiated this alert, or null if no source was specified, or the sender has been deleted)
        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.
      • getRaisedSequence

        Long getRaisedSequence()
        Get the value for RaisedSequence. (Sequence number for this alert, this is unique for each alert, regardless of 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.
      • getCreationTime

        DateTimeZone getCreationTime()
        Get the value for CreationTime. (Timestamp that notes when the Alert was raised.)
        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.
      • getLastModificationTime

        DateTimeZone getLastModificationTime()
        Get the value for LastModificationTime. (Timestamp that notes when the Alert was last modified.)
        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.
      • getDeprecated1

        Long getDeprecated1()
        Get the value for Deprecated1. (Deprecated Alert Escalation field as that is no longer mandatory but we can't change the field) 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.
      • getResendCount

        Long getResendCount()
        Get the value for ResendCount. (The number of times an alert can be restarted before it fails.) 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​(AlertStatus newStatus)
        Set the value for Status. (The status of this alert.) 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.
      • setDeprecated1

        void setDeprecated1​(Long newDeprecated1)
        Set the value for Deprecated1. (Deprecated Alert Escalation field as that is no longer mandatory but we can't change the field) This value is mandatory.
        Parameters:
        newDeprecated1 - the new value for Deprecated1. 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.
      • setResendCount

        void setResendCount​(Long newResendCount)
        Set the value for ResendCount. (The number of times an alert can be restarted before it fails.) This value is mandatory.
        Parameters:
        newResendCount - the new value for ResendCount. 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.
      • getAlertSource

        AlertSource getAlertSource()
        Get the AlertSource.
        Returns:
        AlertSource
        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.
      • getLastModifierSubject

        Subject getLastModifierSubject()
        Get the LastModifierSubject.
        Returns:
        LastModifierSubject
        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.
      • getSourceObjectDefinition

        ObjectDefinition getSourceObjectDefinition()
        Get the SourceObjectDefinition.
        Returns:
        SourceObjectDefinition
        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.
      • getOperatorMessage

        OperatorMessage getOperatorMessage()
        Get the OperatorMessage.
        Returns:
        OperatorMessage
        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.
      • getCauseAlert

        Alert getCauseAlert()
        Get the CauseAlert.
        Returns:
        CauseAlert
        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.
      • getAlertEscalation

        AlertEscalation getAlertEscalation()
        Get the AlertEscalation.
        Returns:
        AlertEscalation
        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.
      • setSourceObjectDefinition

        void setSourceObjectDefinition​(ObjectDefinition newSourceObjectDefinition)
        Set the value for SourceObjectDefinition. This value is optional.
        Parameters:
        newSourceObjectDefinition - is the object to set SourceObjectDefinition to. What type of object raised this alert?
      • setOperatorMessage

        void setOperatorMessage​(OperatorMessage newOperatorMessage)
        Set the value for OperatorMessage. This value is mandatory.
        Parameters:
        newOperatorMessage - is the object to set OperatorMessage to. What type of object raised this alert? If this is null, then the object cannot be persisted.
      • setCauseAlert

        void setCauseAlert​(Alert newCauseAlert)
        Set the value for CauseAlert. This value is optional.
        Parameters:
        newCauseAlert - is the object to set CauseAlert to. The alert that caused this alert.
      • setAlertEscalation

        void setAlertEscalation​(AlertEscalation newAlertEscalation)
        Set the value for AlertEscalation. This value is optional.
        Parameters:
        newAlertEscalation - is the object to set AlertEscalation to. The escalation channel this alert was sent on.