Package com.redwood.scheduler.api.model

Interface JobDefinitionWaitEvent

All Superinterfaces:

Branchable, Detail, Precondition, Readable, SchedulerEntity, SchedulerEntityComp, WaitEvent

public interface JobDefinitionWaitEvent
extends WaitEvent, Branchable, Readable

The events that a job definition will wait for before starting. Jobs from this job definition will wait for these events before running.

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "JobDefinitionWaitEvent" 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<JobDefinitionWaitEvent>	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
WaitEventSubmitType	getAutoSubmit()	Get the value for AutoSubmit.
EventDefinition	getEventDefinition()	Get the EventDefinition.
JobDefinition	getJobDefinition()	Get the JobDefinition.
boolean	isCreatedBySystem()	Get the value for CreatedBySystem.
boolean	isMasterVersion()	Get the value for MasterVersion.
void	setAutoSubmit(WaitEventSubmitType newAutoSubmit)	Set the value for AutoSubmit.
void	setCreatedBySystem(boolean newCreatedBySystem)	Set the value for CreatedBySystem.
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.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 "JobDefinitionWaitEvent" objects.

See Also:

Constant Field Values

TYPE

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

getAutoSubmit

WaitEventSubmitType getAutoSubmit()

Get the value for AutoSubmit. (Should the JobDefinition be submitted automatically when the event is raised?) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.

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.

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.

isCreatedBySystem

boolean isCreatedBySystem()

Get the value for CreatedBySystem. (Has this JobDefinitionWaitEvent been created behind the scenes?)

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.

setAutoSubmit

void setAutoSubmit(WaitEventSubmitType newAutoSubmit)

Set the value for AutoSubmit. (Should the JobDefinition be submitted automatically when the event is raised?) This value is mandatory.

Parameters:

newAutoSubmit - the new value for AutoSubmit. If this is null, then the object cannot be persisted.

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.

setCreatedBySystem

void setCreatedBySystem(boolean newCreatedBySystem)

Set the value for CreatedBySystem. (Has this JobDefinitionWaitEvent been created behind the scenes?)

Parameters:

newCreatedBySystem - the new value for CreatedBySystem.

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.

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.

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.

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.