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 SummaryFields Modifier and Type Field Description static StringOBJECT_TYPEString that will be returned fromSchedulerEntity.getObjectType()for "JobChainCall" objects.static StringSEC_RANK_ALLThis rank is made of the following privileges:static StringSEC_RANK_NONEThis rank has no privileges assigned to it.static QueryObjectType<JobChainCall>TYPEType that can be used inSchedulerSession.executeObjectQuery(QueryObjectType, String, Object...).- 
Fields inherited from interface com.redwood.scheduler.api.model.SchedulerEntityACTION_AUDIT, ACTION_EXPORT, ACTION_READ, BEHAVIOR_DEPRECATED, BEHAVIOR_NONE, BEHAVIOR_SYSTEM
 
- 
 - 
Method Summary- 
Methods inherited from interface com.redwood.scheduler.api.model.BusinessKeyObjectgetBusinessKey
 - 
Methods inherited from interface com.redwood.scheduler.api.model.SchedulerEntitycanPerform, 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_TYPEstatic final String OBJECT_TYPE String that will be returned fromSchedulerEntity.getObjectType()for "JobChainCall" objects.- See Also:
- Constant Field Values
 
 - 
TYPEstatic final QueryObjectType<JobChainCall> TYPE Type that can be used inSchedulerSession.executeObjectQuery(QueryObjectType, String, Object...).
 - 
SEC_RANK_NONEstatic final String SEC_RANK_NONE This rank has no privileges assigned to it.- See Also:
- Constant Field Values
 
 - 
SEC_RANK_ALLstatic final String SEC_RANK_ALL This rank is made of the following privileges:- See Also:
- Constant Field Values
 
 
- 
 - 
Method Detail- 
getAverageCallStartDelayLong 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 benullif 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.
 
 - 
getAverageRunTimeLong 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 benullif 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.
 
 - 
getCallStartCountLong getCallStartCount() Get the value for CallStartCount. (Statistic: the number of times this call has started executing.) This value is mandatory, and therefore will not benullif 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.
 
 - 
getDescriptionString getDescription() Get the value for Description. (Optional description)- 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.
 
 - 
getExecutionCompletedCountLong getExecutionCompletedCount() Get the value for ExecutionCompletedCount. (Statistic: the number of times this call has executed successfully.) This value is mandatory, and therefore will not benullif 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.
 
 - 
getSequenceNumberLong getSequenceNumber() Get the value for SequenceNumber. (The call sequence number.) This value is mandatory, and therefore will not benullif 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.
 
 - 
getStandardDeviationCallStartDelayBigDecimal 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 benullif 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.
 
 - 
getStandardDeviationRunTimeBigDecimal 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 benullif 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.
 
 - 
isIgnoreStatusboolean 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:
- com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException- This will be thrown if this method is called while the object is not attached to a session.
 
 - 
isStepWaitingOnJobboolean 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:
- com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException- This will be thrown if this method is called while the object is not attached to a session.
 
 - 
setDescriptionvoid setDescription(String newDescription) Set the value for Description. (Optional description) This value is optional.- Parameters:
- newDescription- the new value for Description.
- 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.
 
 - 
setSequenceNumbervoid 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:
- com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException- This will be thrown if this method is called while the object is not attached to a session.
 
 - 
setIgnoreStatusvoid 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:
- com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException- This will be thrown if this method is called while the object is not attached to a session.
 
 - 
setStepWaitingOnJobvoid 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:
- com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException- This will be thrown if this method is called while the object is not attached to a session.
 
 - 
createConstraintContextConstraintContext createConstraintContext() Create a ConstraintContext so that the constraints can be verified.- Returns:
- The ConstraintContext
 
 - 
getStatisticsByKeyParametersStatistics 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
 
 - 
resetStatisticsvoid resetStatistics() Reset the counters and statistics for this job-chain call.
 - 
enableAtSubmitvoid enableAtSubmit() Enables the job at Submit Time by setting the SubmitDisabled to false.
 - 
disableAtSubmitvoid disableAtSubmit() Disables the job at Submit Time by setting the SubmitDisabled to true.
 - 
getJobDefinitionJobDefinition 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.
 
 - 
getJobChainStepJobChainStep getJobChainStep() Get the JobChainStep.- Returns:
- JobChainStep
- 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.
 
 - 
setJobDefinitionvoid 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.
 
 - 
getJobChainCallInExpressionParametersRWIterable<JobChainCallInExpressionParameter> getJobChainCallInExpressionParameters() Get anRWIterableover an ordered collection ofJobChainCallInExpressionParameters. If the collection is empty, an empty iterator will be returned, that is, this method will never returnnull. The JobChainCall that this JobChainCallParameter belongs to. The LocalJobDefinitionParameter must refer to a JobDefinitionParameter of the JobDefinition that the JobChainCall points to.- Specified by:
- getJobChainCallInExpressionParametersin interface- JobChainCallComp
- Returns:
- An RWIterableover an ordered collection ofJobChainCallInExpressionParameterobjects .
 
 - 
createJobChainCallInExpressionParameterJobChainCallInExpressionParameter createJobChainCallInExpressionParameter() Create a newJobChainCallInExpressionParameterlinked to this object.- Returns:
- a new JobChainCallInExpressionParameter.
 
 - 
getJobChainCallInExpressionParameterByLocalJobDefinitionParameterJobChainCallInExpressionParameter getJobChainCallInExpressionParameterByLocalJobDefinitionParameter(JobDefinitionParameter localJobDefinitionParameter) Get the JobChainCallInExpressionParameter by DestinationJobDefinitionParameter.- Parameters:
- localJobDefinitionParameter-
- Returns:
- the JobChainCallInExpressionParameter, or nullif it could not be found
 
 - 
getJobChainCallInReferenceParametersRWIterable<JobChainCallInReferenceParameter> getJobChainCallInReferenceParameters() Get anRWIterableover an ordered collection ofJobChainCallInReferenceParameters. If the collection is empty, an empty iterator will be returned, that is, this method will never returnnull. The JobChainCall that this JobChainCallParameter belongs to. The LocalJobDefinitionParameter must refer to a JobDefinitionParameter of the JobDefinition that the JobChainCall points to.- Specified by:
- getJobChainCallInReferenceParametersin interface- JobChainCallComp
- Returns:
- An RWIterableover an ordered collection ofJobChainCallInReferenceParameterobjects .
 
 - 
createJobChainCallInReferenceParameterJobChainCallInReferenceParameter createJobChainCallInReferenceParameter() Create a newJobChainCallInReferenceParameterlinked to this object.- Returns:
- a new JobChainCallInReferenceParameter.
 
 - 
getJobChainCallInReferenceParameterByLocalJobDefinitionParameterJobChainCallInReferenceParameter getJobChainCallInReferenceParameterByLocalJobDefinitionParameter(JobDefinitionParameter localJobDefinitionParameter) Get the JobChainCallInReferenceParameter by DestinationJobDefinitionParameter.- Parameters:
- localJobDefinitionParameter-
- Returns:
- the JobChainCallInReferenceParameter, or nullif it could not be found
 
 - 
getJobChainCallOutReferenceParametersRWIterable<JobChainCallOutReferenceParameter> getJobChainCallOutReferenceParameters() Get anRWIterableover an ordered collection ofJobChainCallOutReferenceParameters. If the collection is empty, an empty iterator will be returned, that is, this method will never returnnull. The JobChainCall that this JobChainCallParameter belongs to. The LocalJobDefinitionParameter must refer to a JobDefinitionParameter of the JobDefinition that the JobChainCall points to.- Specified by:
- getJobChainCallOutReferenceParametersin interface- JobChainCallComp
- Returns:
- An RWIterableover an ordered collection ofJobChainCallOutReferenceParameterobjects .
 
 - 
createJobChainCallOutReferenceParameterJobChainCallOutReferenceParameter createJobChainCallOutReferenceParameter() Create a newJobChainCallOutReferenceParameterlinked to this object.- Returns:
- a new JobChainCallOutReferenceParameter.
 
 - 
getJobChainCallPreconditionJobChainCallPrecondition getJobChainCallPrecondition() Get the JobChainCallPrecondition. The precondition for a job chain call.- Returns:
- nullJobChainCallPrecondition
- 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.
 
 - 
createJobChainCallPreconditionJobChainCallPrecondition createJobChainCallPrecondition() Create a newJobChainCallPreconditionlinked to this object.- Returns:
- a new JobChainCallPrecondition.
 
 - 
getJobChainCallRaiseEventsRWIterable<JobChainCallRaiseEvent> getJobChainCallRaiseEvents() Get anRWIterableover an ordered collection ofJobChainCallRaiseEvents. If the collection is empty, an empty iterator will be returned, that is, this method will never returnnull. Predefined list of events that a job will raise when it reaches a particular status.- Specified by:
- getJobChainCallRaiseEventsin interface- JobChainCallComp
- Returns:
- An RWIterableover an ordered collection ofJobChainCallRaiseEventobjects .
 
 - 
createJobChainCallRaiseEventJobChainCallRaiseEvent createJobChainCallRaiseEvent() Create a newJobChainCallRaiseEventlinked to this object.- Returns:
- a new JobChainCallRaiseEvent.
 
 - 
getJobChainCallSchedulingParametersRWIterable<JobChainCallSchedulingParameter> getJobChainCallSchedulingParameters() Get anRWIterableover a collection ofJobChainCallSchedulingParameters, the collection will be ordered by UniqueId. If the collection is empty, an empty iterator will be returned, that is, this method will never returnnull. Scheduler parameters that will apply for jobs scheduled by this call.- Specified by:
- getJobChainCallSchedulingParametersin interface- JobChainCallComp
- Returns:
- An RWIterableover a collection ofJobChainCallSchedulingParameterobjects , the collection will be ordered by UniqueId.
 
 - 
createJobChainCallSchedulingParameterJobChainCallSchedulingParameter createJobChainCallSchedulingParameter() Create a newJobChainCallSchedulingParameterlinked to this object.- Returns:
- a new JobChainCallSchedulingParameter.
 
 - 
getJobChainCallSchedulingParameterByNameJobChainCallSchedulingParameter getJobChainCallSchedulingParameterByName(SchedulingParameterName name) Get the JobChainCallSchedulingParameter by NameJobChainCall.- Parameters:
- name-
- Returns:
- the JobChainCallSchedulingParameter, or nullif it could not be found
 
 - 
getJobChainCallWaitEventsRWIterable<JobChainCallWaitEvent> getJobChainCallWaitEvents() Get anRWIterableover an ordered collection ofJobChainCallWaitEvents. If the collection is empty, an empty iterator will be returned, that is, this method will never returnnull. Predefined list of events that a job chain call will wait for before executing- Specified by:
- getJobChainCallWaitEventsin interface- JobChainCallComp
- Returns:
- An RWIterableover an ordered collection ofJobChainCallWaitEventobjects .
 
 - 
createJobChainCallWaitEventJobChainCallWaitEvent createJobChainCallWaitEvent() Create a newJobChainCallWaitEventlinked to this object.- Returns:
- a new JobChainCallWaitEvent.
 
 - 
getJobChainCallJobLocksRWIterable<JobChainCallJobLock> getJobChainCallJobLocks() Get anRWIterableover an ordered collection ofJobChainCallJobLocks. If the collection is empty, an empty iterator will be returned, that is, this method will never returnnull. Predefined list of locks that a job needs to acquire before executing- Specified by:
- getJobChainCallJobLocksin interface- JobChainCallComp
- Returns:
- An RWIterableover an ordered collection ofJobChainCallJobLockobjects .
 
 - 
createJobChainCallJobLockJobChainCallJobLock createJobChainCallJobLock(JobLock newJobLock) Create a newJobChainCallJobLocklinked to this object.- Parameters:
- newJobLock- The other parent of the- JobChainCallJobLockJobLockassociation.
- Returns:
- a new JobChainCallJobLock.
 
 - 
getJobChainCallJobLockByJobLockJobChainCallJobLock getJobChainCallJobLockByJobLock(JobLock jobLock) Get the JobChainCallJobLock by JobChainCallJobLock.- Parameters:
- jobLock-
- Returns:
- the JobChainCallJobLock, or nullif it could not be found
 
 - 
getJobChainCallProcessMonitorUpdatersRWIterable<JobChainCallProcessMonitorUpdater> getJobChainCallProcessMonitorUpdaters() Get anRWIterableover an ordered collection ofJobChainCallProcessMonitorUpdaters. If the collection is empty, an empty iterator will be returned, that is, this method will never returnnull. The ProcessMonitorUpdaters for a JobDefinition- Specified by:
- getJobChainCallProcessMonitorUpdatersin interface- JobChainCallComp
- Returns:
- An RWIterableover an ordered collection ofJobChainCallProcessMonitorUpdaterobjects .
 
 - 
createJobChainCallProcessMonitorUpdaterJobChainCallProcessMonitorUpdater createJobChainCallProcessMonitorUpdater() Create a newJobChainCallProcessMonitorUpdaterlinked to this object.- Returns:
- a new JobChainCallProcessMonitorUpdater.
 
 
- 
 
-