Package com.redwood.scheduler.api.model

Interface SchedulerEntityAction

All Superinterfaces:

Detail, SchedulerEntity, SchedulerEntityComp

All Known Subinterfaces:

AlertEscalationAction, AlertSourceAction, EmailAlertGatewayAction, JobDefinitionAction

public interface SchedulerEntityAction
extends Detail

An action that can be run at certain points of the job lifecycle.

Field Summary

Fields

Modifier and Type	Field	Description
static com.redwood.scheduler.infrastructure.logging.Versions	VERSION_SCHEDULERENTITYACTION

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

VERSION_DETAIL

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

ACTION_AUDIT, ACTION_EXPORT, ACTION_READ, BEHAVIOR_DEPRECATED, BEHAVIOR_NONE, BEHAVIOR_SYSTEM, VERSION_SCHEDULERENTITY

Fields inherited from interface com.redwood.scheduler.api.model.compatibility_14.SchedulerEntityComp

VERSION_SCHEDULERENTITYCOMP

Method Summary

Modifier and Type	Method	Description
Subject	getActionSubject()	Get the ActionSubject.
String	getSource()	Get the value for Source.
String	getStubSource()	Get the value for StubSource.
boolean	isEnabled()	Get the value for Enabled.
void	setActionSubject(Subject newActionSubject)	Set the value for ActionSubject.
void	setEnabled(boolean newEnabled)	Set the value for Enabled.
void	setSource(String newSource)	Set the value for Source.

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

VERSION_SCHEDULERENTITYACTION

static final com.redwood.scheduler.infrastructure.logging.Versions VERSION_SCHEDULERENTITYACTION

Method Detail

isEnabled

boolean isEnabled()

Get the value for Enabled. (Whether this action is currently enabled or not.)

Returns:

the field

Throws:

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

getSource

String getSource()

Get the value for Source. (Source code for the action.) 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.

getStubSource

String getStubSource()

Get the value for StubSource. (The source for the stub of the action.) 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.

setEnabled

void setEnabled(boolean newEnabled)

Set the value for Enabled. (Whether this action is currently enabled or not.)

Parameters:

newEnabled - the new value for Enabled.

Throws:

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

setSource

void setSource(String newSource)

Set the value for Source. (Source code for the action.) This value is mandatory.

Parameters:

newSource - the new value for Source. 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.

getActionSubject

Subject getActionSubject()

Get the ActionSubject.

Returns:

ActionSubject

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.

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 action execute as?