Package com.redwood.scheduler.api.model

Interface WrappedJob

  • All Superinterfaces:
    Root, SchedulerEntity, SchedulerEntityComp
    All Known Subinterfaces:
    Export, Import
    public interface WrappedJob
extends Root
    Abstract base-class for objects that wrap a job internally. Some objects act as a facade that wrap an internal job. This base-class provides pass-through attributes for such objects.

    • Method Detail

      • getComment

        String getComment()
        Get the value for Comment. (Optional comment.)
        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.

      • getDescription

        String getDescription()
        Get the value for Description. (Optional description.)
        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.

      • getJob

        Job getJob()
        Get the value for Job. (This is the wrapped internal job.) 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.

      • getWrappedJobDefinition

        JobDefinition getWrappedJobDefinition()
        Get the value for WrappedJobDefinition. (This is the optional JobDefinition of the wrapped job (if no JobDefinition is passed, the default will be used).)
        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.

      • getRequestedStartTime

        DateTimeZone getRequestedStartTime()
        Get the value for RequestedStartTime. (This is the time that the user has requested that the wrapped job start.) 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.

      • setComment

        void setComment​(String newComment)
        Set the value for Comment. (Optional comment.) This value is optional.
        Parameters:
        newComment - the new value for Comment.
        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.

      • setDescription

        void setDescription​(String newDescription)
        Set the value for Description. (Optional description.) This value is optional.
        Parameters:
        newDescription - the new value for Description.
        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.

      • setWrappedJobDefinition

        void setWrappedJobDefinition​(JobDefinition newWrappedJobDefinition)
        Set the value for WrappedJobDefinition. (This is the optional JobDefinition of the wrapped job (if no JobDefinition is passed, the default will be used).) This value is optional.
        Parameters:
        newWrappedJobDefinition - the new value for WrappedJobDefinition.
        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.

      • setRequestedStartTime

        void setRequestedStartTime​(DateTimeZone newRequestedStartTime)
        Set the value for RequestedStartTime. (This is the time that the user has requested that the wrapped job start.) This value is mandatory.
        Parameters:
        newRequestedStartTime - the new value for RequestedStartTime. 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.

      • getIsolationGroup

        IsolationGroup getIsolationGroup()
        Get the IsolationGroup.
        Returns:
        IsolationGroup
        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.

      • getWrappedJob

        Job getWrappedJob()
        Get the WrappedJob.
        Returns:
        WrappedJob
        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.

      • setIsolationGroup

        void setIsolationGroup​(IsolationGroup newIsolationGroup)
        Set the value for IsolationGroup. This value is mandatory.
        Parameters:
        newIsolationGroup - is the object to set IsolationGroup to. The isolation-group that a wrapped-job belongs to. If this is null, then the object cannot be persisted.