Uses of Interface
com.redwood.scheduler.api.model.Job

Packages that use Job

Package	Description
com.redwood.scheduler.api.exception	Scheduler API - Exceptions
com.redwood.scheduler.api.job	Scheduler API - Interfaces for user defined jobs.
com.redwood.scheduler.api.model	Scheduler API - Model
com.redwood.scheduler.api.model.compatibility_14
com.redwood.scheduler.api.r2w.publish

Uses of Job in com.redwood.scheduler.api.exception

Constructors in com.redwood.scheduler.api.exception with parameters of type Job

Constructor	Description
JobNotFoundRuntimeException(Throwable cause, String relativeJob, Job job, String name)	A request was made for a job, however the job did not exist.
NotWithinAChainException(Throwable cause, Job job)	This job is neither a step nor a call of a JobChain
StepDoesNotExistException(Throwable cause, String operation, Job currentJob)	The JobChain does not contain the requested step

Uses of Job in com.redwood.scheduler.api.job

Methods in com.redwood.scheduler.api.job that return types with arguments of type Job

Modifier and Type	Method	Description
default Iterable<Job>	UserJobContext.loopOverNextJobChainStep(SchedulerSession session, RTXProducer producer)	Loop over the next step in the current job chain.
default Iterable<Job>	UserJobContext.loopOverNextJobChainStep(SchedulerSession session, RTXProducer producer, String jobDescription)	Loop over the next step in the current job chain.
default Iterable<Job>	UserJobContext.loopOverNextJobChainStep(SchedulerSession session, RTXProducer producer, Predicate<RTXRow> filter)	Loop over the next step in the current job chain.
Iterable<Job>	UserJobContext.loopOverNextJobChainStep(SchedulerSession session, RTXProducer producer, Predicate<RTXRow> filter, String jobDescription)	Loop over the next step in the current job chain.
default Iterable<Job>	UserJobContext.loopOverNextJobChainStep(SchedulerSession session, RTXReader reader)
default Iterable<Job>	UserJobContext.loopOverNextJobChainStep(SchedulerSession session, RTXReader reader, Predicate<RTXRow> filter)

Methods in com.redwood.scheduler.api.job with parameters of type Job

Modifier and Type	Method	Description
void	UserJobContext.killJobWithParent(Job job)	When this method is called, the child jobs will be killed when the given parent job is killed (the default is not).
void	UserJobContext.waitForJob(SchedulerSession session, Job job)	Wait for another job to finish.
void	UserJobContext.waitForJobs(SchedulerSession session, Job[] jobs)	Wait for all the specified jobs to finish.
void	UserJobContext.waitForJobs(SchedulerSession session, Job[] jobs, JobStatus[] statuses, long maxWait)	Wait for jobs to reach the specified statuses, with a maximum wait time.

Uses of Job in com.redwood.scheduler.api.model

Fields in com.redwood.scheduler.api.model with type parameters of type Job

Modifier and Type	Field	Description
static QueryObjectType<Job>	Job.TYPE	Type that can be used in SchedulerSession.executeObjectQuery(QueryObjectType, String, Object...).

Methods in com.redwood.scheduler.api.model that return Job

Modifier and Type	Method	Description
Job	JobLock.getHeldByJob()	Get the value for HeldByJob.
Job	ForecastJob.getJob()	Get the Job.
Job	JobDatum.getJob()	Get the Job.
Job	JobFile.getJob()	Get the Job.
Job	JobJobLock.getJob()	Get the Job.
Job	JobNote.getJob()	Get the Job.
Job	JobParameter.getJob()	Get the Job.
Job	JobRaiseEvent.getJob()	Get the Job.
Job	JobRuntimeLimit.getJob()	Get the Job.
Job	JobWaitEvent.getJob()	Get the Job.
Job	PublishApproval.getJob()	Get the Job.
Job	UserMessage.getJob()	Get the Job.
Job	WrappedJob.getJob()	Get the value for Job.
static Job	BusinessKeyLookup.getJobByBusinessKey(SchedulerSession session, String key)	Query an instance of Job, based on its business key.
Job	SchedulerSession.getJobByJobId(Long jobId)	Get the Job by JobId.
Job	BusinessKeyResolver.getJobByKey(BusinessKey key)	Query an instance of Job, based on its business key.
Job	SchedulerSession.getJobByRemoteIdentifiers(String remoteSystem, String remoteId)	Get the Job by RemoteIdentifiers.
Job	SchedulerSession.getJobByUniqueId(Long uniqueId)	Get the Job by UniqueId.
Job	Job.getNextStepJob()	Get the next step job. This method can be called from a job that corresponds to a step or a call.
Job	Job.getParentJob()	Get the ParentJob.
Job	Job.getPreviousStepJob()	Get the previous step job. This method can be called from a job that corresponds to a step or a call.
Job	Job.getRelativeJob(String jobName)	Get the job by name of the job in the current job chain.
Job	WrappedJob.getWrappedJob()	Get the WrappedJob.
Job	JobDefinition.prepare()	Prepare a job based on this job definition for submission.
Job	Job.restart()	Restart the job by submitting a new job with the same parameters.
Job	Job.restartFromError()	Restart the job, skipping the completed child jobs, to continue with the first error job.
Job	Job.restartRecurrence()	Restart the job group by submitting a new job group with the same parameters.
Job	Job.resubmit()	Prepare a new job with the same parameters, but clear the recurrence attributes.
Job	Job.resubmitRecurrence()	Prepare a new job with the same parameters, including all recurrence attributes.

Methods in com.redwood.scheduler.api.model that return types with arguments of type Job

Modifier and Type	Method	Description
RWIterable<Job>	Job.getChildJobs()	Get an RWIterable over a collection of ChildJobs, the collection will be ordered by ChildOrder.
List<Job>	Job.getExpandedJobList()	Returns a list of this job and its children that are to be shown in an expanded state; in general this is during the execution phase of a job.
RWIterable<Job>	Job.getRecurrenceJobs()	Return an iterator with all jobs in the recurrence for this job, including this.

Methods in com.redwood.scheduler.api.model with parameters of type Job

Modifier and Type	Method	Description
void	EventDefinition.clear(Job job, String clearerComment)	Clear the currently raised Event instance for this EventDefinition.
void	EventDefinition.clearAllPending(Job job, String clearerComment)	Clear all the pending events for this EventDefinition.
JobJobLock	JobLock.createJobJobLock(Job newJob)	Create a new JobJobLock linked to this object.
static Format	FileFormatFinder.getDefaultJobFileFormat(SchedulerSession session, Job job, JobFileType fileType, String jobFileName, Long fileOrder)	Get the fileFormat for this kind of output file.
SAPProcessRestart	SAPProcessDefinition.getSAPProcessRestartByJob(Job job)	Get the SAPProcessRestart by JobSAPProcessDefinition.
void	AbstractConcreteObjectCallback.handle(Job theJob)
void	ConcreteObjectCallback.handle(Job theJob)
boolean	Service.isExplainJobStatusPossible(Job job)	Is explainJobStatus possible? Returns true if explainJobStatus() is possible, false otherwise.
Event	EventDefinition.raise(Job job, String raiserComment)	Raise an Event instance for this EventDefinition.
void	JobLock.setHeldByJob(Job newHeldByJob)	Set the value for HeldByJob.
void	ForecastJob.setJob(Job newJob)	Set the value for Job.
void	PublishApproval.setJob(Job newJob)	Set the value for Job.
void	UserMessage.setJob(Job newJob)	Set the value for Job.
void	JobChainCallOutParameter.setJobParameter(Job job)	Perform the required processing to set the target job parameter.
void	Job.setParentJob(Job newParentJob)	Set the value for ParentJob.
void	SchedulerSession.waitForAllChildren(Job job)	Wait for all children of this job to finish.
void	SchedulerSession.waitForAllChildren(Job job, long maxWait)	Wait for all children of this job to finish.
void	SchedulerSession.waitForJob(Job job)	Wait for given job to finish.
void	SchedulerSession.waitForJob(Job job, long maxWait)	Wait for given job to finish.
void	SchedulerSession.waitForJob(Job job, JobStatus status)	Wait for jobs to reach the specified statuses, with unlimited time.
void	SchedulerSession.waitForJob(Job job, JobStatus status, long maxWait)	Similar as SchedulerSession.waitForJob(Job, JobStatus), except a maxWait is specified.
void	SchedulerSession.waitForJobs(Job[] jobs)	Wait for all given jobs to finish.
void	SchedulerSession.waitForJobs(Job[] jobs, long maxWait)	Wait for all given jobs to finish.
void	SchedulerSession.waitForJobs(Job[] jobs, JobStatus[] statuses, long maxWait)	Wait for jobs to reach the specified statuses, with a maximum wait time.
JobFile	Exporter.writeToNewJobFile(Job job)	Export marked objects to a local job file that will be attached to the supplied job.

Uses of Job in com.redwood.scheduler.api.model.compatibility_14

Methods in com.redwood.scheduler.api.model.compatibility_14 that return types with arguments of type Job

Modifier and Type	Method	Description
Iterator<Job>	JobComp.getChildJobs()	Deprecated. this method should never be used directly, and is only provided to ensure binary compatibility with previous releases of the software, use getChildJobs() instead.
Iterator<Job>	JobComp.getRecurrenceJobs()	Deprecated. this method should never be used directly, and is only provided to ensure binary compatibility with previous releases of the software, use getRecurrenceJobs() instead.

Uses of Job in com.redwood.scheduler.api.r2w.publish

Methods in com.redwood.scheduler.api.r2w.publish with parameters of type Job

Modifier and Type	Method	Description
R2WMetaData	R2WPublisher.createMetaData(Job context)	Create the MetaData for the publishing