Package com.redwood.scheduler.api.model

Interface SubmitFrameElement

All Superinterfaces:

Detail, Readable, SchedulerEntity, SchedulerEntityComp

public interface SubmitFrameElement
extends Detail, Readable

An element of a submit frame. An individual interval for which a job may be submitted.

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "SubmitFrameElement" 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<SubmitFrameElement>	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
String	getDescription()	Get the value for Description.
TimeWindow	getDuringTimeWindow()	Get the DuringTimeWindow.
Long	getEveryNumberOf()	Get the value for EveryNumberOf.
Long	getStartTime()	Get the value for StartTime.
TimeZone	getStartTimeZone()	Get the StartTimeZone.
SubmitFrame	getSubmitFrame()	Get the SubmitFrame.
TimeUnit	getUnit()	Get the value for Unit.
boolean	isMustFitTimeWindow()	Get the value for MustFitTimeWindow.
boolean	isPreserveTimes()	Get the value for PreserveTimes.
void	setDescription(String newDescription)	Set the value for Description.
void	setDuringTimeWindow(TimeWindow newDuringTimeWindow)	Set the value for DuringTimeWindow.
void	setEveryNumberOf(Long newEveryNumberOf)	Set the value for EveryNumberOf.
void	setMustFitTimeWindow(boolean newMustFitTimeWindow)	Set the value for MustFitTimeWindow.
void	setPreserveTimes(boolean newPreserveTimes)	Set the value for PreserveTimes.
void	setStartTime(Long newStartTime)	Set the value for StartTime.
void	setStartTimeZone(TimeZone newStartTimeZone)	Set the value for StartTimeZone.
void	setUnit(TimeUnit newUnit)	Set the value for Unit.

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

See Also:

Constant Field Values

TYPE

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

getDescription

String getDescription()

Get the value for Description. (Optional description)

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.

getEveryNumberOf

Long getEveryNumberOf()

Get the value for EveryNumberOf. (The cycle in seconds, minutes, days or months. The unit of measure is specified in the Unit field. )

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.

getUnit

TimeUnit getUnit()

Get the value for Unit. (The unit of measure.)

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.

getStartTime

Long getStartTime()

Get the value for StartTime. (The explicitly defined base start time (in milliseconds from the start of the day).)

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.

isMustFitTimeWindow

boolean isMustFitTimeWindow()

Get the value for MustFitTimeWindow. (Should the element fit the TimeWindow or can we slide forward to the nearest TimeWindow opening?)

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.

isPreserveTimes

boolean isPreserveTimes()

Get the value for PreserveTimes. (Eleminate daylight saving times, so the jobs of such submitframe always run at the same time each day)

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.

setDescription

void setDescription(String newDescription)

Set the value for Description. (Optional description) This value is optional.

Parameters:

newDescription - the new value for Description.

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.

setEveryNumberOf

void setEveryNumberOf(Long newEveryNumberOf)

Set the value for EveryNumberOf. (The cycle in seconds, minutes, days or months. The unit of measure is specified in the Unit field. ) This value is optional.

Parameters:

newEveryNumberOf - the new value for EveryNumberOf.

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.

setUnit

void setUnit(TimeUnit newUnit)

Set the value for Unit. (The unit of measure.) This value is optional.

Parameters:

newUnit - the new value for Unit.

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.

setStartTime

void setStartTime(Long newStartTime)

Set the value for StartTime. (The explicitly defined base start time (in milliseconds from the start of the day).) This value is optional.

Parameters:

newStartTime - the new value for StartTime.

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.

setMustFitTimeWindow

void setMustFitTimeWindow(boolean newMustFitTimeWindow)

Set the value for MustFitTimeWindow. (Should the element fit the TimeWindow or can we slide forward to the nearest TimeWindow opening?)

Parameters:

newMustFitTimeWindow - the new value for MustFitTimeWindow.

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.

setPreserveTimes

void setPreserveTimes(boolean newPreserveTimes)

Set the value for PreserveTimes. (Eleminate daylight saving times, so the jobs of such submitframe always run at the same time each day)

Parameters:

newPreserveTimes - the new value for PreserveTimes.

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.

getSubmitFrame

SubmitFrame getSubmitFrame()

Get the SubmitFrame.

Returns:

SubmitFrame

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.

getDuringTimeWindow

TimeWindow getDuringTimeWindow()

Get the DuringTimeWindow.

Returns:

DuringTimeWindow

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.

getStartTimeZone

TimeZone getStartTimeZone()

Get the StartTimeZone.

Returns:

StartTimeZone

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.

setDuringTimeWindow

void setDuringTimeWindow(TimeWindow newDuringTimeWindow)

Set the value for DuringTimeWindow. This value is optional.

Parameters:

newDuringTimeWindow - is the object to set DuringTimeWindow to. A time window during which the submit frame interval can generate submits

setStartTimeZone

void setStartTimeZone(TimeZone newStartTimeZone)

Set the value for StartTimeZone. This value is optional.

Parameters:

newStartTimeZone - is the object to set StartTimeZone to. Which TimeZone will be used for the start time of the submit frame element.