Package com.redwood.scheduler.api.model

Interface MonitorAlertSourceRule

All Superinterfaces:

Detail, Readable, SchedulerEntity, SchedulerEntityComp

public interface MonitorAlertSourceRule
extends Detail, Readable

Alert escalation rules

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "MonitorAlertSourceRule" 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<MonitorAlertSourceRule>	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
AlertEscalation	getAlertEscalation()	Get the AlertEscalation.
Long	getDelayAmount()	Get the value for DelayAmount.
TimeUnit	getDelayUnits()	Get the value for DelayUnits.
MonitorAlertSource	getMonitorAlertSource()	Get the MonitorAlertSource.
String	getOperatorMessageExpression()	Get the value for OperatorMessageExpression.
Long	getProcessingOrder()	Get the value for ProcessingOrder.
Long	getSeverity()	Get the value for Severity.
boolean	isRising()	Get the value for Rising.
void	setAlertEscalation(AlertEscalation newAlertEscalation)	Set the value for AlertEscalation.
void	setDelayAmount(Long newDelayAmount)	Set the value for DelayAmount.
void	setDelayUnits(TimeUnit newDelayUnits)	Set the value for DelayUnits.
void	setOperatorMessageExpression(String newOperatorMessageExpression)	Set the value for OperatorMessageExpression.
void	setProcessingOrder(Long newProcessingOrder)	Set the value for ProcessingOrder.
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.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 "MonitorAlertSourceRule" objects.

See Also:

Constant Field Values

TYPE

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

getProcessingOrder

Long getProcessingOrder()

Get the value for ProcessingOrder. (The order in which to process this rule.) 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.

getSeverity

Long getSeverity()

Get the value for Severity. (The severity of the node) 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.

isRising

boolean isRising()

Get the value for Rising. (If the severity is rising or falling)

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.

getOperatorMessageExpression

String getOperatorMessageExpression()

Get the value for OperatorMessageExpression. (Override the operator message expression for the Monitor Alert. The operator message expression. If this is set, then the expression is evaluated, and the result is used as the operator message. If not set, a source specific default is used.)

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.

getDelayAmount

Long getDelayAmount()

Get the value for DelayAmount. (Amount of time (in time units) that the monitor node must be in this status before the alert is 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.

getDelayUnits

TimeUnit getDelayUnits()

Get the value for DelayUnits. (Time units for the amount of time that the monitor node must be in this status before the alert is 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.

setProcessingOrder

void setProcessingOrder(Long newProcessingOrder)

Set the value for ProcessingOrder. (The order in which to process this rule.) This value is mandatory.

Parameters:

newProcessingOrder - the new value for ProcessingOrder. 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.

setSeverity

void setSeverity(Long newSeverity)

Set the value for Severity. (The severity of the node) 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.

setRising

void setRising(boolean newRising)

Set the value for Rising. (If the severity is rising or falling)

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.

setOperatorMessageExpression

void setOperatorMessageExpression(String newOperatorMessageExpression)

Set the value for OperatorMessageExpression. (Override the operator message expression for the Monitor Alert. The operator message expression. If this is set, then the expression is evaluated, and the result is used as the operator message. If not set, a source specific default is used.) This value is optional.

Parameters:

newOperatorMessageExpression - the new value for OperatorMessageExpression.

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.

setDelayAmount

void setDelayAmount(Long newDelayAmount)

Set the value for DelayAmount. (Amount of time (in time units) that the monitor node must be in this status before the alert is raised.) This value is mandatory.

Parameters:

newDelayAmount - the new value for DelayAmount. 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.

setDelayUnits

void setDelayUnits(TimeUnit newDelayUnits)

Set the value for DelayUnits. (Time units for the amount of time that the monitor node must be in this status before the alert is raised.) This value is mandatory.

Parameters:

newDelayUnits - the new value for DelayUnits. 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.

getMonitorAlertSource

MonitorAlertSource getMonitorAlertSource()

Get the MonitorAlertSource.

Returns:

MonitorAlertSource

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.

getAlertEscalation

AlertEscalation getAlertEscalation()

Get the AlertEscalation.

Returns:

AlertEscalation

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.

setAlertEscalation

void setAlertEscalation(AlertEscalation newAlertEscalation)

Set the value for AlertEscalation. This value is optional.

Parameters:

newAlertEscalation - is the object to set AlertEscalation to. The escalation channel to use if this rule matches.