Package com.redwood.scheduler.api.model

Interface ProcessMonitor

All Superinterfaces:

BusinessKeyObject, NamedRootObject, NamedRootObjectComp, PartitionableObject, PartitionableObjectComp, ProcessMonitorComp, Readable, Root, SchedulerEntity, SchedulerEntityComp

public interface ProcessMonitor
extends ProcessMonitorComp, PartitionableObject, BusinessKeyObject, Readable

The Process Monitor for high-level process automation.

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "ProcessMonitor" objects.
static String	SEC_PRIV_CREATE	This privilege can be granted at a group level.
static String	SEC_PRIV_DELETE	This privilege can be granted at a group level.
static String	SEC_PRIV_EDIT	This privilege can be granted at a group level.
static String	SEC_PRIV_VIEW	This privilege can be granted at a group level.
static String	SEC_RANK_ALL	This rank is made of the following privileges: create , view , edit , delete
static String	SEC_RANK_CREATE	This rank is made of the following privileges: create
static String	SEC_RANK_DELETE	This rank is made of the following privileges: create , view , delete
static String	SEC_RANK_EDIT	This rank is made of the following privileges: create , view , edit
static String	SEC_RANK_NONE	This rank has no privileges assigned to it.
static String	SEC_RANK_VIEW	This rank is made of the following privileges: view
static QueryObjectType<ProcessMonitor>	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
RequiredPermission	checkCreatePrivilege()	Check whether or not the create action can be performed on this object.
RequiredPermission	checkDeletePrivilege()	Check whether or not the delete action can be performed on this object.
RequiredPermission	checkEditPrivilege()	Check whether or not the edit action can be performed on this object.
RequiredPermission	checkViewPrivilege()	Check whether or not the view action can be performed on this object.
ProcessMonitorItem	createProcessMonitorItem()	Create a new ProcessMonitorItem linked to this object.
String	getInstance()	Get the value for Instance.
Long	getItemCount()	Get total number of Process Monitor Items.
Long	getMaxDisplayOrder()	Get all the maximum display order of the process monitor items.
ProcessMonitorItem	getProcessMonitorItemByName(String name)	Get the ProcessMonitorItem by UniqueProcessMonitorItem.
RWIterable<ProcessMonitorItem>	getProcessMonitorItems()	Get an RWIterable over an ordered collection of ProcessMonitorItems.
RWIterable<ProcessMonitorItem>	getProcessMonitorItemsByDisplayOrder()	Get all the process monitor items sorted by display order.
void	setInstance(String newInstance)	Set the value for Instance.

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

getBusinessKey

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

createObjectReference, getComment, getDescription, getLinkedObjectReferenceByLinkedObject, getLinkedObjectReferenceByName, getLinkedObjectReferences, getName, getSearchName, getSourceObjectReferences, isHidden, setComment, setDescription, setName

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

createObjectTag, getEditablePartitions, getObjectTagByObjectTagDefinition, getObjectTags, getPartition, setPartition

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

getCreationTime, getLastModificationTime, getLastModifierSubject

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

See Also:

Constant Field Values

TYPE

static final QueryObjectType<ProcessMonitor> TYPE

Type that can be used in SchedulerSession.executeObjectQuery(QueryObjectType, String, Object...).

SEC_PRIV_CREATE

static final String SEC_PRIV_CREATE

This privilege can be granted at a group level.

See Also:

Constant Field Values

SEC_PRIV_VIEW

static final String SEC_PRIV_VIEW

This privilege can be granted at a group level. This privilege can be granted at an instance level.

See Also:

Constant Field Values

SEC_PRIV_EDIT

static final String SEC_PRIV_EDIT

This privilege can be granted at a group level. This privilege can be granted at an instance level.

See Also:

Constant Field Values

SEC_PRIV_DELETE

static final String SEC_PRIV_DELETE

This privilege can be granted at a group level. This privilege can be granted at an instance level.

See Also:

Constant Field Values

SEC_RANK_NONE

static final String SEC_RANK_NONE

This rank has no privileges assigned to it.

See Also:

Constant Field Values

SEC_RANK_CREATE

static final String SEC_RANK_CREATE

This rank is made of the following privileges: create

See Also:

Constant Field Values

SEC_RANK_VIEW

static final String SEC_RANK_VIEW

This rank is made of the following privileges: view

See Also:

Constant Field Values

SEC_RANK_EDIT

static final String SEC_RANK_EDIT

This rank is made of the following privileges: create , view , edit

See Also:

Constant Field Values

SEC_RANK_DELETE

static final String SEC_RANK_DELETE

This rank is made of the following privileges: create , view , delete

See Also:

Constant Field Values

SEC_RANK_ALL

static final String SEC_RANK_ALL

This rank is made of the following privileges: create , view , edit , delete

See Also:

Constant Field Values

Method Detail

getInstance

String getInstance()

Get the value for Instance. (The instance id of the ProcessMonitor) 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.

setInstance

void setInstance(String newInstance)

Set the value for Instance. (The instance id of the ProcessMonitor) This value is mandatory.

Parameters:

newInstance - the new value for Instance. 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.

getProcessMonitorItemsByDisplayOrder

RWIterable<ProcessMonitorItem> getProcessMonitorItemsByDisplayOrder()

Get all the process monitor items sorted by display order.

Specified by:

getProcessMonitorItemsByDisplayOrder in interface ProcessMonitorComp

Returns:

An iterator of ProcessMonitorItems

getMaxDisplayOrder

Long getMaxDisplayOrder()
                 throws com.redwood.scheduler.api.exception.SchedulerAPIPersistenceException

Get all the maximum display order of the process monitor items.

Returns:

An maxium display order

Throws:

com.redwood.scheduler.api.exception.SchedulerAPIPersistenceException - Unable to persist.

getItemCount

Long getItemCount()
           throws com.redwood.scheduler.api.exception.SchedulerAPIPersistenceException

Get total number of Process Monitor Items.

Returns:

The count of the items

Throws:

com.redwood.scheduler.api.exception.SchedulerAPIPersistenceException - Unable to persist.

getProcessMonitorItems

RWIterable<ProcessMonitorItem> getProcessMonitorItems()

Get an RWIterable over an ordered collection of ProcessMonitorItems. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. The items for a ProcessMonitor

Specified by:

getProcessMonitorItems in interface ProcessMonitorComp

Returns:

An RWIterable over an ordered collection of ProcessMonitorItem objects .

createProcessMonitorItem

ProcessMonitorItem createProcessMonitorItem()

Create a new ProcessMonitorItem linked to this object.

Returns:

a new ProcessMonitorItem.

getProcessMonitorItemByName

ProcessMonitorItem getProcessMonitorItemByName(String name)

Get the ProcessMonitorItem by UniqueProcessMonitorItem.

Parameters:

name -

Returns:

the ProcessMonitorItem, or null if it could not be found

checkCreatePrivilege

RequiredPermission checkCreatePrivilege()

Check whether or not the create action can be performed on this object.

Returns:

a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.

checkViewPrivilege

RequiredPermission checkViewPrivilege()

Check whether or not the view action can be performed on this object.

Returns:

a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.

checkEditPrivilege

RequiredPermission checkEditPrivilege()

Check whether or not the edit action can be performed on this object.

Returns:

a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.

checkDeletePrivilege

RequiredPermission checkDeletePrivilege()

Check whether or not the delete action can be performed on this object.

Returns:

a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.