Package com.redwood.scheduler.api.model

Interface JobChainStep

All Superinterfaces:

BusinessKeyObject, Detail, JobChainStepComp, NamedDetailObject, Readable, SchedulerEntity, SchedulerEntityComp

public interface JobChainStep
extends JobChainStepComp, NamedDetailObject, BusinessKeyObject, Readable

Job chain step definitions hold a number of job chain calls to be executed in parallel. Represents the definition of a job chain step

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "JobChainStep" 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<JobChainStep>	TYPE	Type that can be used in SchedulerSession.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

Modifier and Type	Method	Description
JobChainCall	createJobChainCall()	Create a new JobChainCall linked to this object.
JobChainStepPrecondition	createJobChainStepPrecondition()	Create a new JobChainStepPrecondition linked to this object.
JobChainStepStatusHandler	createJobChainStepStatusHandler()	Create a new JobChainStepStatusHandler linked to this object.
JobChain	getJobChain()	Get the JobChain.
JobChainCall	getJobChainCallBySequenceNumber(Long sequenceNumber)	Get the JobChainCall by SequenceNumber.
RWIterable<JobChainCall>	getJobChainCalls()	Get an RWIterable over a collection of JobChainCalls, the collection will be ordered by SequenceNumber.
JobChainStepPrecondition	getJobChainStepPrecondition()	Get the JobChainStepPrecondition.
JobChainStepStatusHandler	getJobChainStepStatusHandlerByStatus(JobStatus status)	Get the JobChainStepStatusHandler by JobChainStepStatusHandler.
RWIterable<JobChainStepStatusHandler>	getJobChainStepStatusHandlers()	Get an RWIterable over a collection of JobChainStepStatusHandlers, the collection will be ordered by SequenceNumber.
Long	getRestartCount()	Get the value for RestartCount.
Long	getRestartDelayAmount()	Get the value for RestartDelayAmount.
TimeUnit	getRestartDelayUnits()	Get the value for RestartDelayUnits.
Long	getSequenceNumber()	Get the value for SequenceNumber.
void	setRestartCount(Long newRestartCount)	Set the value for RestartCount.
void	setRestartDelayAmount(Long newRestartDelayAmount)	Set the value for RestartDelayAmount.
void	setRestartDelayUnits(TimeUnit newRestartDelayUnits)	Set the value for RestartDelayUnits.
void	setSequenceNumber(Long newSequenceNumber)	Set the value for SequenceNumber.

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

getBusinessKey

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

getComment, getDescription, getName, getSearchName, setComment, setDescription, setName

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 "JobChainStep" objects.

See Also:

Constant Field Values

TYPE

static final QueryObjectType<JobChainStep> 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

getRestartCount

Long getRestartCount()

Get the value for RestartCount. (Maximum number of automatic restarts)

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.

getRestartDelayAmount

Long getRestartDelayAmount()

Get the value for RestartDelayAmount. (Number of 'restart delay time units' after the finish time of the original step to submit the restart at.) This value is mandatory, and therefore will not be null 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.

getRestartDelayUnits

TimeUnit getRestartDelayUnits()

Get the value for RestartDelayUnits. (Time units for 'restart delay amount' - seconds, minutes, hours, days. May not be null, defaults to minutes) This value is mandatory, and therefore will not be null 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 step 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:

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

setRestartCount

void setRestartCount(Long newRestartCount)

Set the value for RestartCount. (Maximum number of automatic restarts) This value is optional.

Parameters:

newRestartCount - the new value for RestartCount.

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.

setRestartDelayAmount

void setRestartDelayAmount(Long newRestartDelayAmount)

Set the value for RestartDelayAmount. (Number of 'restart delay time units' after the finish time of the original step to submit the restart at.) This value is mandatory.

Parameters:

newRestartDelayAmount - the new value for RestartDelayAmount. 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.

setRestartDelayUnits

void setRestartDelayUnits(TimeUnit newRestartDelayUnits)

Set the value for RestartDelayUnits. (Time units for 'restart delay amount' - seconds, minutes, hours, days. May not be null, defaults to minutes) This value is mandatory.

Parameters:

newRestartDelayUnits - the new value for RestartDelayUnits. 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.

setSequenceNumber

void setSequenceNumber(Long newSequenceNumber)

Set the value for SequenceNumber. (The step 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.

getJobChain

JobChain getJobChain()

Get the JobChain.

Returns:

JobChain

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.

getJobChainCalls

RWIterable<JobChainCall> getJobChainCalls()

Get an RWIterable over a collection of JobChainCalls, the collection will be ordered by SequenceNumber. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. The calls performed in parallel in a job chain step

Specified by:

getJobChainCalls in interface JobChainStepComp

Returns:

An RWIterable over a collection of JobChainCall objects , the collection will be ordered by SequenceNumber.

createJobChainCall

JobChainCall createJobChainCall()

Create a new JobChainCall linked to this object.

Returns:

a new JobChainCall.

getJobChainCallBySequenceNumber

JobChainCall getJobChainCallBySequenceNumber(Long sequenceNumber)

Get the JobChainCall by SequenceNumber.

Parameters:

sequenceNumber -

Returns:

the JobChainCall, or null if it could not be found

getJobChainStepPrecondition

JobChainStepPrecondition getJobChainStepPrecondition()

Get the JobChainStepPrecondition. Condition that defines whether the step should be executed or skipped.

Returns:

nullJobChainStepPrecondition

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.

createJobChainStepPrecondition

JobChainStepPrecondition createJobChainStepPrecondition()

Create a new JobChainStepPrecondition linked to this object.

Returns:

a new JobChainStepPrecondition.

getJobChainStepStatusHandlers

RWIterable<JobChainStepStatusHandler> getJobChainStepStatusHandlers()

Get an RWIterable over a collection of JobChainStepStatusHandlers, the collection will be ordered by SequenceNumber. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. Check that defines behavior after the step is finished

Specified by:

getJobChainStepStatusHandlers in interface JobChainStepComp

Returns:

An RWIterable over a collection of JobChainStepStatusHandler objects , the collection will be ordered by SequenceNumber.

createJobChainStepStatusHandler

JobChainStepStatusHandler createJobChainStepStatusHandler()

Create a new JobChainStepStatusHandler linked to this object.

Returns:

a new JobChainStepStatusHandler.

getJobChainStepStatusHandlerByStatus

JobChainStepStatusHandler getJobChainStepStatusHandlerByStatus(JobStatus status)

Get the JobChainStepStatusHandler by JobChainStepStatusHandler.

Parameters:

status -

Returns:

the JobChainStepStatusHandler, or null if it could not be found