Package com.redwood.scheduler.api.model

Interface MonitorNode

All Superinterfaces:

BusinessKeyObject, LinkableMonitor, LinkableMonitorComp, Monitor, MonitorNodeComp, NamedRootObject, NamedRootObjectComp, Readable, Root, SchedulerEntity, SchedulerEntityComp

public interface MonitorNode
extends MonitorNodeComp, LinkableMonitor, Readable

Monitor that can contain sub-nodes

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "MonitorNode" objects.
static String	SEC_PRIV_CONFIRM	This privilege can be granted at a group level.
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 , confirm , 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: view , confirm , create , delete
static String	SEC_RANK_EDIT	This rank is made of the following privileges: view , confirm , create , edit
static String	SEC_RANK_NONE	This rank has no privileges assigned to it.
static String	SEC_RANK_OPERATOR	This rank is made of the following privileges: view , confirm
static String	SEC_RANK_VIEW	This rank is made of the following privileges: view
static QueryObjectType<MonitorNode>	TYPE	Type that can be used in SchedulerSession.executeObjectQuery(QueryObjectType, String, Object...).

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

COPYRIGHT_MESSAGE_BKO, ID_BKO

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

COPYRIGHT_MESSAGE_E, ID_E

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	checkConfirmPrivilege()	Check whether or not the confirm action can be performed on this object.
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.
MonitorCheck	getChildMonitorCheckByName(String name)	Get the MonitorCheck by ParentName.
RWIterable<MonitorCheck>	getChildMonitorChecks()	Get an RWIterable over a collection of ChildMonitorChecks, the collection will be ordered by Name.
MonitorLink	getChildMonitorLinkByName(String name)	Get the MonitorLink by ParentName.
RWIterable<MonitorLink>	getChildMonitorLinks()	Get an RWIterable over a collection of ChildMonitorLinks, the collection will be ordered by Name.
MonitorNode	getChildMonitorNodeByName(String name)	Get the MonitorNode by ParentName.
RWIterable<MonitorNode>	getChildMonitorNodes()	Get an RWIterable over a collection of ChildMonitorNodes, the collection will be ordered by Name.

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

getBusinessKey

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

createMonitorEvent, getActualSeverity, getLinkedMonitorLinks, getMonitorEventByEventDefinition, getMonitorEvents, getRemoteId, getRemoteSystem, setRemoteId, setRemoteSystem

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

getFullPath, getParentMonitorNode, setParentMonitorNode

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

See Also:

Constant Field Values

TYPE

static final QueryObjectType<MonitorNode> 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_CONFIRM

static final String SEC_PRIV_CONFIRM

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_OPERATOR

static final String SEC_RANK_OPERATOR

This rank is made of the following privileges: view , confirm

See Also:

Constant Field Values

SEC_RANK_EDIT

static final String SEC_RANK_EDIT

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

See Also:

Constant Field Values

SEC_RANK_DELETE

static final String SEC_RANK_DELETE

This rank is made of the following privileges: view , confirm , create , 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 , confirm , edit , delete

See Also:

Constant Field Values

Method Detail

getChildMonitorLinks

RWIterable<MonitorLink> getChildMonitorLinks()

Get an RWIterable over a collection of ChildMonitorLinks, the collection will be ordered by Name. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. The children of this monitor node.

Specified by:

getChildMonitorLinks in interface MonitorNodeComp

Returns:

An RWIterable over a collection of MonitorLink objects , the collection will be ordered by Name.

getChildMonitorLinkByName

MonitorLink getChildMonitorLinkByName(String name)

Get the MonitorLink by ParentName.

Parameters:

name -

Returns:

the MonitorLink, or null if it could not be found

getChildMonitorChecks

RWIterable<MonitorCheck> getChildMonitorChecks()

Get an RWIterable over a collection of ChildMonitorChecks, the collection will be ordered by Name. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. The children of this monitor node.

Specified by:

getChildMonitorChecks in interface MonitorNodeComp

Returns:

An RWIterable over a collection of MonitorCheck objects , the collection will be ordered by Name.

getChildMonitorCheckByName

MonitorCheck getChildMonitorCheckByName(String name)

Get the MonitorCheck by ParentName.

Parameters:

name -

Returns:

the MonitorCheck, or null if it could not be found

getChildMonitorNodes

RWIterable<MonitorNode> getChildMonitorNodes()

Get an RWIterable over a collection of ChildMonitorNodes, the collection will be ordered by Name. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. The children of this monitor node.

Specified by:

getChildMonitorNodes in interface MonitorNodeComp

Returns:

An RWIterable over a collection of MonitorNode objects , the collection will be ordered by Name.

getChildMonitorNodeByName

MonitorNode getChildMonitorNodeByName(String name)

Get the MonitorNode by ParentName.

Parameters:

name -

Returns:

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

checkConfirmPrivilege

RequiredPermission checkConfirmPrivilege()

Check whether or not the confirm 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.