Package com.redwood.scheduler.api.model

Interface Precondition

All Superinterfaces:

Detail, SchedulerEntity, SchedulerEntityComp

All Known Subinterfaces:

JobChainCallPrecondition, JobChainCallRaiseEvent, JobChainCallWaitEvent, JobChainStepPrecondition, JobDefinitionRaiseEvent, JobDefinitionWaitEvent, JobRaiseEvent, JobWaitEvent, RaiseEvent, WaitEvent

public interface Precondition
extends Detail

A precondition checks whether the step should be executed or skipped The execution of steps and script calls may be dependent upon specific circumstances, such as specific days of the week or the outcome of another job. In job chains you define these conditions as pre-conditions to steps or script calls.

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	getExpression()	Get the value for Expression.
TimeWindow	getTimeWindow()	Get the TimeWindow.
TimeWindowStatus	getTimeWindowStatus()	Get the value for TimeWindowStatus.
TimeZone	getTimeZone()	Get the TimeZone.
void	setExpression(String newExpression)	Set the value for Expression.
void	setTimeWindow(TimeWindow newTimeWindow)	Set the value for TimeWindow.
void	setTimeWindowStatus(TimeWindowStatus newTimeWindowStatus)	Set the value for TimeWindowStatus.
void	setTimeZone(TimeZone newTimeZone)	Set the value for TimeZone.

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

getExpression

String getExpression()

Get the value for Expression. (Expression to evaluate as the precondition.)

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.

getTimeWindowStatus

TimeWindowStatus getTimeWindowStatus()

Get the value for TimeWindowStatus. (The status of the time window (open or closed) for the precondition to be true.) 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.

setExpression

void setExpression(String newExpression)

Set the value for Expression. (Expression to evaluate as the precondition.) This value is optional.

Parameters:

newExpression - the new value for Expression.

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.

setTimeWindowStatus

void setTimeWindowStatus(TimeWindowStatus newTimeWindowStatus)

Set the value for TimeWindowStatus. (The status of the time window (open or closed) for the precondition to be true.) This value is mandatory.

Parameters:

newTimeWindowStatus - the new value for TimeWindowStatus. 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.

getTimeWindow

TimeWindow getTimeWindow()

Get the TimeWindow.

Returns:

TimeWindow

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.

getTimeZone

TimeZone getTimeZone()

Get the TimeZone.

Returns:

TimeZone

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.

setTimeWindow

void setTimeWindow(TimeWindow newTimeWindow)

Set the value for TimeWindow. This value is optional.

Parameters:

newTimeWindow - is the object to set TimeWindow to. Optional time precondition for a call.

setTimeZone

void setTimeZone(TimeZone newTimeZone)

Set the value for TimeZone. This value is optional.

Parameters:

newTimeZone - is the object to set TimeZone to. The timezone for the timewindowinterval