Package com.redwood.scheduler.api.model

Interface OperatorMessage

    • Method Detail

      • getFullText

        String getFullText()
        Get the value for FullText. (The full text of the operator message.) 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.

      • getTitleText

        String getTitleText()
        Get the value for TitleText. (The first line of the translated operator message, or the entire message if it cannot be translated.) 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.

      • getNumAdditionalLines

        Long getNumAdditionalLines()
        Get the value for NumAdditionalLines. (The number of additional lines to this message.) 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.

      • getReplyExpression

        String getReplyExpression()
        Get the value for ReplyExpression. (A regular expression to which the reply should match, or null of no reply is expected)
        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.

      • getReply

        String getReply()
        Get the value for Reply. (The reply to the operator message)
        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.

      • getReplyStatus

        ReplyStatus getReplyStatus()
        Get the value for ReplyStatus. (Query the status of this operator message with respect to a reply.) 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.

      • getReplyTime

        DateTimeZone getReplyTime()
        Get the value for ReplyTime. (When was this message replied to?)
        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.

      • getSenderObject

        SchedulerEntity getSenderObject()
        Get the value for SenderObject. (Get the SchedulerEntity that sent this operator message, or null if no sender 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.

      • getSenderObjectDescription

        String getSenderObjectDescription()
        Get the value for SenderObjectDescription. (Text representation of the SenderObject that sent this operator message)
        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.

      • setFullText

        void setFullText​(String newFullText)
        Set the value for FullText. (The full text of the operator message.) This value is mandatory.
        Parameters:
        newFullText - the new value for FullText. 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.

      • setReplyExpression

        void setReplyExpression​(String newReplyExpression)
        Set the value for ReplyExpression. (A regular expression to which the reply should match, or null of no reply is expected) This value is optional.
        Parameters:
        newReplyExpression - the new value for ReplyExpression.
        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.

      • setReply

        void setReply​(String newReply)
        Set the value for Reply. (The reply to the operator message) This value is optional.
        Parameters:
        newReply - the new value for Reply.
        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.

      • setSenderObject

        void setSenderObject​(SchedulerEntity newSenderObject)
        Set the value for SenderObject. (Get the SchedulerEntity that sent this operator message, or null if no sender was specified, or the sender has been deleted) This value is optional.
        Parameters:
        newSenderObject - the new value for SenderObject.
        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.

      • getMapOfReplies

        Map<String,​String> getMapOfReplies()
        Get a map of possible values that are applicable for this message. If a list cannot be generated from the regular expression, it returns null. The key in the map is the value that must be set as the reply, the value is the string to be displayed to the user (which is already translated if it can be translated)
        Returns:
        The map with the possible values, null if a map could not be generated.

      • getIsolationGroup

        IsolationGroup getIsolationGroup()
        Get the IsolationGroup.
        Returns:
        IsolationGroup
        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.

      • getSenderObjectDefinition

        ObjectDefinition getSenderObjectDefinition()
        Get the SenderObjectDefinition.
        Returns:
        SenderObjectDefinition
        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.

      • getPartition

        Partition getPartition()
        Get the Partition.
        Returns:
        Partition
        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.

      • getRepliedBySubject

        Subject getRepliedBySubject()
        Get the RepliedBySubject.
        Returns:
        RepliedBySubject
        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.

      • setIsolationGroup

        void setIsolationGroup​(IsolationGroup newIsolationGroup)
        Set the value for IsolationGroup. This value is mandatory.
        Parameters:
        newIsolationGroup - is the object to set IsolationGroup to. To which isolation group does this message effectively belong. If this is null, then the object cannot be persisted.

      • setSenderObjectDefinition

        void setSenderObjectDefinition​(ObjectDefinition newSenderObjectDefinition)
        Set the value for SenderObjectDefinition. This value is optional.
        Parameters:
        newSenderObjectDefinition - is the object to set SenderObjectDefinition to. What type of object raised this operator message?

      • setPartition

        void setPartition​(Partition newPartition)
        Set the value for Partition. This value is optional.
        Parameters:
        newPartition - is the object to set Partition to. To which isolation group does this message effectively belong.

      • getAlerts

        RWIterable<Alert> getAlerts()
        Get an RWIterable over an ordered collection of Alerts. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. What type of object raised this alert?
        Specified by:
        getAlerts in interface OperatorMessageComp
        Returns:
        An RWIterable over an ordered collection of Alert objects .

      • getOperatorMessageDatumByName

        OperatorMessageDatum getOperatorMessageDatumByName​(String name)
        Get the OperatorMessageDatum by OperatorMessageName.
        Parameters:
        name -
        Returns:
        the OperatorMessageDatum, or null if it could not be found

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

      • checkReplyPrivilege

        RequiredPermission checkReplyPrivilege()
        Check whether or not the reply 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.