Package com.redwood.scheduler.api.model

Interface AlertSource

All Superinterfaces:

AlertSourceComp, ApplicationObject, BusinessKeyObject, NamedRootObject, NamedRootObjectComp, PartitionableObject, PartitionableObjectComp, Root, SchedulerEntity, SchedulerEntityComp, UniqueNamedApplicationObject

All Known Subinterfaces:

AdHocAlertSource, JobDefinitionAlertSource, MonitorAlertSource, ProcessServerAlertSource, QueueAlertSource

public interface AlertSource
extends AlertSourceComp, UniqueNamedApplicationObject

An alert source

Field Summary

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
AlertSourceAction	createAlertSourceAction()	Create a new AlertSourceAction linked to this object.
AlertSourceEmail	createAlertSourceEmail()	Create a new AlertSourceEmail linked to this object.
String	getAddress()	Get the value for Address.
RWIterable<AlertSourceAction>	getAlertSourceActions()	Get an RWIterable over an ordered collection of AlertSourceActions.
AlertSourceEmail	getAlertSourceEmail()	Get the AlertSourceEmail.
AlertEscalation	getDefaultAlertEscalation()	Get the DefaultAlertEscalation.
String	getEscalationExpression()	Get the value for EscalationExpression.
String	getOperatorMessageExpression()	Get the value for OperatorMessageExpression.
String	getOperatorMessageReplyExpression()	Get the value for OperatorMessageReplyExpression.
TimeWindow	getTimeWindow()	Get the TimeWindow.
TimeWindowStatus	getTimeWindowStatus()	Get the value for TimeWindowStatus.
TimeZone	getTimeZone()	Get the TimeZone.
Validity	getValidity()	Get the value for Validity.
boolean	isEnabled()	Get the value for Enabled.
void	setAddress(String newAddress)	Set the value for Address.
void	setDefaultAlertEscalation(AlertEscalation newDefaultAlertEscalation)	Set the value for DefaultAlertEscalation.
void	setEnabled(boolean newEnabled)	Set the value for Enabled.
void	setEscalationExpression(String newEscalationExpression)	Set the value for EscalationExpression.
void	setOperatorMessageExpression(String newOperatorMessageExpression)	Set the value for OperatorMessageExpression.
void	setOperatorMessageReplyExpression(String newOperatorMessageReplyExpression)	Set the value for OperatorMessageReplyExpression.
void	setTimeWindow(TimeWindow newTimeWindow)	Set the value for TimeWindow.
void	setTimeWindowStatus(TimeWindowStatus newTimeWindowStatus)	Set the value for TimeWindowStatus.
void	setTimeZone(TimeZone newTimeZone)	Set the value for TimeZone.

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

Method Detail

getEscalationExpression

String getEscalationExpression()

Get the value for EscalationExpression. (The (optional) alert escalation expression. If this is set, then the expression is evaluated. If the resulting channel exists, it is used for escalation, otherwise the default escalation channel 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.

getOperatorMessageExpression

String getOperatorMessageExpression()

Get the value for OperatorMessageExpression. (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.

getOperatorMessageReplyExpression

String getOperatorMessageReplyExpression()

Get the value for OperatorMessageReplyExpression. (The operator message reply expression. If this is set, then the expression is evaluated, and the result is used as the allowed responses to 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.

getTimeWindowStatus

TimeWindowStatus getTimeWindowStatus()

Get the value for TimeWindowStatus. (The status of the time window (open or closed).) 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.

getAddress

String getAddress()

Get the value for Address. (The (optional) address to send this alert to)

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.

isEnabled

boolean isEnabled()

Get the value for Enabled. (Enable/disable the alert source)

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.

getValidity

Validity getValidity()

Get the value for Validity. (Is this definition valid? That is, can this definition currently be used?) 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.

setEscalationExpression

void setEscalationExpression(String newEscalationExpression)

Set the value for EscalationExpression. (The (optional) alert escalation expression. If this is set, then the expression is evaluated. If the resulting channel exists, it is used for escalation, otherwise the default escalation channel is used.) This value is optional.

Parameters:

newEscalationExpression - the new value for EscalationExpression.

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. (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.

setOperatorMessageReplyExpression

void setOperatorMessageReplyExpression(String newOperatorMessageReplyExpression)

Set the value for OperatorMessageReplyExpression. (The operator message reply expression. If this is set, then the expression is evaluated, and the result is used as the allowed responses to the operator message. If not set, a source specific default is used.) This value is optional.

Parameters:

newOperatorMessageReplyExpression - the new value for OperatorMessageReplyExpression.

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.

setTimeWindowStatus

void setTimeWindowStatus(TimeWindowStatus newTimeWindowStatus)

Set the value for TimeWindowStatus. (The status of the time window (open or closed).) This value is mandatory.

Parameters:

newTimeWindowStatus - the new value for TimeWindowStatus. 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.

setAddress

void setAddress(String newAddress)

Set the value for Address. (The (optional) address to send this alert to) This value is optional.

Parameters:

newAddress - the new value for Address.

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.

setEnabled

void setEnabled(boolean newEnabled)

Set the value for Enabled. (Enable/disable the alert source)

Parameters:

newEnabled - the new value for Enabled.

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.

getDefaultAlertEscalation

AlertEscalation getDefaultAlertEscalation()

Get the DefaultAlertEscalation.

Returns:

DefaultAlertEscalation

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.

getTimeWindow

TimeWindow getTimeWindow()

Get the TimeWindow.

Returns:

TimeWindow

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.

getTimeZone

TimeZone getTimeZone()

Get the TimeZone.

Returns:

TimeZone

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.

setDefaultAlertEscalation

void setDefaultAlertEscalation(AlertEscalation newDefaultAlertEscalation)

Set the value for DefaultAlertEscalation. This value is optional.

Parameters:

newDefaultAlertEscalation - is the object to set DefaultAlertEscalation to. The default escalation channel for this alert source.

setTimeWindow

void setTimeWindow(TimeWindow newTimeWindow)

Set the value for TimeWindow. This value is optional.

Parameters:

newTimeWindow - is the object to set TimeWindow to. The time window during which this alert source is active.

setTimeZone

void setTimeZone(TimeZone newTimeZone)

Set the value for TimeZone. This value is optional.

Parameters:

newTimeZone - is the object to set TimeZone to. The timezone for the timewindowinterval

getAlertSourceActions

RWIterable<AlertSourceAction> getAlertSourceActions()

Get an RWIterable over an ordered collection of AlertSourceActions. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. The alert source for an alert source action

Specified by:

getAlertSourceActions in interface AlertSourceComp

Returns:

An RWIterable over an ordered collection of AlertSourceAction objects .

createAlertSourceAction

AlertSourceAction createAlertSourceAction()

Create a new AlertSourceAction linked to this object.

Returns:

a new AlertSourceAction.

getAlertSourceEmail

AlertSourceEmail getAlertSourceEmail()

Get the AlertSourceEmail. The email text.

Returns:

nullAlertSourceEmail

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.

createAlertSourceEmail

AlertSourceEmail createAlertSourceEmail()

Create a new AlertSourceEmail linked to this object.

Returns:

a new AlertSourceEmail.