Package com.redwood.scheduler.api.model

Interface ProcessMonitorItemDefinition

All Superinterfaces:

BusinessKeyObject, Detail, NamedDetailObject, Readable, SchedulerEntity, SchedulerEntityComp

public interface ProcessMonitorItemDefinition
extends NamedDetailObject, BusinessKeyObject, Readable

The definition for an item in the Process Monitor.

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "ProcessMonitorItemDefinition" 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<ProcessMonitorItemDefinition>	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
Long	getDisplayOrder()	Get the value for DisplayOrder.
String	getInstanceExpression()	Get the value for InstanceExpression.
ProcessMonitorDefinition	getProcessMonitorDefinition()	Get the ProcessMonitorDefinition.
ProcessMonitorDefinition	getSubProcessMonitorDefinition()	Get the SubProcessMonitorDefinition.
ProcessMonitorItemType	getType()	Get the value for Type.
void	setDisplayOrder(Long newDisplayOrder)	Set the value for DisplayOrder.
void	setInstanceExpression(String newInstanceExpression)	Set the value for InstanceExpression.
void	setSubProcessMonitorDefinition(ProcessMonitorDefinition newSubProcessMonitorDefinition)	Set the value for SubProcessMonitorDefinition.
void	setType(ProcessMonitorItemType newType)	Set the value for Type.

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

See Also:

Constant Field Values

TYPE

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

getDisplayOrder

Long getDisplayOrder()

Get the value for DisplayOrder. (The display order of the item) 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.

getType

ProcessMonitorItemType getType()

Get the value for Type. (The type of the Item) 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.

getInstanceExpression

String getInstanceExpression()

Get the value for InstanceExpression. (The optional expression for calculating the instance number of a referenced ProcessMonitor)

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.

setDisplayOrder

void setDisplayOrder(Long newDisplayOrder)

Set the value for DisplayOrder. (The display order of the item) This value is mandatory.

Parameters:

newDisplayOrder - the new value for DisplayOrder. 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.

setType

void setType(ProcessMonitorItemType newType)

Set the value for Type. (The type of the Item) 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.

setInstanceExpression

void setInstanceExpression(String newInstanceExpression)

Set the value for InstanceExpression. (The optional expression for calculating the instance number of a referenced ProcessMonitor) This value is optional.

Parameters:

newInstanceExpression - the new value for InstanceExpression.

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.

getProcessMonitorDefinition

ProcessMonitorDefinition getProcessMonitorDefinition()

Get the ProcessMonitorDefinition.

Returns:

ProcessMonitorDefinition

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.

getSubProcessMonitorDefinition

ProcessMonitorDefinition getSubProcessMonitorDefinition()

Get the SubProcessMonitorDefinition.

Returns:

SubProcessMonitorDefinition

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.

setSubProcessMonitorDefinition

void setSubProcessMonitorDefinition(ProcessMonitorDefinition newSubProcessMonitorDefinition)

Set the value for SubProcessMonitorDefinition. This value is optional.

Parameters:

newSubProcessMonitorDefinition - is the object to set SubProcessMonitorDefinition to. The sub process monitor definition of this item