Package com.redwood.scheduler.api.model

Interface ProcessServerAlertSource

All Superinterfaces:

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

public interface ProcessServerAlertSource
extends ProcessServerAlertSourceComp, AlertSource, Readable

An alert raised by a process server

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "ProcessServerAlertSource" 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<ProcessServerAlertSource>	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.
ProcessServerAlertSourceStatus	createProcessServerAlertSourceStatus()	Create a new ProcessServerAlertSourceStatus linked to this object.
NameMatchType	getNameMatchType()	Get the value for NameMatchType.
String	getNamePattern()	Get the value for NamePattern.
NameMatchType	getPartitionMatchType()	Get the value for PartitionMatchType.
String	getPartitionPattern()	Get the value for PartitionPattern.
ProcessServerAlertSourceStatus	getProcessServerAlertSourceStatusByStatus(ProcessServerStatus status)	Get the ProcessServerAlertSourceStatus by Status.
RWIterable<ProcessServerAlertSourceStatus>	getProcessServerAlertSourceStatuses()	Get an RWIterable over an ordered collection of ProcessServerAlertSourceStatuses.
void	setNameMatchType(NameMatchType newNameMatchType)	Set the value for NameMatchType.
void	setNamePattern(String newNamePattern)	Set the value for NamePattern.
void	setPartitionMatchType(NameMatchType newPartitionMatchType)	Set the value for PartitionMatchType.
void	setPartitionPattern(String newPartitionPattern)	Set the value for PartitionPattern.

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

createAlertSourceAction, createAlertSourceEmail, getAddress, getAlertSourceActions, getAlertSourceEmail, getDefaultAlertEscalation, getEscalationExpression, getOperatorMessageExpression, getOperatorMessageReplyExpression, getTimeWindow, getTimeWindowStatus, getTimeZone, getValidity, isEnabled, setAddress, setDefaultAlertEscalation, setEnabled, setEscalationExpression, setOperatorMessageExpression, setOperatorMessageReplyExpression, setTimeWindow, setTimeWindowStatus, setTimeZone

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

See Also:

Constant Field Values

TYPE

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

getNamePattern

String getNamePattern()

Get the value for NamePattern. (The Pattern of job processServer names to match ) 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.

getNameMatchType

NameMatchType getNameMatchType()

Get the value for NameMatchType. (The type of pattern match for the Name of the Alert source.) 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.

getPartitionPattern

String getPartitionPattern()

Get the value for PartitionPattern. (The Pattern of partition name to match)

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.

getPartitionMatchType

NameMatchType getPartitionMatchType()

Get the value for PartitionMatchType. (The type of pattern match for the partition name) 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.

setNamePattern

void setNamePattern(String newNamePattern)

Set the value for NamePattern. (The Pattern of job processServer names to match ) This value is mandatory.

Parameters:

newNamePattern - the new value for NamePattern. 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.

setNameMatchType

void setNameMatchType(NameMatchType newNameMatchType)

Set the value for NameMatchType. (The type of pattern match for the Name of the Alert source.) This value is mandatory.

Parameters:

newNameMatchType - the new value for NameMatchType. 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.

setPartitionPattern

void setPartitionPattern(String newPartitionPattern)

Set the value for PartitionPattern. (The Pattern of partition name to match) This value is optional.

Parameters:

newPartitionPattern - the new value for PartitionPattern.

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.

setPartitionMatchType

void setPartitionMatchType(NameMatchType newPartitionMatchType)

Set the value for PartitionMatchType. (The type of pattern match for the partition name) This value is mandatory.

Parameters:

newPartitionMatchType - the new value for PartitionMatchType. 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.

getProcessServerAlertSourceStatuses

RWIterable<ProcessServerAlertSourceStatus> getProcessServerAlertSourceStatuses()

Get an RWIterable over an ordered collection of ProcessServerAlertSourceStatuses. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. Process server alert source statuses.

Specified by:

getProcessServerAlertSourceStatuses in interface ProcessServerAlertSourceComp

Returns:

An RWIterable over an ordered collection of ProcessServerAlertSourceStatus objects .

createProcessServerAlertSourceStatus

ProcessServerAlertSourceStatus createProcessServerAlertSourceStatus()

Create a new ProcessServerAlertSourceStatus linked to this object.

Returns:

a new ProcessServerAlertSourceStatus.

getProcessServerAlertSourceStatusByStatus

ProcessServerAlertSourceStatus getProcessServerAlertSourceStatusByStatus(ProcessServerStatus status)

Get the ProcessServerAlertSourceStatus by Status.

Parameters:

status -

Returns:

the ProcessServerAlertSourceStatus, or null if it could not be found

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.