Package com.redwood.scheduler.api.model

Interface JobWaitEvent

  • All Superinterfaces:
    BusinessKeyObject, Detail, Precondition, Readable, SchedulerEntity, SchedulerEntityComp, WaitEvent
    public interface JobWaitEvent
extends WaitEvent, BusinessKeyObject, Readable
    Events that need to be raised before the job runs At the moment job would go to the QUEUED status the job definition EventExpression is calculated. A null expression is equivalent to (event1 and event2 and ...), that is all events need to be raised. If the event expression does not return true, the job goes to the EVENTWAIT status until one or more events are raised or cleared and the event expression does return true.

    • Method Detail

      • isRaised

        boolean isRaised()
        Get the value for Raised. (Has this JobWaitEvent had its event raised?)
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setRaisedEvent

        void setRaisedEvent​(Event newRaisedEvent)
        Set the value for RaisedEvent. This value is optional.
        Parameters:
        newRaisedEvent - is the object to set RaisedEvent to. If this is set, then the associated Job no longer needs to wait on its associated EventDefinition.

      • setEventDefinition

        void setEventDefinition​(EventDefinition newEventDefinition)
        Set the value for EventDefinition. This value is mandatory.
        Parameters:
        newEventDefinition - is the object to set EventDefinition to. Which EventDefinition must be raised before this WaitEvent is satisfied? If this is null, then the object cannot be persisted.