Package com.redwood.scheduler.api.model

Interface MonitorValue

All Superinterfaces:

BusinessKeyObject, Detail, NamedDetailObject, Readable, SchedulerEntity, SchedulerEntityComp

public interface MonitorValue
extends NamedDetailObject, BusinessKeyObject, Readable

A monitor value is a numeric, string or timestamp value The monitor value is either derived from the scheduler data model or set by an external system. Monitor conditions can only check on values located in the same monitor node.

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "MonitorValue" 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<MonitorValue>	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
DateTimeZone	getCreationTime()	Get the value for CreationTime.
DateTimeZone	getLastModificationTime()	Get the value for LastModificationTime.
Subject	getLastModifierSubject()	Get the LastModifierSubject.
MonitorCheck	getMonitorCheck()	Get the MonitorCheck.
ObjectFieldDefinition	getObjectFieldDefinition()	Get the ObjectFieldDefinition.
ParameterType	getType()	Get the value for Type.
DateTimeZone	getValueDate()	Get the value for ValueDate.
BigDecimal	getValueNumber()	Get the value for ValueNumber.
String	getValueString()	Get the value for ValueString.
void	setObjectFieldDefinition(ObjectFieldDefinition newObjectFieldDefinition)	Set the value for ObjectFieldDefinition.
void	setType(ParameterType newType)	Set the value for Type.
void	updateValue(Object value)	Used to update the value that is stored.

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

getBusinessKey

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

getComment, getDescription, getName, getSearchName, setComment, setDescription, setName

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

See Also:

Constant Field Values

TYPE

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

getCreationTime

DateTimeZone getCreationTime()

Get the value for CreationTime. (Timestamp that notes when the monitor was created.)

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.

getLastModificationTime

DateTimeZone getLastModificationTime()

Get the value for LastModificationTime. (Timestamp that notes when the object was updated.)

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.

getType

ParameterType getType()

Get the value for Type. (What is the format of the value) 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.

getValueDate

DateTimeZone getValueDate()

Get the value for ValueDate. (The actual date monitor 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.

getValueNumber

BigDecimal getValueNumber()

Get the value for ValueNumber. (The actual numeric monitor 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.

getValueString

String getValueString()

Get the value for ValueString. (The actual string monitor 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.

setType

void setType(ParameterType newType)

Set the value for Type. (What is the format of the value) This value is mandatory.

Parameters:

newType - the new value for Type. 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.

updateValue

void updateValue(Object value)

Used to update the value that is stored.

Parameters:

value - The new value for the monitor

getMonitorCheck

MonitorCheck getMonitorCheck()

Get the MonitorCheck.

Returns:

MonitorCheck

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.

getObjectFieldDefinition

ObjectFieldDefinition getObjectFieldDefinition()

Get the ObjectFieldDefinition.

Returns:

ObjectFieldDefinition

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.

getLastModifierSubject

Subject getLastModifierSubject()

Get the LastModifierSubject.

Returns:

LastModifierSubject

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.

setObjectFieldDefinition

void setObjectFieldDefinition(ObjectFieldDefinition newObjectFieldDefinition)

Set the value for ObjectFieldDefinition. This value is optional.

Parameters:

newObjectFieldDefinition - is the object to set ObjectFieldDefinition to. The object field of this monitor definition.