Package com.redwood.scheduler.api.model

Interface JobChainCallInReferenceParameter

All Superinterfaces:

Detail, JobChainCallInParameter, JobChainCallParameter, Readable, SchedulerEntity, SchedulerEntityComp

public interface JobChainCallInReferenceParameter
extends JobChainCallInParameter, Readable

Maps an output value from a job in a previous step, or an input value from the job chain to an IN parameter for the JobDefinition. Maps an output value from a previous step, or an input value from the chain to an IN parameter for the JobDefinition.

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "JobChainCallInReferenceParameter" 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<JobChainCallInReferenceParameter>	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	getSourceJobChainCall()	Get the SourceJobChainCall.
JobDefinitionParameter	getSourceJobDefinitionParameter()	Get the SourceJobDefinitionParameter.
void	setSourceJobChainCall(JobChainCall newSourceJobChainCall)	Set the value for SourceJobChainCall.
void	setSourceJobDefinitionParameter(JobDefinitionParameter newSourceJobDefinitionParameter)	Set the value for SourceJobDefinitionParameter.

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

getJobChainCall, getLocalJobDefinitionParameter, setLocalJobDefinitionParameter

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

See Also:

Constant Field Values

TYPE

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

getSourceJobChainCall

JobChainCall getSourceJobChainCall()

Get the SourceJobChainCall.

Returns:

SourceJobChainCall

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.

getSourceJobDefinitionParameter

JobDefinitionParameter getSourceJobDefinitionParameter()

Get the SourceJobDefinitionParameter.

Returns:

SourceJobDefinitionParameter

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.

setSourceJobChainCall

void setSourceJobChainCall(JobChainCall newSourceJobChainCall)

Set the value for SourceJobChainCall. This value is optional.

Parameters:

newSourceJobChainCall - is the object to set SourceJobChainCall to. The JobChainCall that this JobChainCallInReferenceParameter will read the results from, the specific parameter is determined by getSourceJobDefinitionParameter().

setSourceJobDefinitionParameter

void setSourceJobDefinitionParameter(JobDefinitionParameter newSourceJobDefinitionParameter)

Set the value for SourceJobDefinitionParameter. This value is mandatory.

Parameters:

newSourceJobDefinitionParameter - is the object to set SourceJobDefinitionParameter to. The JobDefinitionParameter that this JobChainCallInReferenceParameter will read the results of. It must be associated with the this.getSourceJobChainCall().getJobDefinition() or with this.getJobChain(). If this is null, then the object cannot be persisted.