Package com.redwood.scheduler.api.model

Interface JobRaiseEvent

All Superinterfaces:

BusinessKeyObject, Detail, Precondition, RaiseEvent, Readable, SchedulerEntity, SchedulerEntityComp

public interface JobRaiseEvent
extends RaiseEvent, BusinessKeyObject, Readable

Events that will be raised when the job reaches a certain state. Contains the list of job statuses that the system will raise an event for when the job reaches that status. When the job status cannot possibly reach that status anymore, the Obsolete attribute will be set.

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "JobRaiseEvent" 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<JobRaiseEvent>	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
Event	getEvent()	Get the Event.
EventDefinition	getEventDefinition()	Get the EventDefinition.
Job	getJob()	Get the Job.
boolean	isEventAlreadyRaised()	Get the value for EventAlreadyRaised.
void	setEvent(Event newEvent)	Set the value for Event.
void	setEventDefinition(EventDefinition newEventDefinition)	Set the value for EventDefinition.

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

getBusinessKey

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

See Also:

Constant Field Values

TYPE

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

isEventAlreadyRaised

boolean isEventAlreadyRaised()

Get the value for EventAlreadyRaised. (Has the event already been raised for this Job? If so, then it does not need to be raised again.)

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.

getJob

Job getJob()

Get the Job.

Returns:

Job

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.

getEvent

Event getEvent()

Get the Event.

Returns:

Event

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.

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.

setEvent

void setEvent(Event newEvent)

Set the value for Event. This value is optional.

Parameters:

newEvent - is the object to set Event to. If this is set, then the associated Job raised this instance of its associated EventDefinition.

setEventDefinition

void setEventDefinition(EventDefinition newEventDefinition)

Set the value for EventDefinition. This value is mandatory.

Parameters:

newEventDefinition - is the object to set EventDefinition to. The event definition to raise for a job raise event. If this is null, then the object cannot be persisted.