Package com.redwood.scheduler.api.model

Interface JobWaitEvent

All Superinterfaces:

BusinessKeyObject, Detail, Precondition, Readable, SchedulerEntity, SchedulerEntityComp, WaitEvent

public interface JobWaitEvent
extends WaitEvent, BusinessKeyObject, Readable

Events that need to be raised before the job runs At the moment job would go to the QUEUED status the job definition EventExpression is calculated. A null expression is equivalent to (event1 and event2 and ...), that is all events need to be raised. If the event expression does not return true, the job goes to the EVENTWAIT status until one or more events are raised or cleared and the event expression does return true.

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "JobWaitEvent" 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<JobWaitEvent>	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
EventDefinition	getEventDefinition()	Get the EventDefinition.
Job	getJob()	Get the Job.
Event	getRaisedEvent()	Get the RaisedEvent.
boolean	isRaised()	Get the value for Raised.
void	setEventDefinition(EventDefinition newEventDefinition)	Set the value for EventDefinition.
void	setRaisedEvent(Event newRaisedEvent)	Set the value for RaisedEvent.

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.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

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

getClearComment, isClearsEvent, setClearComment, setClearsEvent

Field Detail

OBJECT_TYPE

static final String OBJECT_TYPE

String that will be returned from SchedulerEntity.getObjectType() for "JobWaitEvent" objects.

See Also:

Constant Field Values

TYPE

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

isRaised

boolean isRaised()

Get the value for Raised. (Has this JobWaitEvent had its event raised?)

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.

getRaisedEvent

Event getRaisedEvent()

Get the RaisedEvent.

Returns:

RaisedEvent

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.

setRaisedEvent

void setRaisedEvent(Event newRaisedEvent)

Set the value for RaisedEvent. This value is optional.

Parameters:

newRaisedEvent - is the object to set RaisedEvent to. If this is set, then the associated Job no longer needs to wait on 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. Which EventDefinition must be raised before this WaitEvent is satisfied? If this is null, then the object cannot be persisted.