Interface UserMessageDefinitionResponse

    • Method Detail

      • getStatus

        JobStatus getStatus()
        Get the value for Status. (The JobStatus to set on choosing the action (default Completed).) 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.
      • getGoToStep

        String getGoToStep()
        Get the value for GoToStep. (The optional step to goto on completion)
        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.
      • getReturnCode

        Long getReturnCode()
        Get the value for ReturnCode. (The return code to set on the job if this action is selected (default 0)) 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.
      • isReplyRequired

        boolean isReplyRequired()
        Get the value for ReplyRequired. (Is getReplyComment() required to be non-null when this response is chosen on an UserMessage.)
        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 JobStatus to set on choosing the action (default Completed).) 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.
      • setGoToStep

        void setGoToStep​(String newGoToStep)
        Set the value for GoToStep. (The optional step to goto on completion) This value is optional.
        Parameters:
        newGoToStep - the new value for GoToStep.
        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.
      • setReturnCode

        void setReturnCode​(Long newReturnCode)
        Set the value for ReturnCode. (The return code to set on the job if this action is selected (default 0)) This value is mandatory.
        Parameters:
        newReturnCode - the new value for ReturnCode. 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.
      • setReplyRequired

        void setReplyRequired​(boolean newReplyRequired)
        Set the value for ReplyRequired. (Is getReplyComment() required to be non-null when this response is chosen on an UserMessage.)
        Parameters:
        newReplyRequired - the new value for ReplyRequired.
        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.
      • getUserMessageDefinition

        UserMessageDefinition getUserMessageDefinition()
        Get the UserMessageDefinition.
        Returns:
        UserMessageDefinition
        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.