Package com.redwood.scheduler.api.model

Interface JobDefinitionAlertSourceRule

All Superinterfaces:

Detail, Readable, SchedulerEntity, SchedulerEntityComp

public interface JobDefinitionAlertSourceRule
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 "JobDefinitionAlertSourceRule" 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<JobDefinitionAlertSourceRule>	TYPE	Type that can be used in SchedulerSession.executeObjectQuery(QueryObjectType, String, Object...).

Fields inherited from interface com.redwood.scheduler.api.model.Readable

COPYRIGHT_MESSAGE_E, ID_E

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.
JobDefinitionAlertSource	getJobDefinitionAlertSource()	Get the JobDefinitionAlertSource.
JobDefinitionAlertSourceRuleOperation	getOperation()	Get the value for Operation.
Long	getProcessingOrder()	Get the value for ProcessingOrder.
String	getValue()	Get the value for Value.
JobDefinitionAlertSourceRuleVariable	getVariable()	Get the value for Variable.
void	setAlertEscalation(AlertEscalation newAlertEscalation)	Set the value for AlertEscalation.
void	setOperation(JobDefinitionAlertSourceRuleOperation newOperation)	Set the value for Operation.
void	setProcessingOrder(Long newProcessingOrder)	Set the value for ProcessingOrder.
void	setValue(String newValue)	Set the value for Value.
void	setVariable(JobDefinitionAlertSourceRuleVariable newVariable)	Set the value for Variable.

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

See Also:

Constant Field Values

TYPE

static final QueryObjectType<JobDefinitionAlertSourceRule> 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 gateway.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.

Returns:

the field

Throws:

ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

getVariable

JobDefinitionAlertSourceRuleVariable getVariable()

Get the value for Variable. (.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.

Returns:

the field

Throws:

ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

getOperation

JobDefinitionAlertSourceRuleOperation getOperation()

Get the value for Operation. (.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.

Returns:

the field

Throws:

ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

getValue

String getValue()

Get the value for Value. (.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.

Returns:

the field

Throws:

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:

ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

setVariable

void setVariable(JobDefinitionAlertSourceRuleVariable newVariable)

Set the value for Variable. (.) This value is mandatory.

Parameters:

newVariable - the new value for Variable. If this is null, then the object cannot be persisted.

Throws:

ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

setOperation

void setOperation(JobDefinitionAlertSourceRuleOperation newOperation)

Set the value for Operation. (.) This value is mandatory.

Parameters:

newOperation - the new value for Operation. If this is null, then the object cannot be persisted.

Throws:

ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

setValue

void setValue(String newValue)

Set the value for Value. (.) This value is mandatory.

Parameters:

newValue - the new value for Value. If this is null, then the object cannot be persisted.

Throws:

ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

getJobDefinitionAlertSource

JobDefinitionAlertSource getJobDefinitionAlertSource()

Get the JobDefinitionAlertSource.

Returns:

JobDefinitionAlertSource

Throws:

ObjectDeletedException - If this method is called when the object has been marked for deletion.

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:

ObjectDeletedException - If this method is called when the object has been marked for deletion.

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.