Package com.redwood.scheduler.api.model

Interface MonitorEvent

All Superinterfaces:

Association, BusinessKeyObject, Readable, SchedulerEntity, SchedulerEntityComp

public interface MonitorEvent
extends Association, BusinessKeyObject, Readable

Event to be raised when a monitor reaches a particular severity When an alert is raised for a monitor node that has an associated event and the severity is appropriate, the event is raised.

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "MonitorEvent" 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<MonitorEvent>	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
EventDefinition	getEventDefinition()	Get the EventDefinition.
LinkableMonitor	getLinkableMonitor()	Get the LinkableMonitor.
String	getReason()	Get the value for Reason.
Long	getSeverity()	Get the value for Severity.
boolean	isRising()	Get the value for Rising.
void	setReason(String newReason)	Set the value for Reason.
void	setRising(boolean newRising)	Set the value for Rising.
void	setSeverity(Long newSeverity)	Set the value for Severity.

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

getBusinessKey

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

See Also:

Constant Field Values

TYPE

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

getReason

String getReason()

Get the value for Reason. (Text that will be stored as the comment for why the event is raised)

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.

isRising

boolean isRising()

Get the value for Rising. (Is the event raised when the severity of the montor rises above this severity)

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.

getSeverity

Long getSeverity()

Get the value for Severity. (Minimal severity for the event to be raised) 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.

setReason

void setReason(String newReason)

Set the value for Reason. (Text that will be stored as the comment for why the event is raised) This value is optional.

Parameters:

newReason - the new value for Reason.

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.

setRising

void setRising(boolean newRising)

Set the value for Rising. (Is the event raised when the severity of the montor rises above this severity)

Parameters:

newRising - the new value for Rising.

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.

setSeverity

void setSeverity(Long newSeverity)

Set the value for Severity. (Minimal severity for the event to be raised) This value is mandatory.

Parameters:

newSeverity - the new value for Severity. 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.

getEventDefinition

EventDefinition getEventDefinition()

Get the EventDefinition.

Returns:

EventDefinition

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.

getLinkableMonitor

LinkableMonitor getLinkableMonitor()

Get the LinkableMonitor.

Returns:

LinkableMonitor

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.