Package com.redwood.scheduler.api.model

Interface VisualizationAlertSource

All Superinterfaces:

Detail, SchedulerEntity, SchedulerEntityComp

public interface VisualizationAlertSource
extends Detail

An alert source in an alert visualization

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "VisualizationAlertSource" 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<VisualizationAlertSource>	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
AlertSource	getAlertSource()	Get the AlertSource.
VisualizationAlert	getVisualizationAlert()	Get the VisualizationAlert.
boolean	isVisible()	Get the value for Visible.
void	setAlertSource(AlertSource newAlertSource)	Set the value for AlertSource.
void	setVisible(boolean newVisible)	Set the value for Visible.

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

See Also:

Constant Field Values

TYPE

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

isVisible

boolean isVisible()

Get the value for Visible. (Show this alert source in the visualization.)

Returns:

the field

Throws:

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

setVisible

void setVisible(boolean newVisible)

Set the value for Visible. (Show this alert source in the visualization.)

Parameters:

newVisible - the new value for Visible.

Throws:

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

getVisualizationAlert

VisualizationAlert getVisualizationAlert()

Get the VisualizationAlert.

Returns:

VisualizationAlert

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.

getAlertSource

AlertSource getAlertSource()

Get the AlertSource.

Returns:

AlertSource

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.

setAlertSource

void setAlertSource(AlertSource newAlertSource)

Set the value for AlertSource. This value is mandatory.

Parameters:

newAlertSource - is the object to set AlertSource to. The alert source If this is null, then the object cannot be persisted.