Package com.redwood.scheduler.api.model

Interface MonitorCheck

All Superinterfaces:

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

public interface MonitorCheck
extends MonitorCheckComp, LinkableMonitor, Readable

Shows which monitor conditions use which monitor values If the monitor check refers to a local object, it must define a business key.

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "MonitorCheck" 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<MonitorCheck>	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
MonitorCondition	createMonitorCondition()	Create a new MonitorCondition linked to this object.
MonitorValue	createMonitorValue()	Create a new MonitorValue linked to this object.
RWIterable<MonitorCondition>	getMonitorConditions()	Get an RWIterable over a collection of MonitorConditions, the collection will be ordered by Name.
SchedulerEntity	getMonitoredObject()	Get the value for MonitoredObject.
MonitorValue	getMonitorValueByName(String name)	Get the MonitorValue by Name.
RWIterable<MonitorValue>	getMonitorValues()	Get an RWIterable over a collection of MonitorValues, the collection will be ordered by Name.
void	setMonitoredObject(SchedulerEntity newMonitoredObject)	Set the value for MonitoredObject.

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

See Also:

Constant Field Values

TYPE

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

getMonitoredObject

SchedulerEntity getMonitoredObject()

Get the value for MonitoredObject. (Object being monitored, if it is local.)

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.

setMonitoredObject

void setMonitoredObject(SchedulerEntity newMonitoredObject)

Set the value for MonitoredObject. (Object being monitored, if it is local.) This value is optional.

Parameters:

newMonitoredObject - the new value for MonitoredObject.

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.

getMonitorConditions

RWIterable<MonitorCondition> getMonitorConditions()

Get an RWIterable over a collection of MonitorConditions, 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 condition that this monitor check is a check for.

Specified by:

getMonitorConditions in interface MonitorCheckComp

Returns:

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

createMonitorCondition

MonitorCondition createMonitorCondition()

Create a new MonitorCondition linked to this object.

Returns:

a new MonitorCondition.

getMonitorValues

RWIterable<MonitorValue> getMonitorValues()

Get an RWIterable over a collection of MonitorValues, 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 value of this monitor check.

Specified by:

getMonitorValues in interface MonitorCheckComp

Returns:

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

createMonitorValue

MonitorValue createMonitorValue()

Create a new MonitorValue linked to this object.

Returns:

a new MonitorValue.

getMonitorValueByName

MonitorValue getMonitorValueByName(String name)

Get the MonitorValue by Name.

Parameters:

name -

Returns:

the MonitorValue, or null if it could not be found