Package com.redwood.scheduler.api.model

Interface JobChainStepNode

All Superinterfaces:

BusinessKeyObject, Detail, JobChainStepNodeComp, Readable, SchedulerEntity, SchedulerEntityComp

public interface JobChainStepNode
extends JobChainStepNodeComp, Detail, BusinessKeyObject, Readable

A node in the dependency graph of a JobChainStep

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "JobChainStepNode" 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<JobChainStepNode>	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
RWIterable<JobChainStepDependency>	getInJobChainStepDependencies()	Get an RWIterable over an ordered collection of InJobChainStepDependencies.
JobChainCall	getJobChainCall()	Get the JobChainCall.
JobChainStep	getJobChainStep()	Get the JobChainStep.
RWIterable<JobChainStepDependency>	getOutJobChainStepDependencies()	Get an RWIterable over an ordered collection of OutJobChainStepDependencies.
Long	getSequenceNumber()	Get the value for SequenceNumber.
JobChainStepNodeType	getType()	Get the value for Type.
void	setJobChainCall(JobChainCall newJobChainCall)	Set the value for JobChainCall.
void	setSequenceNumber(Long newSequenceNumber)	Set the value for SequenceNumber.
void	setType(JobChainStepNodeType newType)	Set the value for Type.

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

See Also:

Constant Field Values

TYPE

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

getSequenceNumber

Long getSequenceNumber()

Get the value for SequenceNumber. (The node 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.

getType

JobChainStepNodeType getType()

Get the value for Type. (The type of this JobChainStepNode) 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.

setSequenceNumber

void setSequenceNumber(Long newSequenceNumber)

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

setType

void setType(JobChainStepNodeType newType)

Set the value for Type. (The type of this JobChainStepNode) This value is mandatory.

Parameters:

newType - the new value for Type. 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.

getJobChainCall

JobChainCall getJobChainCall()

Get the JobChainCall.

Returns:

JobChainCall

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 its 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 its session.

setJobChainCall

void setJobChainCall(JobChainCall newJobChainCall)

Set the value for JobChainCall. This value is optional.

Parameters:

newJobChainCall - is the object to set JobChainCall to. The JobChainCall represented by this node. Mandatory when the JobChainStepNode.Type is JobChainCall. Must be null otherwise.

getOutJobChainStepDependencies

RWIterable<JobChainStepDependency> getOutJobChainStepDependencies()

Get an RWIterable over an ordered collection of OutJobChainStepDependencies. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. JobChainStep dependency source node.

Specified by:

getOutJobChainStepDependencies in interface JobChainStepNodeComp

Returns:

An RWIterable over an ordered collection of JobChainStepDependency objects .

getInJobChainStepDependencies

RWIterable<JobChainStepDependency> getInJobChainStepDependencies()

Get an RWIterable over an ordered collection of InJobChainStepDependencies. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. JobChainStep dependency target node.

Specified by:

getInJobChainStepDependencies in interface JobChainStepNodeComp

Returns:

An RWIterable over an ordered collection of JobChainStepDependency objects .