Package com.redwood.scheduler.api.model

Interface ProcessMonitorDefinition

All Superinterfaces:

ApplicationObject, BusinessKeyObject, NamedRootObject, NamedRootObjectComp, PartitionableObject, PartitionableObjectComp, ProcessMonitorDefinitionComp, Readable, Root, SchedulerEntity, SchedulerEntityComp, UniqueNamedApplicationObject

public interface ProcessMonitorDefinition
extends ProcessMonitorDefinitionComp, UniqueNamedApplicationObject, Readable

The definition for a 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 "ProcessMonitorDefinition" 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<ProcessMonitorDefinition>	TYPE	Type that can be used in SchedulerSession.executeObjectQuery(QueryObjectType, String, Object...).
static com.redwood.scheduler.infrastructure.logging.Versions	VERSION_PROCESSMONITORDEFINITION

Fields inherited from interface com.redwood.scheduler.api.model.ApplicationObject

VERSION_APPLICATIONOBJECT

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

COPYRIGHT_MESSAGE_BKO, ID_BKO

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

VERSION_NAMEDROOTOBJECT

Fields inherited from interface com.redwood.scheduler.api.model.compatibility_14.NamedRootObjectComp

VERSION_NAMEDROOTOBJECTCOMP

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

VERSION_PARTITIONABLEOBJECT

Fields inherited from interface com.redwood.scheduler.api.model.compatibility_14.PartitionableObjectComp

VERSION_PARTITIONABLEOBJECTCOMP

Fields inherited from interface com.redwood.scheduler.api.model.compatibility_14.ProcessMonitorDefinitionComp

VERSION_PROCESSMONITORDEFINITIONCOMP

Fields inherited from interface com.redwood.scheduler.api.model.Readable

COPYRIGHT_MESSAGE_E, ID_E

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

VERSION_ROOT

Fields inherited from interface com.redwood.scheduler.api.model.SchedulerEntity

ACTION_AUDIT, ACTION_EXPORT, ACTION_READ, BEHAVIOR_DEPRECATED, BEHAVIOR_NONE, BEHAVIOR_SYSTEM, VERSION_SCHEDULERENTITY

Fields inherited from interface com.redwood.scheduler.api.model.compatibility_14.SchedulerEntityComp

VERSION_SCHEDULERENTITYCOMP

Fields inherited from interface com.redwood.scheduler.api.model.UniqueNamedApplicationObject

VERSION_UNIQUENAMEDAPPLICATIONOBJECT

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.
ProcessMonitorItemDefinition	createProcessMonitorItemDefinition()	Create a new ProcessMonitorItemDefinition linked to this object.
ProcessMonitorItemDefinition	getProcessMonitorItemDefinitionByDisplayOrder(Long displayOrder)	Get the ProcessMonitorItemDefinition by ProcessMonitorItemOrder.
ProcessMonitorItemDefinition	getProcessMonitorItemDefinitionByName(String name)	Get the ProcessMonitorItemDefinition by UniqueProcessMonitorItem.
RWIterable<ProcessMonitorItemDefinition>	getProcessMonitorItemDefinitions()	Get an RWIterable over a collection of ProcessMonitorItemDefinitions, the collection will be ordered by DisplayOrder.
RWIterable<ProcessMonitorItemDefinition>	getProcessMonitorItemDefinitionsByDisplayOrder()	Get all the process monitor item definitions sorted by display order.

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

getParentApplication, setParentApplication

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

VERSION_PROCESSMONITORDEFINITION

static final com.redwood.scheduler.infrastructure.logging.Versions VERSION_PROCESSMONITORDEFINITION

OBJECT_TYPE

static final String OBJECT_TYPE

String that will be returned from SchedulerEntity.getObjectType() for "ProcessMonitorDefinition" objects.

See Also:

Constant Field Values

TYPE

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

getProcessMonitorItemDefinitionsByDisplayOrder

RWIterable<ProcessMonitorItemDefinition> getProcessMonitorItemDefinitionsByDisplayOrder()

Get all the process monitor item definitions sorted by display order.

Specified by:

getProcessMonitorItemDefinitionsByDisplayOrder in interface ProcessMonitorDefinitionComp

Returns:

An RWIterable of ProcessMonitorItemDefinitions

getProcessMonitorItemDefinitions

RWIterable<ProcessMonitorItemDefinition> getProcessMonitorItemDefinitions()

Get an RWIterable over a collection of ProcessMonitorItemDefinitions, the collection will be ordered by DisplayOrder. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. The item definitions for a ProcessMonitorDefinition

Specified by:

getProcessMonitorItemDefinitions in interface ProcessMonitorDefinitionComp

Returns:

An RWIterable over a collection of ProcessMonitorItemDefinition objects , the collection will be ordered by DisplayOrder.

createProcessMonitorItemDefinition

ProcessMonitorItemDefinition createProcessMonitorItemDefinition()

Create a new ProcessMonitorItemDefinition linked to this object.

Returns:

a new ProcessMonitorItemDefinition.

getProcessMonitorItemDefinitionByName

ProcessMonitorItemDefinition getProcessMonitorItemDefinitionByName(String name)

Get the ProcessMonitorItemDefinition by UniqueProcessMonitorItem.

Parameters:

name -

Returns:

the ProcessMonitorItemDefinition, or null if it could not be found

getProcessMonitorItemDefinitionByDisplayOrder

ProcessMonitorItemDefinition getProcessMonitorItemDefinitionByDisplayOrder(Long displayOrder)

Get the ProcessMonitorItemDefinition by ProcessMonitorItemOrder.

Parameters:

displayOrder -

Returns:

the ProcessMonitorItemDefinition, 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.