Package com.redwood.scheduler.api.model

Interface JobChainCall

All Superinterfaces:

BusinessKeyObject, Detail, JobChainCallComp, Readable, SchedulerEntity, SchedulerEntityComp

public interface JobChainCall
extends JobChainCallComp, Detail, BusinessKeyObject, Readable

Defines a job submit in a particular job chain step A reference to a job definition. When the job chain is submitted all job chain calls result in nested job submits.

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "JobChainCall" objects.
static String	SEC_RANK_ALL	This rank is made of the following privileges:
static String	SEC_RANK_NONE	This rank has no privileges assigned to it.
static QueryObjectType<JobChainCall>	TYPE	Type that can be used in SchedulerSession.executeObjectQuery(QueryObjectType, String, Object...).

Fields inherited from interface com.redwood.scheduler.api.model.BusinessKeyObject

COPYRIGHT_MESSAGE_BKO, ID_BKO

Fields inherited from interface com.redwood.scheduler.api.model.Readable

COPYRIGHT_MESSAGE_E, ID_E

Fields inherited from interface com.redwood.scheduler.api.model.SchedulerEntity

ACTION_AUDIT, ACTION_EXPORT, ACTION_READ, BEHAVIOR_DEPRECATED, BEHAVIOR_NONE, BEHAVIOR_SYSTEM

Method Summary

Modifier and Type	Method	Description
ConstraintContext	createConstraintContext()	Create a ConstraintContext so that the constraints can be verified.
JobChainCallInExpressionParameter	createJobChainCallInExpressionParameter()	Create a new JobChainCallInExpressionParameter linked to this object.
JobChainCallInReferenceParameter	createJobChainCallInReferenceParameter()	Create a new JobChainCallInReferenceParameter linked to this object.
JobChainCallJobLock	createJobChainCallJobLock(JobLock newJobLock)	Create a new JobChainCallJobLock linked to this object.
JobChainCallOutReferenceParameter	createJobChainCallOutReferenceParameter()	Create a new JobChainCallOutReferenceParameter linked to this object.
JobChainCallPrecondition	createJobChainCallPrecondition()	Create a new JobChainCallPrecondition linked to this object.
JobChainCallProcessMonitorUpdater	createJobChainCallProcessMonitorUpdater()	Create a new JobChainCallProcessMonitorUpdater linked to this object.
JobChainCallRaiseEvent	createJobChainCallRaiseEvent()	Create a new JobChainCallRaiseEvent linked to this object.
JobChainCallSchedulingParameter	createJobChainCallSchedulingParameter()	Create a new JobChainCallSchedulingParameter linked to this object.
JobChainCallWaitEvent	createJobChainCallWaitEvent()	Create a new JobChainCallWaitEvent linked to this object.
void	disableAtSubmit()	Disables the job at Submit Time by setting the SubmitDisabled to true.
void	enableAtSubmit()	Enables the job at Submit Time by setting the SubmitDisabled to false.
Long	getAverageCallStartDelay()	Get the value for AverageCallStartDelay.
Long	getAverageRunTime()	Get the value for AverageRunTime.
Long	getCallStartCount()	Get the value for CallStartCount.
String	getDescription()	Get the value for Description.
Long	getExecutionCompletedCount()	Get the value for ExecutionCompletedCount.
JobChainCallInExpressionParameter	getJobChainCallInExpressionParameterByLocalJobDefinitionParameter(JobDefinitionParameter localJobDefinitionParameter)	Get the JobChainCallInExpressionParameter by DestinationJobDefinitionParameter.
RWIterable<JobChainCallInExpressionParameter>	getJobChainCallInExpressionParameters()	Get an RWIterable over an ordered collection of JobChainCallInExpressionParameters.
JobChainCallInReferenceParameter	getJobChainCallInReferenceParameterByLocalJobDefinitionParameter(JobDefinitionParameter localJobDefinitionParameter)	Get the JobChainCallInReferenceParameter by DestinationJobDefinitionParameter.
RWIterable<JobChainCallInReferenceParameter>	getJobChainCallInReferenceParameters()	Get an RWIterable over an ordered collection of JobChainCallInReferenceParameters.
JobChainCallJobLock	getJobChainCallJobLockByJobLock(JobLock jobLock)	Get the JobChainCallJobLock by JobChainCallJobLock.
RWIterable<JobChainCallJobLock>	getJobChainCallJobLocks()	Get an RWIterable over an ordered collection of JobChainCallJobLocks.
RWIterable<JobChainCallOutReferenceParameter>	getJobChainCallOutReferenceParameters()	Get an RWIterable over an ordered collection of JobChainCallOutReferenceParameters.
JobChainCallPrecondition	getJobChainCallPrecondition()	Get the JobChainCallPrecondition.
RWIterable<JobChainCallProcessMonitorUpdater>	getJobChainCallProcessMonitorUpdaters()	Get an RWIterable over an ordered collection of JobChainCallProcessMonitorUpdaters.
RWIterable<JobChainCallRaiseEvent>	getJobChainCallRaiseEvents()	Get an RWIterable over an ordered collection of JobChainCallRaiseEvents.
JobChainCallSchedulingParameter	getJobChainCallSchedulingParameterByName(SchedulingParameterName name)	Get the JobChainCallSchedulingParameter by NameJobChainCall.
RWIterable<JobChainCallSchedulingParameter>	getJobChainCallSchedulingParameters()	Get an RWIterable over a collection of JobChainCallSchedulingParameters, the collection will be ordered by UniqueId.
RWIterable<JobChainCallWaitEvent>	getJobChainCallWaitEvents()	Get an RWIterable over an ordered collection of JobChainCallWaitEvents.
JobChainStep	getJobChainStep()	Get the JobChainStep.
JobDefinition	getJobDefinition()	Get the JobDefinition.
Long	getSequenceNumber()	Get the value for SequenceNumber.
BigDecimal	getStandardDeviationCallStartDelay()	Get the value for StandardDeviationCallStartDelay.
BigDecimal	getStandardDeviationRunTime()	Get the value for StandardDeviationRunTime.
Statistics	getStatisticsByKeyParameters(Map<String,String> keyParameters)	Get a statistics object associated to this JobChainCall.
boolean	isIgnoreStatus()	Get the value for IgnoreStatus.
boolean	isStepWaitingOnJob()	Get the value for StepWaitingOnJob.
void	resetStatistics()	Reset the counters and statistics for this job-chain call.
void	setDescription(String newDescription)	Set the value for Description.
void	setIgnoreStatus(boolean newIgnoreStatus)	Set the value for IgnoreStatus.
void	setJobDefinition(JobDefinition newJobDefinition)	Set the value for JobDefinition.
void	setSequenceNumber(Long newSequenceNumber)	Set the value for SequenceNumber.
void	setStepWaitingOnJob(boolean newStepWaitingOnJob)	Set the value for StepWaitingOnJob.

Methods inherited from interface com.redwood.scheduler.api.model.BusinessKeyObject

getBusinessKey

Methods inherited from interface com.redwood.scheduler.api.model.SchedulerEntity

canPerform, createSubjectObjectPrivilegeGrant, deleteObject, getAuditTrail, getAuditTrailSize, getBehavior, getEffectiveBehavior, getErrorNameEN, getErrorNameKey, getLLPVersion, getLOV, getLOVSupport, getObjectType, getParentSchedulerEntities, getRuntime, getSubjectObjectPrivilegeGrantBySubject, getSubjectObjectPrivilegeGrants, getUniqueId, getUrl, getUrl, isCreated, isDeletable, isDeleted, isModifiable, isModified, isSelectVersioned, processRelatedObjects, processRelatedObjects, processRelatedObjects, refreshObject, resetObject, resetObject, resetValuesToDefault, selectForRead

Field Detail

OBJECT_TYPE

static final String OBJECT_TYPE

String that will be returned from SchedulerEntity.getObjectType() for "JobChainCall" objects.

See Also:

Constant Field Values

TYPE

static final QueryObjectType<JobChainCall> TYPE

Type that can be used in SchedulerSession.executeObjectQuery(QueryObjectType, String, Object...).

SEC_RANK_NONE

static final String SEC_RANK_NONE

This rank has no privileges assigned to it.

See Also:

Constant Field Values

SEC_RANK_ALL

static final String SEC_RANK_ALL

This rank is made of the following privileges:

See Also:

Constant Field Values

Method Detail

getAverageCallStartDelay

Long getAverageCallStartDelay()

Get the value for AverageCallStartDelay. (Statistic: The average delay after which jobs for this call start once the parent step starts.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.

Returns:

the field

Throws:

ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

getAverageRunTime

Long getAverageRunTime()

Get the value for AverageRunTime. (Statistic: The average run-time for the jobs of this JobChainCall in milliseconds. If no value is available for the call, the function will NOT fallback to the jobDefinition value.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.

Returns:

the field

Throws:

ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

getCallStartCount

Long getCallStartCount()

Get the value for CallStartCount. (Statistic: the number of times this call has started executing.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.

Returns:

the field

Throws:

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:

ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

getExecutionCompletedCount

Long getExecutionCompletedCount()

Get the value for ExecutionCompletedCount. (Statistic: the number of times this call has executed successfully.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.

Returns:

the field

Throws:

ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

getSequenceNumber

Long getSequenceNumber()

Get the value for SequenceNumber. (The call sequence number.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.

Returns:

the field

Throws:

ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

getStandardDeviationCallStartDelay

BigDecimal getStandardDeviationCallStartDelay()

Get the value for StandardDeviationCallStartDelay. (Statistic: The standard deviation of the delay starting jobs of this JobChainCall.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.

Returns:

the field

Throws:

ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

getStandardDeviationRunTime

BigDecimal getStandardDeviationRunTime()

Get the value for StandardDeviationRunTime. (Statistic: The standard deviation of the run-time for the jobs of this JobChainCall.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.

Returns:

the field

Throws:

ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

isIgnoreStatus

boolean isIgnoreStatus()

Get the value for IgnoreStatus. (Ignore the status of this job for the purposes of calculating the final status of the step)

Returns:

the field

Throws:

ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

isStepWaitingOnJob

boolean isStepWaitingOnJob()

Get the value for StepWaitingOnJob. (Should the step wait for the job to complete before it can complete? If set to false, the step will not wait for the job to finish, it will also automatically ignore the status of the job.)

Returns:

the field

Throws:

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:

ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

setSequenceNumber

void setSequenceNumber(Long newSequenceNumber)

Set the value for SequenceNumber. (The call sequence number.) This value is mandatory.

Parameters:

newSequenceNumber - the new value for SequenceNumber. If this is null, then the object cannot be persisted.

Throws:

ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

setIgnoreStatus

void setIgnoreStatus(boolean newIgnoreStatus)

Set the value for IgnoreStatus. (Ignore the status of this job for the purposes of calculating the final status of the step)

Parameters:

newIgnoreStatus - the new value for IgnoreStatus.

Throws:

ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

setStepWaitingOnJob

void setStepWaitingOnJob(boolean newStepWaitingOnJob)

Set the value for StepWaitingOnJob. (Should the step wait for the job to complete before it can complete? If set to false, the step will not wait for the job to finish, it will also automatically ignore the status of the job.)

Parameters:

newStepWaitingOnJob - the new value for StepWaitingOnJob.

Throws:

ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

createConstraintContext

ConstraintContext createConstraintContext()

Create a ConstraintContext so that the constraints can be verified.

Returns:

The ConstraintContext

getStatisticsByKeyParameters

Statistics getStatisticsByKeyParameters(Map<String,String> keyParameters)

Get a statistics object associated to this JobChainCall.

Parameters:

keyParameters - KeyParameters as a map of String names -> String values

Returns:

Statistics

resetStatistics

void resetStatistics()

Reset the counters and statistics for this job-chain call.

enableAtSubmit

void enableAtSubmit()

Enables the job at Submit Time by setting the SubmitDisabled to false.

disableAtSubmit

void disableAtSubmit()

Disables the job at Submit Time by setting the SubmitDisabled to true.

getJobDefinition

JobDefinition getJobDefinition()

Get the JobDefinition.

Returns:

JobDefinition

Throws:

ObjectDeletedException - If this method is called when the object has been marked for deletion.

ObjectNotAttachedToSessionException - If this method is called when the object has been removed from it's session.

getJobChainStep

JobChainStep getJobChainStep()

Get the JobChainStep.

Returns:

JobChainStep

Throws:

ObjectDeletedException - If this method is called when the object has been marked for deletion.

ObjectNotAttachedToSessionException - If this method is called when the object has been removed from it's session.

setJobDefinition

void setJobDefinition(JobDefinition newJobDefinition)

Set the value for JobDefinition. This value is mandatory.

Parameters:

newJobDefinition - is the object to set JobDefinition to. A call to a job definition from a job chain. If this is null, then the object cannot be persisted.

getJobChainCallInExpressionParameters

RWIterable<JobChainCallInExpressionParameter> getJobChainCallInExpressionParameters()

Get an RWIterable over an ordered collection of JobChainCallInExpressionParameters. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. The JobChainCall that this JobChainCallParameter belongs to. The LocalJobDefinitionParameter must refer to a JobDefinitionParameter of the JobDefinition that the JobChainCall points to.

Specified by:

getJobChainCallInExpressionParameters in interface JobChainCallComp

Returns:

An RWIterable over an ordered collection of JobChainCallInExpressionParameter objects .

createJobChainCallInExpressionParameter

JobChainCallInExpressionParameter createJobChainCallInExpressionParameter()

Create a new JobChainCallInExpressionParameter linked to this object.

Returns:

a new JobChainCallInExpressionParameter.

getJobChainCallInExpressionParameterByLocalJobDefinitionParameter

JobChainCallInExpressionParameter getJobChainCallInExpressionParameterByLocalJobDefinitionParameter(JobDefinitionParameter localJobDefinitionParameter)

Get the JobChainCallInExpressionParameter by DestinationJobDefinitionParameter.

Parameters:

localJobDefinitionParameter -

Returns:

the JobChainCallInExpressionParameter, or null if it could not be found

getJobChainCallInReferenceParameters

RWIterable<JobChainCallInReferenceParameter> getJobChainCallInReferenceParameters()

Get an RWIterable over an ordered collection of JobChainCallInReferenceParameters. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. The JobChainCall that this JobChainCallParameter belongs to. The LocalJobDefinitionParameter must refer to a JobDefinitionParameter of the JobDefinition that the JobChainCall points to.

Specified by:

getJobChainCallInReferenceParameters in interface JobChainCallComp

Returns:

An RWIterable over an ordered collection of JobChainCallInReferenceParameter objects .

createJobChainCallInReferenceParameter

JobChainCallInReferenceParameter createJobChainCallInReferenceParameter()

Create a new JobChainCallInReferenceParameter linked to this object.

Returns:

a new JobChainCallInReferenceParameter.

getJobChainCallInReferenceParameterByLocalJobDefinitionParameter

JobChainCallInReferenceParameter getJobChainCallInReferenceParameterByLocalJobDefinitionParameter(JobDefinitionParameter localJobDefinitionParameter)

Get the JobChainCallInReferenceParameter by DestinationJobDefinitionParameter.

Parameters:

localJobDefinitionParameter -

Returns:

the JobChainCallInReferenceParameter, or null if it could not be found

getJobChainCallOutReferenceParameters

RWIterable<JobChainCallOutReferenceParameter> getJobChainCallOutReferenceParameters()

Get an RWIterable over an ordered collection of JobChainCallOutReferenceParameters. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. The JobChainCall that this JobChainCallParameter belongs to. The LocalJobDefinitionParameter must refer to a JobDefinitionParameter of the JobDefinition that the JobChainCall points to.

Specified by:

getJobChainCallOutReferenceParameters in interface JobChainCallComp

Returns:

An RWIterable over an ordered collection of JobChainCallOutReferenceParameter objects .

createJobChainCallOutReferenceParameter

JobChainCallOutReferenceParameter createJobChainCallOutReferenceParameter()

Create a new JobChainCallOutReferenceParameter linked to this object.

Returns:

a new JobChainCallOutReferenceParameter.

getJobChainCallPrecondition

JobChainCallPrecondition getJobChainCallPrecondition()

Get the JobChainCallPrecondition. The precondition for a job chain call.

Returns:

nullJobChainCallPrecondition

Throws:

ObjectDeletedException - If this method is called when the object has been marked for deletion.

ObjectNotAttachedToSessionException - If this method is called when the object has been removed from it's session.

createJobChainCallPrecondition

JobChainCallPrecondition createJobChainCallPrecondition()

Create a new JobChainCallPrecondition linked to this object.

Returns:

a new JobChainCallPrecondition.

getJobChainCallRaiseEvents

RWIterable<JobChainCallRaiseEvent> getJobChainCallRaiseEvents()

Get an RWIterable over an ordered collection of JobChainCallRaiseEvents. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. Predefined list of events that a job will raise when it reaches a particular status.

Specified by:

getJobChainCallRaiseEvents in interface JobChainCallComp

Returns:

An RWIterable over an ordered collection of JobChainCallRaiseEvent objects .

createJobChainCallRaiseEvent

JobChainCallRaiseEvent createJobChainCallRaiseEvent()

Create a new JobChainCallRaiseEvent linked to this object.

Returns:

a new JobChainCallRaiseEvent.

getJobChainCallSchedulingParameters

RWIterable<JobChainCallSchedulingParameter> getJobChainCallSchedulingParameters()

Get an RWIterable over a collection of JobChainCallSchedulingParameters, the collection will be ordered by UniqueId. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. Scheduler parameters that will apply for jobs scheduled by this call.

Specified by:

getJobChainCallSchedulingParameters in interface JobChainCallComp

Returns:

An RWIterable over a collection of JobChainCallSchedulingParameter objects , the collection will be ordered by UniqueId.

createJobChainCallSchedulingParameter

JobChainCallSchedulingParameter createJobChainCallSchedulingParameter()

Create a new JobChainCallSchedulingParameter linked to this object.

Returns:

a new JobChainCallSchedulingParameter.

getJobChainCallSchedulingParameterByName

JobChainCallSchedulingParameter getJobChainCallSchedulingParameterByName(SchedulingParameterName name)

Get the JobChainCallSchedulingParameter by NameJobChainCall.

Parameters:

name -

Returns:

the JobChainCallSchedulingParameter, or null if it could not be found

getJobChainCallWaitEvents

RWIterable<JobChainCallWaitEvent> getJobChainCallWaitEvents()

Get an RWIterable over an ordered collection of JobChainCallWaitEvents. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. Predefined list of events that a job chain call will wait for before executing

Specified by:

getJobChainCallWaitEvents in interface JobChainCallComp

Returns:

An RWIterable over an ordered collection of JobChainCallWaitEvent objects .

createJobChainCallWaitEvent

JobChainCallWaitEvent createJobChainCallWaitEvent()

Create a new JobChainCallWaitEvent linked to this object.

Returns:

a new JobChainCallWaitEvent.

getJobChainCallJobLocks

RWIterable<JobChainCallJobLock> getJobChainCallJobLocks()

Get an RWIterable over an ordered collection of JobChainCallJobLocks. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. Predefined list of locks that a job needs to acquire before executing

Specified by:

getJobChainCallJobLocks in interface JobChainCallComp

Returns:

An RWIterable over an ordered collection of JobChainCallJobLock objects .

createJobChainCallJobLock

JobChainCallJobLock createJobChainCallJobLock(JobLock newJobLock)

Create a new JobChainCallJobLock linked to this object.

Parameters:

newJobLock - The other parent of the JobChainCallJobLockJobLock association.

Returns:

a new JobChainCallJobLock.

getJobChainCallJobLockByJobLock

JobChainCallJobLock getJobChainCallJobLockByJobLock(JobLock jobLock)

Get the JobChainCallJobLock by JobChainCallJobLock.

Parameters:

jobLock -

Returns:

the JobChainCallJobLock, or null if it could not be found

getJobChainCallProcessMonitorUpdaters

RWIterable<JobChainCallProcessMonitorUpdater> getJobChainCallProcessMonitorUpdaters()

Get an RWIterable over an ordered collection of JobChainCallProcessMonitorUpdaters. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. The ProcessMonitorUpdaters for a JobDefinition

Specified by:

getJobChainCallProcessMonitorUpdaters in interface JobChainCallComp

Returns:

An RWIterable over an ordered collection of JobChainCallProcessMonitorUpdater objects .

createJobChainCallProcessMonitorUpdater

JobChainCallProcessMonitorUpdater createJobChainCallProcessMonitorUpdater()

Create a new JobChainCallProcessMonitorUpdater linked to this object.

Returns:

a new JobChainCallProcessMonitorUpdater.