Interface FinalStatusHandler

    • Method Detail

      • getStatus

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

        FinalStatusAction getAction()
        Get the value for Action. (What to do on this final state) 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.
      • getMessageText

        String getMessageText()
        Get the value for MessageText. (an operator message to send when this status is reached)
        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.
      • getRestartDelayAmount

        Long getRestartDelayAmount()
        Get the value for RestartDelayAmount. (number of 'restart delay time units' after the finish time of the original job to submit the restart at) 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.
      • getRestartDelayUnits

        TimeUnit getRestartDelayUnits()
        Get the value for RestartDelayUnits. (time units for 'restart delay amount' - seconds, minutes, hours, days. May not be null, defaults to minutes) 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. () 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.
      • setAction

        void setAction​(FinalStatusAction newAction)
        Set the value for Action. (What to do on this final state) This value is mandatory.
        Parameters:
        newAction - the new value for Action. 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.
      • setMessageText

        void setMessageText​(String newMessageText)
        Set the value for MessageText. (an operator message to send when this status is reached) This value is optional.
        Parameters:
        newMessageText - the new value for MessageText.
        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.
      • setRestartDelayAmount

        void setRestartDelayAmount​(Long newRestartDelayAmount)
        Set the value for RestartDelayAmount. (number of 'restart delay time units' after the finish time of the original job to submit the restart at) This value is mandatory.
        Parameters:
        newRestartDelayAmount - the new value for RestartDelayAmount. 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.
      • setRestartDelayUnits

        void setRestartDelayUnits​(TimeUnit newRestartDelayUnits)
        Set the value for RestartDelayUnits. (time units for 'restart delay amount' - seconds, minutes, hours, days. May not be null, defaults to minutes) This value is mandatory.
        Parameters:
        newRestartDelayUnits - the new value for RestartDelayUnits. 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.
      • getJobDefinition

        JobDefinition getJobDefinition()
        Get the JobDefinition.
        Returns:
        JobDefinition
        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.