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 Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description 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, useJob.getChildJobs()
instead.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, useJob.getJobData()
instead.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, useJob.getJobFiles()
instead.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, useJob.getJobJobLocks()
instead.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, useJob.getJobNotes()
instead.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, useJob.getJobParameters()
instead.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, useJob.getJobRaiseEvents()
instead.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, useJob.getJobRuntimeLimits()
instead.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, useJob.getJobWaitEvents()
instead.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, useJob.getObjectTagsFromJobDefinition()
instead.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, useJob.getObjectTagsFromQueue()
instead.Iterator<OperatorMessage>
getOperatorMessages()
Get the value for OperatorMessage.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, useJob.getRecurrenceJobs()
instead.
-
-
-
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, useJob.getChildJobs()
instead.
-
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, useJob.getJobData()
instead.
-
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, useJob.getJobFiles()
instead.
-
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, useJob.getJobJobLocks()
instead.Get anIterator
over an ordered collection ofJobJobLocks
. If the collection is empty, an empty iterator will be returned, that is, this method will never returnnull
. The locks required by a job.- Returns:
- An
Iterator
over an ordered collection ofJobJobLock
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, useJob.getJobNotes()
instead.
-
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, useJob.getJobParameters()
instead.Get anIterator
over a collection ofJobParameters
, the collection will be ordered by DisplayOrder. If the collection is empty, an empty iterator will be returned, that is, this method will never returnnull
. Job parameters.- Returns:
- An
Iterator
over a collection ofJobParameter
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, useJob.getJobRaiseEvents()
instead.Get anIterator
over an ordered collection ofJobRaiseEvents
. If the collection is empty, an empty iterator will be returned, that is, this method will never returnnull
. The events to raise when a job completes with a particular status.- Returns:
- An
Iterator
over an ordered collection ofJobRaiseEvent
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, useJob.getJobRuntimeLimits()
instead.Get anIterator
over an ordered collection ofJobRuntimeLimits
. If the collection is empty, an empty iterator will be returned, that is, this method will never returnnull
. The runtime limits of a job.- Returns:
- An
Iterator
over an ordered collection ofJobRuntimeLimit
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, useJob.getJobWaitEvents()
instead.Get anIterator
over an ordered collection ofJobWaitEvents
. If the collection is empty, an empty iterator will be returned, that is, this method will never returnnull
. The events this job is waiting on before it will start.- Returns:
- An
Iterator
over an ordered collection ofJobWaitEvent
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, useJob.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, useJob.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, useJob.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.
-
-