Interface JobDefinitionWaitEvent

    • Method Detail

      • getAutoSubmit

        WaitEventSubmitType getAutoSubmit()
        Get the value for AutoSubmit. (Should the JobDefinition be submitted automatically when the event is raised?) 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.
      • isMasterVersion

        boolean isMasterVersion()
        Get the value for MasterVersion. (Whether this object belongs to a master object or not.)
        Specified by:
        isMasterVersion in interface Branchable
        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.
      • isCreatedBySystem

        boolean isCreatedBySystem()
        Get the value for CreatedBySystem. (Has this JobDefinitionWaitEvent been created behind the scenes?)
        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.
      • setAutoSubmit

        void setAutoSubmit​(WaitEventSubmitType newAutoSubmit)
        Set the value for AutoSubmit. (Should the JobDefinition be submitted automatically when the event is raised?) This value is mandatory.
        Parameters:
        newAutoSubmit - the new value for AutoSubmit. 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.
      • setCreatedBySystem

        void setCreatedBySystem​(boolean newCreatedBySystem)
        Set the value for CreatedBySystem. (Has this JobDefinitionWaitEvent been created behind the scenes?)
        Parameters:
        newCreatedBySystem - the new value for CreatedBySystem.
        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.
      • getEventDefinition

        EventDefinition getEventDefinition()
        Get the EventDefinition.
        Returns:
        EventDefinition
        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.
      • 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.