Package com.redwood.scheduler.api.model

Interface WaitEvent

All Superinterfaces:

Detail, Precondition, SchedulerEntity, SchedulerEntityComp

All Known Subinterfaces:

JobChainCallWaitEvent, JobDefinitionWaitEvent, JobWaitEvent

public interface WaitEvent
extends Precondition

This holds all of the fields common to JobWaitEvent, JobDefinitionWaitEvent and JobChainCallWaitEvent.

Field Summary

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
String	getClearComment()	Get the value for ClearComment.
boolean	isClearsEvent()	Get the value for ClearsEvent.
void	setClearComment(String newClearComment)	Set the value for ClearComment.
void	setClearsEvent(boolean newClearsEvent)	Set the value for ClearsEvent.

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

Method Detail

isClearsEvent

boolean isClearsEvent()

Get the value for ClearsEvent. (Is the event cleared by this wait event?)

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.

getClearComment

String getClearComment()

Get the value for ClearComment. (Comment to set as clearComment on the event if this WaitEvent clears the event.)

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.

setClearsEvent

void setClearsEvent(boolean newClearsEvent)

Set the value for ClearsEvent. (Is the event cleared by this wait event?)

Parameters:

newClearsEvent - the new value for ClearsEvent.

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.

setClearComment

void setClearComment(String newClearComment)

Set the value for ClearComment. (Comment to set as clearComment on the event if this WaitEvent clears the event.) This value is optional.

Parameters:

newClearComment - the new value for ClearComment.

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.