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 fromSchedulerEntity.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 inSchedulerSession.executeObjectQuery(QueryObjectType, String, Object...)
.-
Fields inherited from interface com.redwood.scheduler.api.model.SchedulerEntity
ACTION_AUDIT, ACTION_EXPORT, ACTION_READ, BEHAVIOR_DEPRECATED, BEHAVIOR_NONE, BEHAVIOR_SYSTEM
-
-
Method Summary
-
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 fromSchedulerEntity.getObjectType()
for "JobChainCall" objects.- See Also:
- Constant Field Values
-
TYPE
static final QueryObjectType<JobChainCall> TYPE
Type that can be used inSchedulerSession.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 benull
if 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.
-
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 benull
if 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.
-
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 benull
if 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.
-
getDescription
String 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.
-
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 benull
if 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.
-
getSequenceNumber
Long getSequenceNumber()
Get the value for SequenceNumber. (The call sequence number.) This value is mandatory, and therefore will not benull
if 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.
-
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 benull
if 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.
-
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 benull
if 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.
-
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:
com.redwood.scheduler.api.exception.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:
com.redwood.scheduler.api.exception.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:
com.redwood.scheduler.api.exception.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 isnull
, 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.
-
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:
com.redwood.scheduler.api.exception.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:
com.redwood.scheduler.api.exception.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:
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.
-
getJobChainStep
JobChainStep 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.
-
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 isnull
, then the object cannot be persisted.
-
getJobChainCallInExpressionParameters
RWIterable<JobChainCallInExpressionParameter> getJobChainCallInExpressionParameters()
Get anRWIterable
over 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:
getJobChainCallInExpressionParameters
in interfaceJobChainCallComp
- Returns:
- An
RWIterable
over an ordered collection ofJobChainCallInExpressionParameter
objects .
-
createJobChainCallInExpressionParameter
JobChainCallInExpressionParameter createJobChainCallInExpressionParameter()
Create a newJobChainCallInExpressionParameter
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 anRWIterable
over 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:
getJobChainCallInReferenceParameters
in interfaceJobChainCallComp
- Returns:
- An
RWIterable
over an ordered collection ofJobChainCallInReferenceParameter
objects .
-
createJobChainCallInReferenceParameter
JobChainCallInReferenceParameter createJobChainCallInReferenceParameter()
Create a newJobChainCallInReferenceParameter
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 anRWIterable
over 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:
getJobChainCallOutReferenceParameters
in interfaceJobChainCallComp
- Returns:
- An
RWIterable
over an ordered collection ofJobChainCallOutReferenceParameter
objects .
-
createJobChainCallOutReferenceParameter
JobChainCallOutReferenceParameter createJobChainCallOutReferenceParameter()
Create a newJobChainCallOutReferenceParameter
linked to this object.- Returns:
- a new
JobChainCallOutReferenceParameter
.
-
getJobChainCallPrecondition
JobChainCallPrecondition 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.
-
createJobChainCallPrecondition
JobChainCallPrecondition createJobChainCallPrecondition()
Create a newJobChainCallPrecondition
linked to this object.- Returns:
- a new
JobChainCallPrecondition
.
-
getJobChainCallRaiseEvents
RWIterable<JobChainCallRaiseEvent> getJobChainCallRaiseEvents()
Get anRWIterable
over 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:
getJobChainCallRaiseEvents
in interfaceJobChainCallComp
- Returns:
- An
RWIterable
over an ordered collection ofJobChainCallRaiseEvent
objects .
-
createJobChainCallRaiseEvent
JobChainCallRaiseEvent createJobChainCallRaiseEvent()
Create a newJobChainCallRaiseEvent
linked to this object.- Returns:
- a new
JobChainCallRaiseEvent
.
-
getJobChainCallSchedulingParameters
RWIterable<JobChainCallSchedulingParameter> getJobChainCallSchedulingParameters()
Get anRWIterable
over 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:
getJobChainCallSchedulingParameters
in interfaceJobChainCallComp
- Returns:
- An
RWIterable
over a collection ofJobChainCallSchedulingParameter
objects , the collection will be ordered by UniqueId.
-
createJobChainCallSchedulingParameter
JobChainCallSchedulingParameter createJobChainCallSchedulingParameter()
Create a newJobChainCallSchedulingParameter
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 anRWIterable
over 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:
getJobChainCallWaitEvents
in interfaceJobChainCallComp
- Returns:
- An
RWIterable
over an ordered collection ofJobChainCallWaitEvent
objects .
-
createJobChainCallWaitEvent
JobChainCallWaitEvent createJobChainCallWaitEvent()
Create a newJobChainCallWaitEvent
linked to this object.- Returns:
- a new
JobChainCallWaitEvent
.
-
getJobChainCallJobLocks
RWIterable<JobChainCallJobLock> getJobChainCallJobLocks()
Get anRWIterable
over 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:
getJobChainCallJobLocks
in interfaceJobChainCallComp
- Returns:
- An
RWIterable
over an ordered collection ofJobChainCallJobLock
objects .
-
createJobChainCallJobLock
JobChainCallJobLock createJobChainCallJobLock(JobLock newJobLock)
Create a newJobChainCallJobLock
linked to this object.- Parameters:
newJobLock
- The other parent of theJobChainCallJobLockJobLock
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 anRWIterable
over 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:
getJobChainCallProcessMonitorUpdaters
in interfaceJobChainCallComp
- Returns:
- An
RWIterable
over an ordered collection ofJobChainCallProcessMonitorUpdater
objects .
-
createJobChainCallProcessMonitorUpdater
JobChainCallProcessMonitorUpdater createJobChainCallProcessMonitorUpdater()
Create a newJobChainCallProcessMonitorUpdater
linked to this object.- Returns:
- a new
JobChainCallProcessMonitorUpdater
.
-
-