Package com.redwood.scheduler.api.model

Interface JobChainCallOutReferenceParameter

All Superinterfaces:

Detail, JobChainCallOutParameter, JobChainCallParameter, Readable, SchedulerEntity, SchedulerEntityComp

public interface JobChainCallOutReferenceParameter
extends JobChainCallOutParameter, Readable

Maps an output value from the JobDefinition to an output value for the chain. Maps an output value from the JobDefinition to an output value for the chain.

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "JobChainCallOutReferenceParameter" 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<JobChainCallOutReferenceParameter>	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
JobDefinitionParameter	getTargetJobDefinitionParameter()	Get the TargetJobDefinitionParameter.
void	setTargetJobDefinitionParameter(JobDefinitionParameter newTargetJobDefinitionParameter)	Set the value for TargetJobDefinitionParameter.

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

setJobParameter

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

See Also:

Constant Field Values

TYPE

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

getTargetJobDefinitionParameter

JobDefinitionParameter getTargetJobDefinitionParameter()

Get the TargetJobDefinitionParameter.

Returns:

TargetJobDefinitionParameter

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.

setTargetJobDefinitionParameter

void setTargetJobDefinitionParameter(JobDefinitionParameter newTargetJobDefinitionParameter)

Set the value for TargetJobDefinitionParameter. This value is mandatory.

Parameters:

newTargetJobDefinitionParameter - is the object to set TargetJobDefinitionParameter to. The JobChains JobDefinitionParameter that this JobChainCallOutParameter will update. This must be associated with this.getJobChainCall().getJobChainStep().getJobChain().getJobDefinition(). If this is null, then the object cannot be persisted.