Interface JobComp

  • All Known Subinterfaces:
    Job

    public interface JobComp
    This class is only required in order to be able to provide binary compatibility with older releases. You should never access this class directly.
    • Method Detail

      • getChildJobs

        @Deprecated
        Iterator<Job> getChildJobs()
        Deprecated.
        this method should never be used directly, and is only provided to ensure binary compatibility with previous releases of the software, use Job.getChildJobs() instead.
        Get an Iterator over a collection of ChildJobs, the collection will be ordered by ChildOrder. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. The parent Job of this Job.
        Returns:
        An Iterator over a collection of Job objects , the collection will be ordered by ChildOrder.
      • getJobData

        @Deprecated
        Iterator<JobDatum> getJobData()
        Deprecated.
        this method should never be used directly, and is only provided to ensure binary compatibility with previous releases of the software, use Job.getJobData() instead.
        Get an Iterator over an ordered collection of JobData. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. The MetaData associated with a Job.
        Returns:
        An Iterator over an ordered collection of JobDatum objects .
      • getJobFiles

        @Deprecated
        Iterator<JobFile> getJobFiles()
        Deprecated.
        this method should never be used directly, and is only provided to ensure binary compatibility with previous releases of the software, use Job.getJobFiles() instead.
        Get an Iterator over a collection of JobFiles, the collection will be ordered by FileOrder. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. A job file.
        Returns:
        An Iterator over a collection of JobFile objects , the collection will be ordered by FileOrder.
      • getJobJobLocks

        @Deprecated
        Iterator<JobJobLock> getJobJobLocks()
        Deprecated.
        this method should never be used directly, and is only provided to ensure binary compatibility with previous releases of the software, use Job.getJobJobLocks() instead.
        Get an Iterator over an ordered collection of JobJobLocks. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. The locks required by a job.
        Returns:
        An Iterator over an ordered collection of JobJobLock objects .
      • getJobNotes

        @Deprecated
        Iterator<JobNote> getJobNotes()
        Deprecated.
        this method should never be used directly, and is only provided to ensure binary compatibility with previous releases of the software, use Job.getJobNotes() instead.
        Get an Iterator over an ordered collection of JobNotes. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. The notes for a job.
        Returns:
        An Iterator over an ordered collection of JobNote objects .
      • getJobParameters

        @Deprecated
        Iterator<JobParameter> getJobParameters()
        Deprecated.
        this method should never be used directly, and is only provided to ensure binary compatibility with previous releases of the software, use Job.getJobParameters() instead.
        Get an Iterator over a collection of JobParameters, the collection will be ordered by DisplayOrder. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. Job parameters.
        Returns:
        An Iterator over a collection of JobParameter objects , the collection will be ordered by DisplayOrder.
      • getJobRaiseEvents

        @Deprecated
        Iterator<JobRaiseEvent> getJobRaiseEvents()
        Deprecated.
        this method should never be used directly, and is only provided to ensure binary compatibility with previous releases of the software, use Job.getJobRaiseEvents() instead.
        Get an Iterator over an ordered collection of JobRaiseEvents. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. The events to raise when a job completes with a particular status.
        Returns:
        An Iterator over an ordered collection of JobRaiseEvent objects .
      • getJobRuntimeLimits

        @Deprecated
        Iterator<JobRuntimeLimit> getJobRuntimeLimits()
        Deprecated.
        this method should never be used directly, and is only provided to ensure binary compatibility with previous releases of the software, use Job.getJobRuntimeLimits() instead.
        Get an Iterator over an ordered collection of JobRuntimeLimits. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. The runtime limits of a job.
        Returns:
        An Iterator over an ordered collection of JobRuntimeLimit objects .
      • getJobWaitEvents

        @Deprecated
        Iterator<JobWaitEvent> getJobWaitEvents()
        Deprecated.
        this method should never be used directly, and is only provided to ensure binary compatibility with previous releases of the software, use Job.getJobWaitEvents() instead.
        Get an Iterator over an ordered collection of JobWaitEvents. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. The events this job is waiting on before it will start.
        Returns:
        An Iterator over an ordered collection of JobWaitEvent objects .
      • getObjectTagsFromQueue

        @Deprecated
        Iterator<ObjectTag> getObjectTagsFromQueue()
        Deprecated.
        this method should never be used directly, and is only provided to ensure binary compatibility with previous releases of the software, use Job.getObjectTagsFromQueue() instead.
        Returns an RWIterable with ObjectTag instances from the Queue (this is a convenience method, you can get it from Queue directly as well). If the Queue is not set, returns an empty RWIterable.
        Returns:
        RWIterable with ObjectTag instances when present, an empty RWIterable otherwise.
      • getObjectTagsFromJobDefinition

        @Deprecated
        Iterator<ObjectTag> getObjectTagsFromJobDefinition()
        Deprecated.
        this method should never be used directly, and is only provided to ensure binary compatibility with previous releases of the software, use Job.getObjectTagsFromJobDefinition() instead.
        Returns an RWIterable with ObjectTag instances from the JobDefinition of the Job (this is a convenience method, you can get it from JobDefinition directly as well). If the JobDefinition is not set, returns an empty RWIterable.
        Returns:
        Iterator with RWIterable instances when present, empty RWIterable otherwise.
      • getRecurrenceJobs

        @Deprecated
        Iterator<Job> getRecurrenceJobs()
        Deprecated.
        this method should never be used directly, and is only provided to ensure binary compatibility with previous releases of the software, use Job.getRecurrenceJobs() instead.
        Return an iterator with all jobs in the recurrence for this job, including this. If the job is not in a recurrence group, the iterator will only include this job.
        Returns:
        The iterator over the all jobs of the recurrence that this job is in, including this job.
      • getOperatorMessages

        Iterator<OperatorMessage> getOperatorMessages()
        Get the value for OperatorMessage. (Operator messages raised by this job.)
        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.