Package com.redwood.scheduler.api.model

Interface JobChainCallSchedulingParameter

All Superinterfaces:

BusinessKeyObject, Detail, Readable, SchedulerEntity, SchedulerEntityComp

public interface JobChainCallSchedulingParameter
extends Detail, BusinessKeyObject, Readable

Scheduling parameter; used to store a value that should be set on a job before it is submitted.

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "JobChainCallSchedulingParameter" 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<JobChainCallSchedulingParameter>	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
String	getExpression()	Get the value for Expression.
JobChainCall	getJobChainCall()	Get the JobChainCall.
SchedulingParameterName	getName()	Get the value for Name.
Queue	getQueue()	Get the Queue.
TimeWindow	getTimeWindow()	Get the TimeWindow.
void	setExpression(String newExpression)	Set the value for Expression.
void	setName(SchedulingParameterName newName)	Set the value for Name.
void	setQueue(Queue newQueue)	Set the value for Queue.
void	setTimeWindow(TimeWindow newTimeWindow)	Set the value for TimeWindow.

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

See Also:

Constant Field Values

TYPE

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

getName

SchedulingParameterName getName()

Get the value for Name. (The name of the attribute that should be set.) 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.

getExpression

String getExpression()

Get the value for Expression. (Expression to evaluate as the value for this parameter.) 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.

setName

void setName(SchedulingParameterName newName)

Set the value for Name. (The name of the attribute that should be set.) This value is mandatory.

Parameters:

newName - the new value for Name. 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.

setExpression

void setExpression(String newExpression)

Set the value for Expression. (Expression to evaluate as the value for this parameter.) This value is mandatory.

Parameters:

newExpression - the new value for Expression. 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.

getJobChainCall

JobChainCall getJobChainCall()

Get the JobChainCall.

Returns:

JobChainCall

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.

getTimeWindow

TimeWindow getTimeWindow()

Get the TimeWindow.

Returns:

TimeWindow

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.

getQueue

Queue getQueue()

Get the Queue.

Returns:

Queue

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.

setTimeWindow

void setTimeWindow(TimeWindow newTimeWindow)

Set the value for TimeWindow. This value is optional.

Parameters:

newTimeWindow - is the object to set TimeWindow to. The reference to a TimeWindow object.

setQueue

void setQueue(Queue newQueue)

Set the value for Queue. This value is optional.

Parameters:

newQueue - is the object to set Queue to. The reference to a Queue object.