Package com.redwood.scheduler.api.model

Interface EmailAlertGateway

All Superinterfaces:

ActionSubjectObject, AlertGateway, ApplicationObject, BusinessKeyObject, EmailAlertGatewayComp, NamedRootObject, NamedRootObjectComp, PartitionableObject, PartitionableObjectComp, Readable, Root, SchedulerEntity, SchedulerEntityComp, UniqueNamedApplicationObject

public interface EmailAlertGateway
extends EmailAlertGatewayComp, AlertGateway, ActionSubjectObject, Readable

An email alert gateway

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "EmailAlertGateway" objects.
static String	SEC_PRIV_CREATE	This privilege can be granted at a group level.
static String	SEC_PRIV_DELETE	This privilege can be granted at a group level.
static String	SEC_PRIV_EDIT	This privilege can be granted at a group level.
static String	SEC_PRIV_VIEW	This privilege can be granted at a group level.
static String	SEC_RANK_ALL	This rank is made of the following privileges: create , view , edit , delete
static String	SEC_RANK_CREATE	This rank is made of the following privileges: create
static String	SEC_RANK_DELETE	This rank is made of the following privileges: create , view , delete
static String	SEC_RANK_EDIT	This rank is made of the following privileges: create , view , edit
static String	SEC_RANK_NONE	This rank has no privileges assigned to it.
static String	SEC_RANK_VIEW	This rank is made of the following privileges: view
static QueryObjectType<EmailAlertGateway>	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
RequiredPermission	checkCreatePrivilege()	Check whether or not the create action can be performed on this object.
RequiredPermission	checkDeletePrivilege()	Check whether or not the delete action can be performed on this object.
RequiredPermission	checkEditPrivilege()	Check whether or not the edit action can be performed on this object.
RequiredPermission	checkViewPrivilege()	Check whether or not the view action can be performed on this object.
EmailAlertGatewayAction	createEmailAlertGatewayAction()	Create a new EmailAlertGatewayAction linked to this object.
EmailAlertGatewayEmail	createEmailAlertGatewayEmail()	Create a new EmailAlertGatewayEmail linked to this object.
EmailAlertGatewayHeader	createEmailAlertGatewayHeader()	Create a new EmailAlertGatewayHeader linked to this object.
EmailAlertGatewayJobFileAttachment	createEmailAlertGatewayJobFileAttachment()	Create a new EmailAlertGatewayJobFileAttachment linked to this object.
Subject	getActionSubject()	Get the ActionSubject.
EmailAlertGatewayAction	getEmailAlertGatewayActionByType(EmailAlertGatewayActionType type)	Get the EmailAlertGatewayAction by EmailAlertGatewayActionType.
RWIterable<EmailAlertGatewayAction>	getEmailAlertGatewayActions()	Get an RWIterable over an ordered collection of EmailAlertGatewayActions.
EmailAlertGatewayEmail	getEmailAlertGatewayEmail()	Get the EmailAlertGatewayEmail.
RWIterable<EmailAlertGatewayHeader>	getEmailAlertGatewayHeaders()	Get an RWIterable over an ordered collection of EmailAlertGatewayHeaders.
RWIterable<EmailAlertGatewayJobFileAttachment>	getEmailAlertGatewayJobFileAttachments()	Get an RWIterable over an ordered collection of EmailAlertGatewayJobFileAttachments.
Validity	getValidity()	Get the value for Validity.
Set<Variable>	getVariables()	Get the Set of Variables related to EmailAlertGateway objects.
void	setActionSubject(Subject newActionSubject)	Set the value for ActionSubject.

Methods inherited from interface com.redwood.scheduler.api.model.interfaces.ActionSubjectObject

getActionSubjectUniqueId

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

getAlertRateInterval, getAlertRateLimit, getAlertResendDelay, getPattern, getProcessingOrder, setAlertRateInterval, setAlertRateLimit, setAlertResendDelay, setPattern, setProcessingOrder

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

Field Detail

OBJECT_TYPE

static final String OBJECT_TYPE

String that will be returned from SchedulerEntity.getObjectType() for "EmailAlertGateway" objects.

See Also:

Constant Field Values

TYPE

static final QueryObjectType<EmailAlertGateway> TYPE

Type that can be used in SchedulerSession.executeObjectQuery(QueryObjectType, String, Object...).

SEC_PRIV_CREATE

static final String SEC_PRIV_CREATE

This privilege can be granted at a group level.

See Also:

Constant Field Values

SEC_PRIV_VIEW

static final String SEC_PRIV_VIEW

This privilege can be granted at a group level. This privilege can be granted at an instance level.

See Also:

Constant Field Values

SEC_PRIV_EDIT

static final String SEC_PRIV_EDIT

This privilege can be granted at a group level. This privilege can be granted at an instance level.

See Also:

Constant Field Values

SEC_PRIV_DELETE

static final String SEC_PRIV_DELETE

This privilege can be granted at a group level. This privilege can be granted at an instance level.

See Also:

Constant Field Values

SEC_RANK_NONE

static final String SEC_RANK_NONE

This rank has no privileges assigned to it.

See Also:

Constant Field Values

SEC_RANK_CREATE

static final String SEC_RANK_CREATE

This rank is made of the following privileges: create

See Also:

Constant Field Values

SEC_RANK_VIEW

static final String SEC_RANK_VIEW

This rank is made of the following privileges: view

See Also:

Constant Field Values

SEC_RANK_EDIT

static final String SEC_RANK_EDIT

This rank is made of the following privileges: create , view , edit

See Also:

Constant Field Values

SEC_RANK_DELETE

static final String SEC_RANK_DELETE

This rank is made of the following privileges: create , view , delete

See Also:

Constant Field Values

SEC_RANK_ALL

static final String SEC_RANK_ALL

This rank is made of the following privileges: create , view , edit , delete

See Also:

Constant Field Values

Method Detail

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.

getVariables

Set<Variable> getVariables()

Get the Set of Variables related to EmailAlertGateway objects.

Returns:

Set of Variable for EmailAlertGateway.

getActionSubject

Subject getActionSubject()

Get the ActionSubject.

Specified by:

getActionSubject in interface ActionSubjectObject

Returns:

ActionSubject

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.

setActionSubject

void setActionSubject(Subject newActionSubject)

Set the value for ActionSubject. This value is optional.

Parameters:

newActionSubject - is the object to set ActionSubject to. Who does this Alert Email Source, or Email Alert Gateway Body REL execute as?

getEmailAlertGatewayActions

RWIterable<EmailAlertGatewayAction> getEmailAlertGatewayActions()

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

Specified by:

getEmailAlertGatewayActions in interface EmailAlertGatewayComp

Returns:

An RWIterable over an ordered collection of EmailAlertGatewayAction objects .

createEmailAlertGatewayAction

EmailAlertGatewayAction createEmailAlertGatewayAction()

Create a new EmailAlertGatewayAction linked to this object.

Returns:

a new EmailAlertGatewayAction.

getEmailAlertGatewayActionByType

EmailAlertGatewayAction getEmailAlertGatewayActionByType(EmailAlertGatewayActionType type)

Get the EmailAlertGatewayAction by EmailAlertGatewayActionType.

Parameters:

type -

Returns:

the EmailAlertGatewayAction, or null if it could not be found

getEmailAlertGatewayEmail

EmailAlertGatewayEmail getEmailAlertGatewayEmail()

Get the EmailAlertGatewayEmail. The email text for an email alert gateway.

Returns:

nullEmailAlertGatewayEmail

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.

createEmailAlertGatewayEmail

EmailAlertGatewayEmail createEmailAlertGatewayEmail()

Create a new EmailAlertGatewayEmail linked to this object.

Returns:

a new EmailAlertGatewayEmail.

getEmailAlertGatewayHeaders

RWIterable<EmailAlertGatewayHeader> getEmailAlertGatewayHeaders()

Get an RWIterable over an ordered collection of EmailAlertGatewayHeaders. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. Email alert gateway headers.

Specified by:

getEmailAlertGatewayHeaders in interface EmailAlertGatewayComp

Returns:

An RWIterable over an ordered collection of EmailAlertGatewayHeader objects .

createEmailAlertGatewayHeader

EmailAlertGatewayHeader createEmailAlertGatewayHeader()

Create a new EmailAlertGatewayHeader linked to this object.

Returns:

a new EmailAlertGatewayHeader.

getEmailAlertGatewayJobFileAttachments

RWIterable<EmailAlertGatewayJobFileAttachment> getEmailAlertGatewayJobFileAttachments()

Get an RWIterable over an ordered collection of EmailAlertGatewayJobFileAttachments. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. Email alert gateway job file attachments.

Specified by:

getEmailAlertGatewayJobFileAttachments in interface EmailAlertGatewayComp

Returns:

An RWIterable over an ordered collection of EmailAlertGatewayJobFileAttachment objects .

createEmailAlertGatewayJobFileAttachment

EmailAlertGatewayJobFileAttachment createEmailAlertGatewayJobFileAttachment()

Create a new EmailAlertGatewayJobFileAttachment linked to this object.

Returns:

a new EmailAlertGatewayJobFileAttachment.

checkCreatePrivilege

RequiredPermission checkCreatePrivilege()

Check whether or not the create action can be performed on this object.

Returns:

a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.

checkViewPrivilege

RequiredPermission checkViewPrivilege()

Check whether or not the view action can be performed on this object.

Returns:

a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.

checkEditPrivilege

RequiredPermission checkEditPrivilege()

Check whether or not the edit action can be performed on this object.

Returns:

a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.

checkDeletePrivilege

RequiredPermission checkDeletePrivilege()

Check whether or not the delete action can be performed on this object.

Returns:

a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.