Package com.redwood.scheduler.api.model

Interface AlertGateway

All Superinterfaces:

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

All Known Subinterfaces:

EmailAlertGateway

public interface AlertGateway
extends UniqueNamedApplicationObject

An alert gateway

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
Long	getAlertRateInterval()	Get the value for AlertRateInterval.
Long	getAlertRateLimit()	Get the value for AlertRateLimit.
Long	getAlertResendDelay()	Get the value for AlertResendDelay.
String	getPattern()	Get the value for Pattern.
Long	getProcessingOrder()	Get the value for ProcessingOrder.
void	setAlertRateInterval(Long newAlertRateInterval)	Set the value for AlertRateInterval.
void	setAlertRateLimit(Long newAlertRateLimit)	Set the value for AlertRateLimit.
void	setAlertResendDelay(Long newAlertResendDelay)	Set the value for AlertResendDelay.
void	setPattern(String newPattern)	Set the value for Pattern.
void	setProcessingOrder(Long newProcessingOrder)	Set the value for ProcessingOrder.

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

getPattern

String getPattern()

Get the value for Pattern. (The alert pattern (including scheme) to intercept.) 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.

getProcessingOrder

Long getProcessingOrder()

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

getAlertRateLimit

Long getAlertRateLimit()

Get the value for AlertRateLimit. (The number of alerts that can be sent to an address within the alert rate window.) 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.

getAlertRateInterval

Long getAlertRateInterval()

Get the value for AlertRateInterval. (The time interval in minutes for calculating the alert rate.) 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.

getAlertResendDelay

Long getAlertResendDelay()

Get the value for AlertResendDelay. (The delay in minutes before trying to resend a failed alert.) 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.

setPattern

void setPattern(String newPattern)

Set the value for Pattern. (The alert pattern (including scheme) to intercept.) This value is mandatory.

Parameters:

newPattern - the new value for Pattern. 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.

setProcessingOrder

void setProcessingOrder(Long newProcessingOrder)

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

setAlertRateLimit

void setAlertRateLimit(Long newAlertRateLimit)

Set the value for AlertRateLimit. (The number of alerts that can be sent to an address within the alert rate window.) This value is mandatory.

Parameters:

newAlertRateLimit - the new value for AlertRateLimit. 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.

setAlertRateInterval

void setAlertRateInterval(Long newAlertRateInterval)

Set the value for AlertRateInterval. (The time interval in minutes for calculating the alert rate.) This value is mandatory.

Parameters:

newAlertRateInterval - the new value for AlertRateInterval. 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.

setAlertResendDelay

void setAlertResendDelay(Long newAlertResendDelay)

Set the value for AlertResendDelay. (The delay in minutes before trying to resend a failed alert.) This value is mandatory.

Parameters:

newAlertResendDelay - the new value for AlertResendDelay. 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.