Package com.redwood.scheduler.api.model

Interface JobGroupParameter

All Superinterfaces:

Association, Readable, SchedulerEntity, SchedulerEntityComp

public interface JobGroupParameter
extends Association, Readable

Parameter for a job group. Input and output parameters are used to pass data to and from a job. Note that when the value of an INOUT parameter is set, the out-value is also set to the same value. The value of an IN or INOUT parameter can be changed at any stage up until its job enters the Executing state.

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "JobGroupParameter" 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<JobGroupParameter>	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
Object	getInValue()	Get the value for InValue.
DateTimeZone	getInValueDate()	Get the value for InValueDate.
BigDecimal	getInValueNumber()	Get the value for InValueNumber.
String	getInValueString()	Get the value for InValueString.
JobGroup	getJobGroup()	Get the JobGroup.
Object	getOutValue()	Get the value for OutValue.
DateTimeZone	getOutValueDate()	Get the value for OutValueDate.
BigDecimal	getOutValueNumber()	Get the value for OutValueNumber.
String	getOutValueString()	Get the value for OutValueString.

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

See Also:

Constant Field Values

TYPE

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

getInValueDate

DateTimeZone getInValueDate()

Get the value for InValueDate. (The date value)

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.

getInValueNumber

BigDecimal getInValueNumber()

Get the value for InValueNumber. (The numeric value)

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.

getInValueString

String getInValueString()

Get the value for InValueString. (The character value)

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.

getInValue

Object getInValue()

Get the value for InValue. ( Effective value of this parameter; the type of the object corresponds to the type in the parameter definition. )

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.

getOutValueDate

DateTimeZone getOutValueDate()

Get the value for OutValueDate. (The date output value)

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.

getOutValueNumber

BigDecimal getOutValueNumber()

Get the value for OutValueNumber. (The numeric output value)

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.

getOutValueString

String getOutValueString()

Get the value for OutValueString. (The character output value)

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.

getOutValue

Object getOutValue()

Get the value for OutValue. ( Effective out-value of this parameter; the type of the object corresponds to the type in the parameter definition. )

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.

getJobGroup

JobGroup getJobGroup()

Get the JobGroup.

Returns:

JobGroup

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.