Package com.redwood.scheduler.api.model

Interface FinalStatusHandler

All Superinterfaces:

Detail, Readable, SchedulerEntity, SchedulerEntityComp

public interface FinalStatusHandler
extends Detail, Readable

Describes what to do when a Job reaches a final state

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "FinalStatusHandler" 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<FinalStatusHandler>	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
FinalStatusAction	getAction()	Get the value for Action.
JobDefinition	getJobDefinition()	Get the JobDefinition.
String	getMessageText()	Get the value for MessageText.
Long	getRestartDelayAmount()	Get the value for RestartDelayAmount.
TimeUnit	getRestartDelayUnits()	Get the value for RestartDelayUnits.
JobStatus	getStatus()	Get the value for Status.
void	setAction(FinalStatusAction newAction)	Set the value for Action.
void	setMessageText(String newMessageText)	Set the value for MessageText.
void	setRestartDelayAmount(Long newRestartDelayAmount)	Set the value for RestartDelayAmount.
void	setRestartDelayUnits(TimeUnit newRestartDelayUnits)	Set the value for RestartDelayUnits.
void	setStatus(JobStatus newStatus)	Set the value for Status.

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

See Also:

Constant Field Values

TYPE

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

getStatus

JobStatus getStatus()

Get the value for Status. () 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.

getAction

FinalStatusAction getAction()

Get the value for Action. (What to do on this final state) 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.

getMessageText

String getMessageText()

Get the value for MessageText. (an operator message to send when this status is reached)

Returns:

the field

Throws:

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

getRestartDelayAmount

Long getRestartDelayAmount()

Get the value for RestartDelayAmount. (number of 'restart delay time units' after the finish time of the original job to submit the restart at) 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.

getRestartDelayUnits

TimeUnit getRestartDelayUnits()

Get the value for RestartDelayUnits. (time units for 'restart delay amount' - seconds, minutes, hours, days. May not be null, defaults to minutes) 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.

setStatus

void setStatus(JobStatus newStatus)

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

Parameters:

newStatus - the new value for Status. 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.

setAction

void setAction(FinalStatusAction newAction)

Set the value for Action. (What to do on this final state) This value is mandatory.

Parameters:

newAction - the new value for Action. 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.

setMessageText

void setMessageText(String newMessageText)

Set the value for MessageText. (an operator message to send when this status is reached) This value is optional.

Parameters:

newMessageText - the new value for MessageText.

Throws:

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

setRestartDelayAmount

void setRestartDelayAmount(Long newRestartDelayAmount)

Set the value for RestartDelayAmount. (number of 'restart delay time units' after the finish time of the original job to submit the restart at) This value is mandatory.

Parameters:

newRestartDelayAmount - the new value for RestartDelayAmount. 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.

setRestartDelayUnits

void setRestartDelayUnits(TimeUnit newRestartDelayUnits)

Set the value for RestartDelayUnits. (time units for 'restart delay amount' - seconds, minutes, hours, days. May not be null, defaults to minutes) This value is mandatory.

Parameters:

newRestartDelayUnits - the new value for RestartDelayUnits. 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.

getJobDefinition

JobDefinition getJobDefinition()

Get the JobDefinition.

Returns:

JobDefinition

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.