Package com.redwood.scheduler.api.model

Interface JobDatum

All Superinterfaces:

Association, Readable, SchedulerEntity, SchedulerEntityComp

public interface JobDatum
extends Association, Readable

The Metadata associated with a Job. Each item is described by a MetaMetaData, and is attached to a Job.

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "JobDatum" 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<JobDatum>	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
DatumDefinition	getDatumDefinition()	Get the DatumDefinition.
Job	getJob()	Get the Job.
String	getValue()	Get the value for Value.
DateTimeZone	getValueDateTimeZone()	Get the value for ValueDateTimeZone.
BigDecimal	getValueNumber()	Get the value for ValueNumber.
TimeZone	getValueTimeZone()	Get the ValueTimeZone.
void	setValue(String newValue)	Set the value for Value.
void	setValueDateTimeZone(DateTimeZone newValueDateTimeZone)	Set the value for ValueDateTimeZone.
void	setValueNumber(BigDecimal newValueNumber)	Set the value for ValueNumber.
void	setValueTimeZone(TimeZone newValueTimeZone)	Set the value for ValueTimeZone.

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

See Also:

Constant Field Values

TYPE

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

getValue

String getValue()

Get the value for Value. (The value of this MetaDatum. The type of the MetaDatum can be found by looking at getMetaMetaData()) 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.

getValueNumber

BigDecimal getValueNumber()

Get the value for ValueNumber. (The value of this MetaDatum. The type of the MetaDatum can be found by looking at getMetaMetaData())

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.

getValueDateTimeZone

DateTimeZone getValueDateTimeZone()

Get the value for ValueDateTimeZone. (The value of this MetaDatum. The type of the MetaDatum can be found by looking at getMetaMetaData())

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.

setValue

void setValue(String newValue)

Set the value for Value. (The value of this MetaDatum. The type of the MetaDatum can be found by looking at getMetaMetaData()) This value is mandatory.

Parameters:

newValue - the new value for Value. 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.

setValueNumber

void setValueNumber(BigDecimal newValueNumber)

Set the value for ValueNumber. (The value of this MetaDatum. The type of the MetaDatum can be found by looking at getMetaMetaData()) This value is optional.

Parameters:

newValueNumber - the new value for ValueNumber.

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.

setValueDateTimeZone

void setValueDateTimeZone(DateTimeZone newValueDateTimeZone)

Set the value for ValueDateTimeZone. (The value of this MetaDatum. The type of the MetaDatum can be found by looking at getMetaMetaData()) This value is optional.

Parameters:

newValueDateTimeZone - the new value for ValueDateTimeZone.

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.

getJob

Job getJob()

Get the Job.

Returns:

Job

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.

getDatumDefinition

DatumDefinition getDatumDefinition()

Get the DatumDefinition.

Returns:

DatumDefinition

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.

getValueTimeZone

TimeZone getValueTimeZone()

Get the ValueTimeZone.

Returns:

ValueTimeZone

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.

setValueTimeZone

void setValueTimeZone(TimeZone newValueTimeZone)

Set the value for ValueTimeZone. This value is optional.

Parameters:

newValueTimeZone - is the object to set ValueTimeZone to. The time zone of this job datum's date value.