Interface JobChainStep

    • Method Detail

      • getRestartCount

        Long getRestartCount()
        Get the value for RestartCount. (Maximum number of automatic restarts)
        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 step 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.
      • getSequenceNumber

        Long getSequenceNumber()
        Get the value for SequenceNumber. (The step sequence number) 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.
      • setRestartCount

        void setRestartCount​(Long newRestartCount)
        Set the value for RestartCount. (Maximum number of automatic restarts) This value is optional.
        Parameters:
        newRestartCount - the new value for RestartCount.
        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 step 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.
      • setSequenceNumber

        void setSequenceNumber​(Long newSequenceNumber)
        Set the value for SequenceNumber. (The step sequence number) This value is mandatory.
        Parameters:
        newSequenceNumber - the new value for SequenceNumber. 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.
      • getJobChain

        JobChain getJobChain()
        Get the JobChain.
        Returns:
        JobChain
        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.
      • getJobChainCalls

        RWIterable<JobChainCall> getJobChainCalls()
        Get an RWIterable over a collection of JobChainCalls, the collection will be ordered by SequenceNumber. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. The calls performed in parallel in a job chain step
        Specified by:
        getJobChainCalls in interface JobChainStepComp
        Returns:
        An RWIterable over a collection of JobChainCall objects , the collection will be ordered by SequenceNumber.
      • getJobChainCallBySequenceNumber

        JobChainCall getJobChainCallBySequenceNumber​(Long sequenceNumber)
        Get the JobChainCall by SequenceNumber.
        Parameters:
        sequenceNumber -
        Returns:
        the JobChainCall, or null if it could not be found
      • getJobChainStepPrecondition

        JobChainStepPrecondition getJobChainStepPrecondition()
        Get the JobChainStepPrecondition. Condition that defines whether the step should be executed or skipped.
        Returns:
        nullJobChainStepPrecondition
        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.
      • getJobChainStepStatusHandlerByStatus

        JobChainStepStatusHandler getJobChainStepStatusHandlerByStatus​(JobStatus status)
        Get the JobChainStepStatusHandler by JobChainStepStatusHandler.
        Parameters:
        status -
        Returns:
        the JobChainStepStatusHandler, or null if it could not be found