Package com.redwood.scheduler.api.model

Interface JobDefinitionRaiseEvent

All Superinterfaces:

Branchable, Detail, Precondition, RaiseEvent, Readable, SchedulerEntity, SchedulerEntityComp

public interface JobDefinitionRaiseEvent
extends RaiseEvent, Branchable, Readable

The Event to be raised when the Job reaches a certain state.

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "JobDefinitionRaiseEvent" 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<JobDefinitionRaiseEvent>	TYPE	Type that can be used in SchedulerSession.executeObjectQuery(QueryObjectType, String, Object...).

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

KEY_JOBDEFINITION, KEY_JOBDEFINITION_NAME, KEY_JOBDEFINITION_PARTITION, KEY_JOBDESCRIPTION, KEY_JOBID, KEY_JOBSTATUS

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
EventDefinition	getEventDefinition()	Get the EventDefinition.
JobDefinition	getJobDefinition()	Get the JobDefinition.
boolean	isMasterVersion()	Get the value for MasterVersion.
void	setEventDefinition(EventDefinition newEventDefinition)	Set the value for EventDefinition.

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

getExpression, getTimeWindow, getTimeWindowStatus, getTimeZone, setExpression, setTimeWindow, setTimeWindowStatus, setTimeZone

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

getErrorCode, getRaiseComment, getStatusToRaiseOn, setErrorCode, setRaiseComment, setStatusToRaiseOn

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

See Also:

Constant Field Values

TYPE

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

isMasterVersion

boolean isMasterVersion()

Get the value for MasterVersion. (Whether this object belongs to a master object or not.)

Specified by:

isMasterVersion in interface Branchable

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.

getEventDefinition

EventDefinition getEventDefinition()

Get the EventDefinition.

Returns:

EventDefinition

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.

getJobDefinition

JobDefinition getJobDefinition()

Get the JobDefinition.

Returns:

JobDefinition

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.

setEventDefinition

void setEventDefinition(EventDefinition newEventDefinition)

Set the value for EventDefinition. This value is mandatory.

Parameters:

newEventDefinition - is the object to set EventDefinition to. Which EventDefinition will be raised when the job reaches a particular status? If this is null, then the object cannot be persisted.