Interface JobDefinitionJobLock

    • Method Detail

      • 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.
      • getRequiredCount

        Long getRequiredCount()
        Get the value for RequiredCount. (The number of locks that will be taken when running a job. The job will not run until this amount is available.) 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.
      • setRequiredCount

        void setRequiredCount​(Long newRequiredCount)
        Set the value for RequiredCount. (The number of locks that will be taken when running a job. The job will not run until this amount is available.) This value is mandatory.
        Parameters:
        newRequiredCount - the new value for RequiredCount. 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.
      • getJobLock

        JobLock getJobLock()
        Get the JobLock.
        Returns:
        JobLock
        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.