Package com.redwood.scheduler.api.model

Interface JobGroup

All Superinterfaces:

BusinessKeyObject, ChangeOwner, HasOwner, Readable, Root, SchedulerEntity, SchedulerEntityComp

public interface JobGroup
extends Root, ChangeOwner, HasOwner, BusinessKeyObject, Readable

Common data for a set of similar jobs. This object currently serves two purposes. The first relates to recurrences and submit frames; the JobGroup is used to group all the jobs in the submit frame or recurrence group. This is the case if RecurrencePattern is non-null. The second purpose relates to the specifying where a job should start, via the StartAtValue attribute. This is a large field, so it was put here instead of directly on job.

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "JobGroup" 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<JobGroup>	TYPE	Type that can be used in SchedulerSession.executeObjectQuery(QueryObjectType, String, Object...).

Fields inherited from interface com.redwood.scheduler.api.model.ChangeOwner

CREATED_BY_SUBJECT_FIELD

Fields inherited from interface com.redwood.scheduler.api.model.HasOwner

OWNER_SUBJECT_FIELD

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
DateTimeZone	getChangeOwnerTime()	Get the value for ChangeOwnerTime.
Subject	getCreatedBySubject()	Get the CreatedBySubject.
DateTimeZone	getEndDate()	Get the value for EndDate.
ProcessServer	getForcedProcessServer()	Get the ForcedProcessServer.
Long	getJobCount()	Get the value for JobCount.
JobDefinition	getJobDefinition()	Get the JobDefinition.
TimeZone	getJobTimeZone()	Get the JobTimeZone.
Long	getMaxJobs()	Get the value for MaxJobs.
String	getMinimumOpenDurationExpression()	Get the value for MinimumOpenDurationExpression.
DateTimeZone	getNextSubmitBaseTime()	Get the value for NextSubmitBaseTime.
Subject	getOwnerSubject()	Get the OwnerSubject.
Long	getPresubmitCount()	Get the value for PresubmitCount.
Long	getPriority()	Get the value for Priority.
Queue	getQueue()	Get the Queue.
String	getRecurrencePattern()	Get the value for RecurrencePattern.
String	getStartAtValue()	Get the value for StartAtValue.
JobGroupStatus	getStatus()	Get the value for Status.
SubmitFrame	getSubmitFrame()	Get the SubmitFrame.
TimeWindow	getTimeWindow()	Get the TimeWindow.
TimeZone	getTimeWindowTimeZone()	Get the TimeWindowTimeZone.
boolean	isHoldOnSubmit()	Get the value for HoldOnSubmit.
void	setForcedProcessServer(ProcessServer newForcedProcessServer)	Set the value for ForcedProcessServer.
void	setMinimumOpenDurationExpression(String newMinimumOpenDurationExpression)	Set the value for MinimumOpenDurationExpression.
void	setOwner(Subject newOwner)	Change the owner of the JobGroup.
void	setStartAtValue(String newStartAtValue)	Set the value for StartAtValue.

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

getBusinessKey

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

getCreationTime, getLastModificationTime, getLastModifierSubject

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

See Also:

Constant Field Values

TYPE

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

getChangeOwnerTime

DateTimeZone getChangeOwnerTime()

Get the value for ChangeOwnerTime. (Timestamp that notes when the owner was changed.) 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.

getEndDate

DateTimeZone getEndDate()

Get the value for EndDate. (The job group ends at the defined date and time. )

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.

isHoldOnSubmit

boolean isHoldOnSubmit()

Get the value for HoldOnSubmit. (Should any submitted Job be held by default.)

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.

getJobCount

Long getJobCount()

Get the value for JobCount. (The current number of jobs that have been submitted for this job group. ) 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.

getMaxJobs

Long getMaxJobs()

Get the value for MaxJobs. (The job group ends if the defined maximum of jobs is reached. )

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.

getNextSubmitBaseTime

DateTimeZone getNextSubmitBaseTime()

Get the value for NextSubmitBaseTime. (The time that will be used as a start time for the calculation of the next RequestedStartTime for a Job with a SubmitFrame or a RecurrencePattern.)

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.

getPresubmitCount

Long getPresubmitCount()

Get the value for PresubmitCount. (The number of jobs that is scheduled in advance.) 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.

getPriority

Long getPriority()

Get the value for Priority. (The priority of a job. priority 1-100, higher has precedence; This field only has relevance if the resources or queue size is limited.) 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.

getRecurrencePattern

String getRecurrencePattern()

Get the value for RecurrencePattern. (The recurrence pattern for a job)

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.

getStartAtValue

String getStartAtValue()

Get the value for StartAtValue. (Where jobs in this group should start from.)

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.

getStatus

JobGroupStatus getStatus()

Get the value for Status. (The current status of the job group) 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.

getMinimumOpenDurationExpression

String getMinimumOpenDurationExpression()

Get the value for MinimumOpenDurationExpression. (Default expression for the minimum number of milliseconds that should be available in the TimeWindow of the Job, the Job's Queue or the intersection of both, before this job will be submitted. The value can be a REL expression or a number.)

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.

setStartAtValue

void setStartAtValue(String newStartAtValue)

Set the value for StartAtValue. (Where jobs in this group should start from.) This value is optional.

Parameters:

newStartAtValue - the new value for StartAtValue.

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.

setMinimumOpenDurationExpression

void setMinimumOpenDurationExpression(String newMinimumOpenDurationExpression)

Set the value for MinimumOpenDurationExpression. (Default expression for the minimum number of milliseconds that should be available in the TimeWindow of the Job, the Job's Queue or the intersection of both, before this job will be submitted. The value can be a REL expression or a number.) This value is optional.

Parameters:

newMinimumOpenDurationExpression - the new value for MinimumOpenDurationExpression.

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.

setOwner

void setOwner(Subject newOwner)

Change the owner of the JobGroup. Requires 'changeOwner' global privilege.

Specified by:

setOwner in interface ChangeOwner

Parameters:

newOwner - New owner for the Job Group. The SubjectType must be User.

getForcedProcessServer

ProcessServer getForcedProcessServer()

Get the ForcedProcessServer.

Returns:

ForcedProcessServer

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.

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.

getQueue

Queue getQueue()

Get the Queue.

Returns:

Queue

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.

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.

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.

getTimeWindowTimeZone

TimeZone getTimeWindowTimeZone()

Get the TimeWindowTimeZone.

Returns:

TimeWindowTimeZone

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.

getJobTimeZone

TimeZone getJobTimeZone()

Get the JobTimeZone.

Returns:

JobTimeZone

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.

getOwnerSubject

Subject getOwnerSubject()

Get the OwnerSubject.

Specified by:

getOwnerSubject in interface HasOwner

Returns:

OwnerSubject

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.

getCreatedBySubject

Subject getCreatedBySubject()

Get the CreatedBySubject.

Specified by:

getCreatedBySubject in interface ChangeOwner

Returns:

CreatedBySubject

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.

setForcedProcessServer

void setForcedProcessServer(ProcessServer newForcedProcessServer)

Set the value for ForcedProcessServer. This value is optional.

Parameters:

newForcedProcessServer - is the object to set ForcedProcessServer to. The process server on which the jobs of this job must run, regardless of other possibilities.