All Superinterfaces:

ActionSubjectObject, ApplicationObject, Branchable, BranchedUniqueNamedApplicationObject, BusinessKeyObject, ChangeOwner, ExecutableSchedulerEntity, HasOwner, JobDefinitionComp, NamedRootObject, NamedRootObjectComp, PartitionableObject, PartitionableObjectComp, Readable, Root, SchedulerEntity, SchedulerEntityComp
```
public interface JobDefinition
extends JobDefinitionComp, BranchedUniqueNamedApplicationObject, ActionSubjectObject, ChangeOwner, HasOwner, ExecutableSchedulerEntity, Readable
```
A job definition defines what a job does. Depending on the job definition type, you can create a job definition. Some job definition types are logical job definition types; job definitions of these types are imported from remote systems. These job definitions cannot be created directly; you duplicate template job definitions and set parameters to perform the required actions.
Most job definition types have a Script child object which contains the actual commands to execute. The syntax depends on the job definition type; parameters are accessed in the native form. CSH example: setenv PARAMETER1 "/opt/app/bin"
CMD example:set PARAMETER1="c:\opt\app\bin"
Time windows, queue limits, locks, and events are used to control when a job definition can be run as a job.

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`INTERNAL_CHAIN`	The name prefix for internal chains.
`static String`	`OBJECT_TYPE`	String that will be returned from `SchedulerEntity.getObjectType()` for "JobDefinition" objects.
`static String`	`SEC_PRIV_CREATE`	This privilege can be granted at a group level.
`static String`	`SEC_PRIV_DELETE`	This privilege can be granted at a group level.
`static String`	`SEC_PRIV_EDIT`	This privilege can be granted at a group level.
`static String`	`SEC_PRIV_EDITJOBS`	This privilege can be granted at a group level.
`static String`	`SEC_PRIV_SUBMIT`	This privilege can be granted at a group level.
`static String`	`SEC_PRIV_VIEW`	This privilege can be granted at a group level.
`static String`	`SEC_PRIV_VIEWJOBS`	This privilege can be granted at a group level.
`static String`	`SEC_RANK_ALL`	This rank is made of the following privileges: create , view , viewJobs , submit , editJobs , edit , delete
`static String`	`SEC_RANK_CREATE`	This rank is made of the following privileges: create
`static String`	`SEC_RANK_DELETE`	This rank is made of the following privileges: create , view , viewJobs , editJobs , submit , delete
`static String`	`SEC_RANK_EDIT`	This rank is made of the following privileges: create , view , viewJobs , editJobs , submit , edit
`static String`	`SEC_RANK_EDITJOBS`	This rank is made of the following privileges: view , viewJobs , submit , editJobs
`static String`	`SEC_RANK_NONE`	This rank has no privileges assigned to it.
`static String`	`SEC_RANK_SUBMIT`	This rank is made of the following privileges: view , submit
`static String`	`SEC_RANK_SUBMITANDVIEW`	This rank is made of the following privileges: view , viewJobs , submit
`static String`	`SEC_RANK_VIEW`	This rank is made of the following privileges: view
`static String`	`SEC_RANK_VIEWJOBS`	This rank is made of the following privileges: view , viewJobs
`static QueryObjectType<JobDefinition>`	`TYPE`	Type that can be used in `SchedulerSession.executeObjectQuery(QueryObjectType, String, Object...)`.

Fields inherited from interface com.redwood.scheduler.api.model.BranchedUniqueNamedApplicationObject
MASTER

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

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`cancelNonFinalJobs()`	Cancel all jobs of this JobDefinition that have a non final status.
`RequiredPermission`	`checkCreatePrivilege()`	Check whether or not the create action can be performed on this object.
`RequiredPermission`	`checkDeletePrivilege()`	Check whether or not the delete action can be performed on this object.
`RequiredPermission`	`checkEditJobsPrivilege()`	Check whether or not the editJobs action can be performed on this object.
`RequiredPermission`	`checkEditPrivilege()`	Check whether or not the edit action can be performed on this object.
`RequiredPermission`	`checkSubmitPrivilege()`	Check whether or not the submit action can be performed on this object.
`RequiredPermission`	`checkViewJobsPrivilege()`	Check whether or not the viewJobs action can be performed on this object.
`RequiredPermission`	`checkViewPrivilege()`	Check whether or not the view action can be performed on this object.
`ConstraintContext`	`createConstraintContext()`	Create a ConstraintContext so that the constraints can be verified.
`void`	`createEquivalentObject(boolean quotePartition, boolean quoteJobDefinition)`	Create an equivalent object in the database for calling this job definition.
`FinalStatusHandler`	`createFinalStatusHandler()`	Create a new `FinalStatusHandler` linked to this object.
`JobDefinitionAction`	`createJobDefinitionAction()`	Create a new `JobDefinitionAction` linked to this object.
`JobDefinitionConstraint`	`createJobDefinitionConstraint(ConstraintDefinition newConstraintDefinition)`	Create a new `JobDefinitionConstraint` linked to this object.
`JobDefinitionForm`	`createJobDefinitionForm()`	Create a new `JobDefinitionForm` linked to this object.
`JobDefinitionJobLock`	`createJobDefinitionJobLock(JobLock newJobLock)`	Create a new `JobDefinitionJobLock` linked to this object.
`JobDefinitionParameter`	`createJobDefinitionParameter()`	Create a new `JobDefinitionParameter` linked to this object.
`JobDefinitionProcessMonitorUpdater`	`createJobDefinitionProcessMonitorUpdater()`	Create a new `JobDefinitionProcessMonitorUpdater` linked to this object.
`JobDefinitionRaiseEvent`	`createJobDefinitionRaiseEvent()`	Create a new `JobDefinitionRaiseEvent` linked to this object.
`JobDefinitionRuntimeLimit`	`createJobDefinitionRuntimeLimit()`	Create a new `JobDefinitionRuntimeLimit` linked to this object.
`JobDefinitionWaitEvent`	`createJobDefinitionWaitEvent()`	Create a new `JobDefinitionWaitEvent` linked to this object.
`JobFileSearch`	`createJobFileSearch()`	Create a new `JobFileSearch` linked to this object.
`PublishedWebService`	`createPublishedWebService()`	Create a new `PublishedWebService` linked to this object.
`Statistics`	`createStatistics()`	Create a new `Statistics` linked to this object.
`void`	`deleteFinalJobs()`	Delete all jobs of this JobDefinition that have a final status.
`JobDefinition`	`duplicate()`	Duplicate the JobDefinition.
`Subject`	`getActionSubject()`	Get the ActionSubject.
`Long`	`getAverageLogFilesize()`	Get the value for AverageLogFilesize.
`Long`	`getAverageOutputFilesize()`	Get the value for AverageOutputFilesize.
`Long`	`getAverageRunTime()`	Get the value for AverageRunTime.
`DateTimeZone`	`getChangeOwnerTime()`	Get the value for ChangeOwnerTime.
`CompletionStrategyType`	`getCompletionStrategy()`	Get the value for CompletionStrategy.
`Subject`	`getCreatedBySubject()`	Get the CreatedBySubject.
`Format`	`getDefaultLogFormat()`	Get the DefaultLogFormat.
`Format`	`getDefaultOutputFormat()`	Get the DefaultOutputFormat.
`Queue`	`getDefaultQueue()`	Get the DefaultQueue.
`Long`	`getDeprecated2()`	Get the value for Deprecated2.
`OwnerType`	`getEvaluationOwnerType()`	Get the value for EvaluationOwnerType.
`Long`	`getExecutionCompletedCount()`	Get the value for ExecutionCompletedCount.
`Long`	`getExecutionErrorCount()`	Get the value for ExecutionErrorCount.
`FinalStatusHandler`	`getFinalStatusHandlerByStatus(JobStatus status)`	Get the FinalStatusHandler by JobDefinitionStatus.
`RWIterable<FinalStatusHandler>`	`getFinalStatusHandlers()`	Get an `RWIterable` over an ordered collection of `FinalStatusHandlers`.
`RWIterable<JobChainCall>`	`getJobChainCalls()`	Get an `RWIterable` over an ordered collection of `JobChainCalls`.
`JobDefinitionAction`	`getJobDefinitionActionByType(JobDefinitionActionType type)`	Get the JobDefinitionAction by JobDefinitionActionType.
`RWIterable<JobDefinitionAction>`	`getJobDefinitionActions()`	Get an `RWIterable` over an ordered collection of `JobDefinitionActions`.
`JobDefinitionConstraint`	`getJobDefinitionConstraintByName(String name)`	Get the JobDefinitionConstraint by JobDefinitionJobDefinitionConstraintName.
`RWIterable<JobDefinitionConstraint>`	`getJobDefinitionConstraints()`	Get an `RWIterable` over an ordered collection of `JobDefinitionConstraints`.
`JobDefinitionForm`	`getJobDefinitionFormByName(String name)`	Get the JobDefinitionForm by JobDefinitionName.
`RWIterable<JobDefinitionForm>`	`getJobDefinitionForms()`	Get an `RWIterable` over an ordered collection of `JobDefinitionForms`.
`JobDefinitionJobLock`	`getJobDefinitionJobLockByJobLock(JobLock jobLock)`	Get the JobDefinitionJobLock by JobDefinitionJobLock.
`RWIterable<JobDefinitionJobLock>`	`getJobDefinitionJobLocks()`	Get an `RWIterable` over an ordered collection of `JobDefinitionJobLocks`.
`JobDefinitionParameter`	`getJobDefinitionParameterByName(String name)`	Get the JobDefinitionParameter by JobDefinitionName.
`RWIterable<JobDefinitionParameter>`	`getJobDefinitionParameters()`	Get an `RWIterable` over a collection of `JobDefinitionParameters`, the collection will be ordered by DisplayOrder.
`RWIterable<JobDefinitionProcessMonitorUpdater>`	`getJobDefinitionProcessMonitorUpdaters()`	Get an `RWIterable` over an ordered collection of `JobDefinitionProcessMonitorUpdaters`.
`RWIterable<JobDefinitionRaiseEvent>`	`getJobDefinitionRaiseEvents()`	Get an `RWIterable` over an ordered collection of `JobDefinitionRaiseEvents`.
`JobDefinitionRelatedObject`	`getJobDefinitionRelatedObject()`	Get the value for JobDefinitionRelatedObject.
`JobDefinitionRuntimeLimit`	`getJobDefinitionRuntimeLimitByName(String name)`	Get the JobDefinitionRuntimeLimit by JobDefinitionName.
`RWIterable<JobDefinitionRuntimeLimit>`	`getJobDefinitionRuntimeLimits()`	Get an `RWIterable` over an ordered collection of `JobDefinitionRuntimeLimits`.
`JobDefinitionType`	`getJobDefinitionType()`	Get the JobDefinitionType.
`RWIterable<JobDefinitionWaitEvent>`	`getJobDefinitionWaitEvents()`	Get an `RWIterable` over an ordered collection of `JobDefinitionWaitEvents`.
`JobFileSearch`	`getJobFileSearchByProcessingOrder(Long processingOrder)`	Get the JobFileSearch by JobDefinitionProcessingOrder.
`RWIterable<JobFileSearch>`	`getJobFileSearches()`	Get an `RWIterable` over an ordered collection of `JobFileSearches`.
`TimeZone`	`getJobTimeZone()`	Get the JobTimeZone.
`Long`	`getKeepAmount()`	Get the value for KeepAmount.
`Long`	`getKeepInStatusAmount()`	Get the value for KeepInStatusAmount.
`JobDefinitionKeepUnit`	`getKeepInStatusUnit()`	Get the value for KeepInStatusUnit.
`String`	`getKeepJobsInStatus()`	Get the value for KeepJobsInStatus.
`JobDefinitionKeepType`	`getKeepType()`	Get the value for KeepType.
`JobDefinitionKeepUnit`	`getKeepUnits()`	Get the value for KeepUnits.
`JobDefinition`	`getMasterJobDefinition()`	Get the MasterJobDefinition.
`Long`	`getMaximumRunTime()`	Get the value for MaximumRunTime.
`Long`	`getMaxPriority()`	Get the value for MaxPriority.
`String`	`getMinimumOpenDurationExpression()`	Get the value for MinimumOpenDurationExpression.
`Long`	`getMinimumRunTime()`	Get the value for MinimumRunTime.
`EventDefinition`	`getOverdueEventDefinition()`	Get the OverdueEventDefinition.
`JobStatus`	`getOverdueStatus()`	Get the value for OverdueStatus.
`String`	`getOverviewFormat()`	Get the value for OverviewFormat.
`Subject`	`getOwnerSubject()`	Get the OwnerSubject.
`Long`	`getPriority()`	Get the value for Priority.
`RWIterable<PublishedWebService>`	`getPublishedWebServices()`	Get an `RWIterable` over an ordered collection of `PublishedWebServices`.
`ReactionJobType`	`getReactionJobType()`	Get the value for ReactionJobType.
`Library`	`getRELRelatedLibrary()`	Get the RELRelatedLibrary.
`Resource`	`getResource()`	Get the Resource.
`Long`	`getRestartCount()`	Get the value for RestartCount.
`String`	`getReturncodeMapToCompleted()`	Get the value for ReturncodeMapToCompleted.
`BigDecimal`	`getStandardDeviationLogFilesize()`	Get the value for StandardDeviationLogFilesize.
`BigDecimal`	`getStandardDeviationOutputFilesize()`	Get the value for StandardDeviationOutputFilesize.
`BigDecimal`	`getStandardDeviationRunTime()`	Get the value for StandardDeviationRunTime.
`RWIterable<Statistics>`	`getStatistics()`	Get an `RWIterable` over an ordered collection of `Statistics`.
`Statistics`	`getStatisticsByKeyParameters(Map<String,String> keyParameters)`	Get a statistics object associated to this JobDefinition.
`TimeWindow`	`getTimeWindow()`	Get the TimeWindow.
`TimeZone`	`getTimeWindowTimeZone()`	Get the TimeWindowTimeZone.
`Validity`	`getValidity()`	Get the value for Validity.
`Set<Variable>`	`getVariables()`	Get the Set of Variables related to JobDefinition objects.
`boolean`	`isCriticalProcess()`	Get the value for CriticalProcess.
`boolean`	`isDiscarded()`	Get the value for Discarded.
`boolean`	`isEquivalentObject()`	Get the value for EquivalentObject.
`boolean`	`isHoldOnSubmit()`	Get the value for HoldOnSubmit.
`boolean`	`isInternalChain()`	The JobDefinition is considered internal and should be excluded in some cases
`boolean`	`isKeepForce()`	Get the value for KeepForce.
`boolean`	`isMaintenance()`	Get the value for Maintenance.
`boolean`	`isMonitorSchedule()`	Get the value for MonitorSchedule.
`boolean`	`isOverdue()`	Get the value for Overdue.
`boolean`	`isTemplate()`	Get the value for Template.
`boolean`	`isTopLevel()`	Get the value for TopLevel.
`Job`	`prepare()`	Prepare a job based on this job definition for submission.
`void`	`resetStatistics()`	Reset the counters and statistics for this job-definition.
`void`	`setActionSubject(Subject newActionSubject)`	Set the value for ActionSubject.
`void`	`setCompletionStrategy(CompletionStrategyType newCompletionStrategy)`	Set the value for CompletionStrategy.
`void`	`setCriticalProcess(boolean newCriticalProcess)`	Set the value for CriticalProcess.
`void`	`setDefaultLogFormat(Format newDefaultLogFormat)`	Set the value for DefaultLogFormat.
`void`	`setDefaultOutputFormat(Format newDefaultOutputFormat)`	Set the value for DefaultOutputFormat.
`void`	`setDefaultQueue(Queue newDefaultQueue)`	Set the value for DefaultQueue.
`void`	`setDiscarded(boolean newDiscarded)`	Set the value for Discarded.
`void`	`setEquivalentObject(boolean newEquivalentObject)`	Set the value for EquivalentObject.
`void`	`setEvaluationOwnerType(OwnerType newEvaluationOwnerType)`	Set the value for EvaluationOwnerType.
`void`	`setHoldOnSubmit(boolean newHoldOnSubmit)`	Set the value for HoldOnSubmit.
`void`	`setJobDefinitionType(JobDefinitionType newJobDefinitionType)`	Set the value for JobDefinitionType.
`void`	`setJobTimeZone(TimeZone newJobTimeZone)`	Set the value for JobTimeZone.
`void`	`setKeepAmount(Long newKeepAmount)`	Set the value for KeepAmount.
`void`	`setKeepForce(boolean newKeepForce)`	Set the value for KeepForce.
`void`	`setKeepInStatusAmount(Long newKeepInStatusAmount)`	Set the value for KeepInStatusAmount.
`void`	`setKeepInStatusUnit(JobDefinitionKeepUnit newKeepInStatusUnit)`	Set the value for KeepInStatusUnit.
`void`	`setKeepJobsInStatus(String newKeepJobsInStatus)`	Set the value for KeepJobsInStatus.
`void`	`setKeepType(JobDefinitionKeepType newKeepType)`	Set the value for KeepType.
`void`	`setKeepUnits(JobDefinitionKeepUnit newKeepUnits)`	Set the value for KeepUnits.
`void`	`setMaintenance(boolean newMaintenance)`	Set the value for Maintenance.
`void`	`setMasterJobDefinition(JobDefinition newMasterJobDefinition)`	Set the value for MasterJobDefinition.
`void`	`setMaxPriority(Long newMaxPriority)`	Set the value for MaxPriority.
`void`	`setMinimumOpenDurationExpression(String newMinimumOpenDurationExpression)`	Set the value for MinimumOpenDurationExpression.
`void`	`setMonitorSchedule(boolean newMonitorSchedule)`	Set the value for MonitorSchedule.
`void`	`setOverdue(boolean newOverdue)`	Set the value for Overdue.
`void`	`setOverdueEventDefinition(EventDefinition newOverdueEventDefinition)`	Set the value for OverdueEventDefinition.
`void`	`setOverdueStatus(JobStatus newOverdueStatus)`	Set the value for OverdueStatus.
`void`	`setOverviewFormat(String newOverviewFormat)`	Set the value for OverviewFormat.
`void`	`setOwner(Subject newOwner)`	Change the owner of the JobDefinition.
`void`	`setPriority(Long newPriority)`	Set the value for Priority.
`void`	`setReactionJobType(ReactionJobType newReactionJobType)`	Set the value for ReactionJobType.
`void`	`setRELRelatedLibrary(Library newRELRelatedLibrary)`	Set the value for RELRelatedLibrary.
`void`	`setResource(Resource newResource)`	Set the value for Resource.
`void`	`setRestartCount(Long newRestartCount)`	Set the value for RestartCount.
`void`	`setReturncodeMapToCompleted(String newReturncodeMapToCompleted)`	Set the value for ReturncodeMapToCompleted.
`void`	`setTemplate(boolean newTemplate)`	Set the value for Template.
`void`	`setTimeWindow(TimeWindow newTimeWindow)`	Set the value for TimeWindow.
`void`	`setTimeWindowTimeZone(TimeZone newTimeWindowTimeZone)`	Set the value for TimeWindowTimeZone.
`void`	`setTopLevel(boolean newTopLevel)`	Set the value for TopLevel.

Methods inherited from interface com.redwood.scheduler.api.model.interfaces.ActionSubjectObject
getActionSubjectUniqueId

Methods inherited from interface com.redwood.scheduler.api.model.ApplicationObject
getParentApplication, setParentApplication

Methods inherited from interface com.redwood.scheduler.api.model.BranchedUniqueNamedApplicationObject
getBranchedLastModificationTime, getBranchedLLPVersion, isCurrentNonMaster, isMasterVersion

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

Methods inherited from interface com.redwood.scheduler.api.model.NamedRootObject
createObjectReference, getComment, getDescription, getLinkedObjectReferenceByLinkedObject, getLinkedObjectReferenceByName, getLinkedObjectReferences, getName, getSearchName, getSourceObjectReferences, isHidden, setComment, setDescription, setName

Methods inherited from interface com.redwood.scheduler.api.model.PartitionableObject
createObjectTag, getEditablePartitions, getObjectTagByObjectTagDefinition, getObjectTags, getPartition, setPartition

Methods inherited from interface com.redwood.scheduler.api.model.Root
getCreationTime, getLastModificationTime, getLastModifierSubject

- Field Detail
  - OBJECT_TYPE
```
static final String OBJECT_TYPE
```
    String that will be returned from SchedulerEntity.getObjectType() for "JobDefinition" objects.
    
    See Also:
    
    Constant Field Values
  - TYPE
```
static final QueryObjectType<JobDefinition> TYPE
```
    Type that can be used in SchedulerSession.executeObjectQuery(QueryObjectType, String, Object...).
  - INTERNAL_CHAIN
```
static final String INTERNAL_CHAIN
```
    The name prefix for internal chains.
    
    See Also:
    
    Constant Field Values
  - SEC_PRIV_CREATE
```
static final String SEC_PRIV_CREATE
```
    This privilege can be granted at a group level.
    
    See Also:
    
    Constant Field Values
  - SEC_PRIV_VIEW
```
static final String SEC_PRIV_VIEW
```
    This privilege can be granted at a group level. This privilege can be granted at an instance level.
    
    See Also:
    
    Constant Field Values
  - SEC_PRIV_VIEWJOBS
```
static final String SEC_PRIV_VIEWJOBS
```
    This privilege can be granted at a group level. This privilege can be granted at an instance level.
    
    See Also:
    
    Constant Field Values
  - SEC_PRIV_SUBMIT
```
static final String SEC_PRIV_SUBMIT
```
    This privilege can be granted at a group level. This privilege can be granted at an instance level.
    
    See Also:
    
    Constant Field Values
  - SEC_PRIV_EDITJOBS
```
static final String SEC_PRIV_EDITJOBS
```
    This privilege can be granted at a group level. This privilege can be granted at an instance level.
    
    See Also:
    
    Constant Field Values
  - SEC_PRIV_EDIT
```
static final String SEC_PRIV_EDIT
```
    This privilege can be granted at a group level. This privilege can be granted at an instance level.
    
    See Also:
    
    Constant Field Values
  - SEC_PRIV_DELETE
```
static final String SEC_PRIV_DELETE
```
    This privilege can be granted at a group level. This privilege can be granted at an instance level.
    
    See Also:
    
    Constant Field Values
  - SEC_RANK_NONE
```
static final String SEC_RANK_NONE
```
    This rank has no privileges assigned to it.
    
    See Also:
    
    Constant Field Values
  - SEC_RANK_CREATE
```
static final String SEC_RANK_CREATE
```
    This rank is made of the following privileges: create
    
    See Also:
    
    Constant Field Values
  - SEC_RANK_VIEW
```
static final String SEC_RANK_VIEW
```
    This rank is made of the following privileges: view
    
    See Also:
    
    Constant Field Values
  - SEC_RANK_VIEWJOBS
```
static final String SEC_RANK_VIEWJOBS
```
    This rank is made of the following privileges: view , viewJobs
    
    See Also:
    
    Constant Field Values
  - SEC_RANK_SUBMIT
```
static final String SEC_RANK_SUBMIT
```
    This rank is made of the following privileges: view , submit
    
    See Also:
    
    Constant Field Values
  - SEC_RANK_SUBMITANDVIEW
```
static final String SEC_RANK_SUBMITANDVIEW
```
    This rank is made of the following privileges: view , viewJobs , submit
    
    See Also:
    
    Constant Field Values
  - SEC_RANK_EDITJOBS
```
static final String SEC_RANK_EDITJOBS
```
    This rank is made of the following privileges: view , viewJobs , submit , editJobs
    
    See Also:
    
    Constant Field Values
  - SEC_RANK_EDIT
```
static final String SEC_RANK_EDIT
```
    This rank is made of the following privileges: create , view , viewJobs , editJobs , submit , edit
    
    See Also:
    
    Constant Field Values
  - SEC_RANK_DELETE
```
static final String SEC_RANK_DELETE
```
    This rank is made of the following privileges: create , view , viewJobs , editJobs , submit , delete
    
    See Also:
    
    Constant Field Values
  - SEC_RANK_ALL
```
static final String SEC_RANK_ALL
```
    This rank is made of the following privileges: create , view , viewJobs , submit , editJobs , edit , delete
    
    See Also:
    
    Constant Field Values
- Method Detail
  - isEquivalentObject
```
boolean isEquivalentObject()
```
    Get the value for EquivalentObject. (Whether an equivalent object should be created in the database to call this 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.
  - getAverageLogFilesize
```
Long getAverageLogFilesize()
```
    Get the value for AverageLogFilesize. (Statistic: The average total size of log job-files for the jobs of this JobDefinition, rounded to the nearest integer.)
    
    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.
  - getAverageOutputFilesize
```
Long getAverageOutputFilesize()
```
    Get the value for AverageOutputFilesize. (Statistic: The average total size of output job-files for the jobs of this JobDefinition, rounded to the nearest integer.)
    
    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.
  - getAverageRunTime
```
Long getAverageRunTime()
```
    Get the value for AverageRunTime. (Statistic: The average run-time for the jobs of this JobDefinition in milliseconds, rounded to the nearest integer.)
    
    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.
  - getMinimumRunTime
```
Long getMinimumRunTime()
```
    Get the value for MinimumRunTime. (Statistic: The minimum run-time for the jobs of this JobDefinition in milliseconds, rounded to the nearest integer.)
    
    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.
  - getMaximumRunTime
```
Long getMaximumRunTime()
```
    Get the value for MaximumRunTime. (Statistic: The maximum run-time for the jobs of this JobDefinition in milliseconds, rounded to the nearest integer.)
    
    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.
  - 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.
  - isCriticalProcess
```
boolean isCriticalProcess()
```
    Get the value for CriticalProcess. (Mark this JobDefinition as a critical process.)
    
    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.
  - getDeprecated2
```
Long getDeprecated2()
```
    Get the value for Deprecated2. (This attribute is deprecated and no longer in use.) 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.
  - isDiscarded
```
boolean isDiscarded()
```
    Get the value for Discarded. (If an object is flagged as discarded it should no longer be used anymore. There is no guarantee that it would still be working and will eventually be deleted by a system process. Normally discarded objects should also be flagged hidden.)
    
    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.
  - getExecutionCompletedCount
```
Long getExecutionCompletedCount()
```
    Get the value for ExecutionCompletedCount. (Statistic: the number of jobs executed successfully.) 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.
  - getExecutionErrorCount
```
Long getExecutionErrorCount()
```
    Get the value for ExecutionErrorCount. (Statistic: the number of jobs executed with an error.) 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.
  - getValidity
```
Validity getValidity()
```
    Get the value for Validity. (Is this definition valid? That is, can this definition currently be used?) 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.
  - getJobDefinitionRelatedObject
```
JobDefinitionRelatedObject getJobDefinitionRelatedObject()
```
    Get the value for JobDefinitionRelatedObject. (The object that is related to this JobDefinition via the JobDefinitionType.)
    
    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.
  - isKeepForce
```
boolean isKeepForce()
```
    Get the value for KeepForce. (Should the keepclause always be considered? When KeepForce is true, then the job always follows its own keepclause. When it is false, it follows the keepclause of its parent job. Note that when counting the number of jobs (to determine whether a keepclause count has been reached) only top level jobs and jobs with KeepForce set to true are taken into account. Jobs that follow the keepclause of its parent job are *not* included in the count. )
    
    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.
  - getKeepAmount
```
Long getKeepAmount()
```
    Get the value for KeepAmount. (The number of submitted Jobs to be kept for this job definition.)
    
    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.
  - getKeepUnits
```
JobDefinitionKeepUnit getKeepUnits()
```
    Get the value for KeepUnits. (The unit of measure for KeepAmount. If set to "Jobs", the KeepType must also be specified.)
    
    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.
  - getKeepType
```
JobDefinitionKeepType getKeepType()
```
    Get the value for KeepType. (Indicates the type of the keep clauses: (S)ystem, (U)ser or (K)ey. Note that KeepUnits must be set to "Jobs".)
    
    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.
  - getKeepJobsInStatus
```
String getKeepJobsInStatus()
```
    Get the value for KeepJobsInStatus. (A possible overwrite for the more global keep_status)
    
    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.
  - getKeepInStatusAmount
```
Long getKeepInStatusAmount()
```
    Get the value for KeepInStatusAmount. (The amount for KeepInStatusUnit; if both set, jobs in one of the statuses KeepJobsInStatus are kept for this period (amount + units).)
    
    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.
  - getKeepInStatusUnit
```
JobDefinitionKeepUnit getKeepInStatusUnit()
```
    Get the value for KeepInStatusUnit. (The time unit for KeepInStatusAmount; if both set, jobs in one of the statuses KeepJobsInStatus are kept for this period (amount + units).)
    
    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.
  - isMonitorSchedule
```
boolean isMonitorSchedule()
```
    Get the value for MonitorSchedule. (Indicates whether the job definition should be monitored for active schedules. This is a calculated field, stored in an object tag, and may be deleted in the future.)
    
    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.
  - isOverdue
```
boolean isOverdue()
```
    Get the value for Overdue. (Set the scripts that are not run within their timewindow to status OVERDUE?)
    
    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.
  - getOverdueStatus
```
JobStatus getOverdueStatus()
```
    Get the value for OverdueStatus. (The status the job will get when it is overdue.)
    
    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.
  - getOverviewFormat
```
String getOverviewFormat()
```
    Get the value for OverviewFormat. (This text is free form and can be entered by the user. ${parameters.XXX} will be expanded to show the parameter XXX value in the runtime Job Chain Viewer.)
    
    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. (Default value for the job's priority)
    
    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.
  - getMaxPriority
```
Long getMaxPriority()
```
    Get the value for MaxPriority. (The maximum priority that any instance of this job definition can run at)
    
    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.
  - getRestartCount
```
Long getRestartCount()
```
    Get the value for RestartCount. (Maximum number of automatic restarts)
    
    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.
  - getReturncodeMapToCompleted
```
String getReturncodeMapToCompleted()
```
    Get the value for ReturncodeMapToCompleted. (Rangelist of return codes that map to completed)
    
    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.
  - getStandardDeviationLogFilesize
```
BigDecimal getStandardDeviationLogFilesize()
```
    Get the value for StandardDeviationLogFilesize. (Statistic: The standard deviation for the total size of log job-files for the jobs of this JobDefinition.)
    
    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.
  - getStandardDeviationOutputFilesize
```
BigDecimal getStandardDeviationOutputFilesize()
```
    Get the value for StandardDeviationOutputFilesize. (Statistic: The standard deviation for the total size of output job-files for the jobs of this JobDefinition.)
    
    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.
  - getStandardDeviationRunTime
```
BigDecimal getStandardDeviationRunTime()
```
    Get the value for StandardDeviationRunTime. (Statistic: The standard deviation of the run-time for the jobs of this JobDefinition.)
    
    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.
  - isTopLevel
```
boolean isTopLevel()
```
    Get the value for TopLevel. (Is this a top level JobDefinition? If this attribute's value is true, the job definition will be listed in in fields throughout the user interface listing submittable job definitions.)
    
    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.
  - isTemplate
```
boolean isTemplate()
```
    Get the value for Template. (Is this a template for a job definition)
    
    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.
  - isMaintenance
```
boolean isMaintenance()
```
    Get the value for Maintenance. (Is this JobDefinition for maintenance purposes? Marking maintenance for a JobDefinition, will affect the visibility of its Jobs, default filters may exclude them from their result. This option offers a way to define constant or often running Jobs as low-profile.)
    
    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.
  - getReactionJobType
```
ReactionJobType getReactionJobType()
```
    Get the value for ReactionJobType. (The Reaction Job Style of this Job Definition. Null is this Job Definition is not a reaction 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.
  - getEvaluationOwnerType
```
OwnerType getEvaluationOwnerType()
```
    Get the value for EvaluationOwnerType. (Which owner will be used as the user for the session that will evaluate constraints and runtime parameter defaults: (S)ystem Default, (J)ob owner or Job (D)efinition owner.) 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.
  - getCompletionStrategy
```
CompletionStrategyType getCompletionStrategy()
```
    Get the value for CompletionStrategy. (Which completion strategy should be used by default for jobs submitted from this definition?
    Note: If the set of CompletionStrategyType returned by getSupportedCompletionStrategies() for the related job definition type does not include some CompletionStrategyType, then setting it will throw an exception. Default is always supported. ) 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.
  - setEquivalentObject
```
void setEquivalentObject(boolean newEquivalentObject)
```
    Set the value for EquivalentObject. (Whether an equivalent object should be created in the database to call this job.)
    
    Parameters:
    
    newEquivalentObject - the new value for EquivalentObject.
    
    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.
  - setCriticalProcess
```
void setCriticalProcess(boolean newCriticalProcess)
```
    Set the value for CriticalProcess. (Mark this JobDefinition as a critical process.)
    
    Parameters:
    
    newCriticalProcess - the new value for CriticalProcess.
    
    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.
  - setDiscarded
```
void setDiscarded(boolean newDiscarded)
```
    Set the value for Discarded. (If an object is flagged as discarded it should no longer be used anymore. There is no guarantee that it would still be working and will eventually be deleted by a system process. Normally discarded objects should also be flagged hidden.)
    
    Parameters:
    
    newDiscarded - the new value for Discarded.
    
    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.
  - setKeepForce
```
void setKeepForce(boolean newKeepForce)
```
    Set the value for KeepForce. (Should the keepclause always be considered? When KeepForce is true, then the job always follows its own keepclause. When it is false, it follows the keepclause of its parent job. Note that when counting the number of jobs (to determine whether a keepclause count has been reached) only top level jobs and jobs with KeepForce set to true are taken into account. Jobs that follow the keepclause of its parent job are *not* included in the count. )
    
    Parameters:
    
    newKeepForce - the new value for KeepForce.
    
    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.
  - setKeepAmount
```
void setKeepAmount(Long newKeepAmount)
```
    Set the value for KeepAmount. (The number of submitted Jobs to be kept for this job definition.) This value is optional.
    
    Parameters:
    
    newKeepAmount - the new value for KeepAmount.
    
    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.
  - setKeepUnits
```
void setKeepUnits(JobDefinitionKeepUnit newKeepUnits)
```
    Set the value for KeepUnits. (The unit of measure for KeepAmount. If set to "Jobs", the KeepType must also be specified.) This value is optional.
    
    Parameters:
    
    newKeepUnits - the new value for KeepUnits.
    
    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.
  - setKeepType
```
void setKeepType(JobDefinitionKeepType newKeepType)
```
    Set the value for KeepType. (Indicates the type of the keep clauses: (S)ystem, (U)ser or (K)ey. Note that KeepUnits must be set to "Jobs".) This value is optional.
    
    Parameters:
    
    newKeepType - the new value for KeepType.
    
    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.
  - setKeepJobsInStatus
```
void setKeepJobsInStatus(String newKeepJobsInStatus)
```
    Set the value for KeepJobsInStatus. (A possible overwrite for the more global keep_status) This value is optional.
    
    Parameters:
    
    newKeepJobsInStatus - the new value for KeepJobsInStatus.
    
    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.
  - setKeepInStatusAmount
```
void setKeepInStatusAmount(Long newKeepInStatusAmount)
```
    Set the value for KeepInStatusAmount. (The amount for KeepInStatusUnit; if both set, jobs in one of the statuses KeepJobsInStatus are kept for this period (amount + units).) This value is optional.
    
    Parameters:
    
    newKeepInStatusAmount - the new value for KeepInStatusAmount.
    
    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.
  - setKeepInStatusUnit
```
void setKeepInStatusUnit(JobDefinitionKeepUnit newKeepInStatusUnit)
```
    Set the value for KeepInStatusUnit. (The time unit for KeepInStatusAmount; if both set, jobs in one of the statuses KeepJobsInStatus are kept for this period (amount + units).) This value is optional.
    
    Parameters:
    
    newKeepInStatusUnit - the new value for KeepInStatusUnit.
    
    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.
  - setMonitorSchedule
```
void setMonitorSchedule(boolean newMonitorSchedule)
```
    Set the value for MonitorSchedule. (Indicates whether the job definition should be monitored for active schedules. This is a calculated field, stored in an object tag, and may be deleted in the future.)
    
    Parameters:
    
    newMonitorSchedule - the new value for MonitorSchedule.
    
    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.
  - setOverdue
```
void setOverdue(boolean newOverdue)
```
    Set the value for Overdue. (Set the scripts that are not run within their timewindow to status OVERDUE?)
    
    Parameters:
    
    newOverdue - the new value for Overdue.
    
    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.
  - setOverdueStatus
```
void setOverdueStatus(JobStatus newOverdueStatus)
```
    Set the value for OverdueStatus. (The status the job will get when it is overdue.) This value is optional.
    
    Parameters:
    
    newOverdueStatus - the new value for OverdueStatus.
    
    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.
  - setOverviewFormat
```
void setOverviewFormat(String newOverviewFormat)
```
    Set the value for OverviewFormat. (This text is free form and can be entered by the user. ${parameters.XXX} will be expanded to show the parameter XXX value in the runtime Job Chain Viewer.) This value is optional.
    
    Parameters:
    
    newOverviewFormat - the new value for OverviewFormat.
    
    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.
  - setPriority
```
void setPriority(Long newPriority)
```
    Set the value for Priority. (Default value for the job's priority) This value is optional.
    
    Parameters:
    
    newPriority - the new value for Priority.
    
    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.
  - setMaxPriority
```
void setMaxPriority(Long newMaxPriority)
```
    Set the value for MaxPriority. (The maximum priority that any instance of this job definition can run at) This value is optional.
    
    Parameters:
    
    newMaxPriority - the new value for MaxPriority.
    
    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.
  - setRestartCount
```
void setRestartCount(Long newRestartCount)
```
    Set the value for RestartCount. (Maximum number of automatic restarts) This value is optional.
    
    Parameters:
    
    newRestartCount - the new value for RestartCount.
    
    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.
  - setReturncodeMapToCompleted
```
void setReturncodeMapToCompleted(String newReturncodeMapToCompleted)
```
    Set the value for ReturncodeMapToCompleted. (Rangelist of return codes that map to completed) This value is optional.
    
    Parameters:
    
    newReturncodeMapToCompleted - the new value for ReturncodeMapToCompleted.
    
    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.
  - setHoldOnSubmit
```
void setHoldOnSubmit(boolean newHoldOnSubmit)
```
    Set the value for HoldOnSubmit. (Should any submitted Job be held by default.)
    
    Parameters:
    
    newHoldOnSubmit - the new value for HoldOnSubmit.
    
    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.
  - setTopLevel
```
void setTopLevel(boolean newTopLevel)
```
    Set the value for TopLevel. (Is this a top level JobDefinition? If this attribute's value is true, the job definition will be listed in in fields throughout the user interface listing submittable job definitions.)
    
    Parameters:
    
    newTopLevel - the new value for TopLevel.
    
    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.
  - setTemplate
```
void setTemplate(boolean newTemplate)
```
    Set the value for Template. (Is this a template for a job definition)
    
    Parameters:
    
    newTemplate - the new value for Template.
    
    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.
  - setMaintenance
```
void setMaintenance(boolean newMaintenance)
```
    Set the value for Maintenance. (Is this JobDefinition for maintenance purposes? Marking maintenance for a JobDefinition, will affect the visibility of its Jobs, default filters may exclude them from their result. This option offers a way to define constant or often running Jobs as low-profile.)
    
    Parameters:
    
    newMaintenance - the new value for Maintenance.
    
    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.
  - setReactionJobType
```
void setReactionJobType(ReactionJobType newReactionJobType)
```
    Set the value for ReactionJobType. (The Reaction Job Style of this Job Definition. Null is this Job Definition is not a reaction job.) This value is optional.
    
    Parameters:
    
    newReactionJobType - the new value for ReactionJobType.
    
    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.
  - setEvaluationOwnerType
```
void setEvaluationOwnerType(OwnerType newEvaluationOwnerType)
```
    Set the value for EvaluationOwnerType. (Which owner will be used as the user for the session that will evaluate constraints and runtime parameter defaults: (S)ystem Default, (J)ob owner or Job (D)efinition owner.) This value is mandatory.
    
    Parameters:
    
    newEvaluationOwnerType - the new value for EvaluationOwnerType. 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.
  - setCompletionStrategy
```
void setCompletionStrategy(CompletionStrategyType newCompletionStrategy)
```
    Set the value for CompletionStrategy. (Which completion strategy should be used by default for jobs submitted from this definition?
    Note: If the set of CompletionStrategyType returned by getSupportedCompletionStrategies() for the related job definition type does not include some CompletionStrategyType, then setting it will throw an exception. Default is always supported. ) This value is mandatory.
    
    Parameters:
    
    newCompletionStrategy - the new value for CompletionStrategy. 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.
  - setOwner
```
void setOwner(Subject newOwner)
```
    Change the owner of the JobDefinition. Requires 'changeOwner' global privilege.
    
    Specified by:
    
    setOwner in interface ChangeOwner
    
    Parameters:
    
    newOwner - New owner for the Job Definition. The SubjectType must be User.
  - duplicate
```
JobDefinition duplicate()
```
    Duplicate the JobDefinition. All external attributes are copied into the new object. Internal attributes (including behavior) are not explicitly copied.
    
    Returns:
    
    The duplicated JobDefinition.
  - createEquivalentObject
```
void createEquivalentObject(boolean quotePartition,
                            boolean quoteJobDefinition)
```
    Create an equivalent object in the database for calling this job definition.
    
    Parameters:
    
    quotePartition - Whether the partition name should be quoted when creating the object.
    
    quoteJobDefinition - Whether the job definition name should be quoted when creating the object.
  - isInternalChain
```
boolean isInternalChain()
```
    The JobDefinition is considered internal and should be excluded in some cases
    
    Returns:
    
    True if internal
  - prepare
```
Job prepare()
     throws com.redwood.scheduler.api.exception.ParameterDefaultValueUnavailableException,
            com.redwood.scheduler.api.exception.ModifiedJobDefinitionCannotBePreparedException
```
    Prepare a job based on this job definition for submission. By default the requested start time is set to "Now", which is a marker time (see DateTimeZone.NOW_DATE). This marker is translated into the current time just before the JobDefinition is persisted. This method must not be used by any internal code with an internal session; the reason is that the session will be used for security during preparation of the job.
    
    Returns:
    
    Prepared job that should be customized and then submitted.
    
    Throws:
    
    com.redwood.scheduler.api.exception.ParameterDefaultValueUnavailableException - An error was encountered while evaluating a default parameter value.
    
    com.redwood.scheduler.api.exception.ModifiedJobDefinitionCannotBePreparedException - Only clean JobDefinitions can be prepared. This exception will be thrown when prepare has been called on a JobDefinition that has been modified since being retrieved from the database, or that has not yet been persisted to the database.
  - cancelNonFinalJobs
```
void cancelNonFinalJobs()
```
    Cancel all jobs of this JobDefinition that have a non final status. This is a grouped action: it will affect all jobs for job definitions that have the same master as this job definition. It will also stop all recurrences and submit frames for this job definition.
  - deleteFinalJobs
```
void deleteFinalJobs()
```
    Delete all jobs of this JobDefinition that have a final status. This is a grouped action: it will affect all jobs for job definitions that have the same master as this job definition.
  - getVariables
```
Set<Variable> getVariables()
```
    Get the Set of Variables related to JobDefinition objects.
    
    Specified by:
    
    getVariables in interface ExecutableSchedulerEntity
    
    Returns:
    
    Set of Variable for JobDefinition.
  - createConstraintContext
```
ConstraintContext createConstraintContext()
```
    Create a ConstraintContext so that the constraints can be verified.
    
    Returns:
    
    The ConstraintContext
  - getStatisticsByKeyParameters
```
Statistics getStatisticsByKeyParameters(Map<String,String> keyParameters)
```
    Get a statistics object associated to this JobDefinition.
    
    Parameters:
    
    keyParameters - KeyParameters as a map of String names -> String values
    
    Returns:
    
    Statistics
  - resetStatistics
```
void resetStatistics()
```
    Reset the counters and statistics for this job-definition.
  - getOverdueEventDefinition
```
EventDefinition getOverdueEventDefinition()
```
    Get the OverdueEventDefinition.
    
    Returns:
    
    OverdueEventDefinition
    
    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.
  - getDefaultOutputFormat
```
Format getDefaultOutputFormat()
```
    Get the DefaultOutputFormat.
    
    Returns:
    
    DefaultOutputFormat
    
    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.
  - getJobDefinitionType
```
JobDefinitionType getJobDefinitionType()
```
    Get the JobDefinitionType.
    
    Returns:
    
    JobDefinitionType
    
    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.
  - getDefaultLogFormat
```
Format getDefaultLogFormat()
```
    Get the DefaultLogFormat.
    
    Returns:
    
    DefaultLogFormat
    
    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.
  - getMasterJobDefinition
```
JobDefinition getMasterJobDefinition()
```
    Get the MasterJobDefinition.
    
    Returns:
    
    MasterJobDefinition
    
    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.
  - getDefaultQueue
```
Queue getDefaultQueue()
```
    Get the DefaultQueue.
    
    Returns:
    
    DefaultQueue
    
    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.
  - getResource
```
Resource getResource()
```
    Get the Resource.
    
    Returns:
    
    Resource
    
    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.
  - getRELRelatedLibrary
```
Library getRELRelatedLibrary()
```
    Get the RELRelatedLibrary.
    
    Returns:
    
    RELRelatedLibrary
    
    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.
  - getActionSubject
```
Subject getActionSubject()
```
    Get the ActionSubject.
    
    Specified by:
    
    getActionSubject in interface ActionSubjectObject
    
    Returns:
    
    ActionSubject
    
    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.
  - setOverdueEventDefinition
```
void setOverdueEventDefinition(EventDefinition newOverdueEventDefinition)
```
    Set the value for OverdueEventDefinition. This value is optional.
    
    Parameters:
    
    newOverdueEventDefinition - is the object to set OverdueEventDefinition to. The event to raise when a job becomes overdue.
  - setDefaultOutputFormat
```
void setDefaultOutputFormat(Format newDefaultOutputFormat)
```
    Set the value for DefaultOutputFormat. This value is optional.
    
    Parameters:
    
    newDefaultOutputFormat - is the object to set DefaultOutputFormat to. The default format to give to output files from this job.
  - setJobDefinitionType
```
void setJobDefinitionType(JobDefinitionType newJobDefinitionType)
```
    Set the value for JobDefinitionType. This value is mandatory.
    
    Parameters:
    
    newJobDefinitionType - is the object to set JobDefinitionType to. The type of a job definition. If this is null, then the object cannot be persisted.
  - setDefaultLogFormat
```
void setDefaultLogFormat(Format newDefaultLogFormat)
```
    Set the value for DefaultLogFormat. This value is optional.
    
    Parameters:
    
    newDefaultLogFormat - is the object to set DefaultLogFormat to. The default format to give to output files from this job.
  - setMasterJobDefinition
```
void setMasterJobDefinition(JobDefinition newMasterJobDefinition)
```
    Set the value for MasterJobDefinition. This value is optional.
    
    Parameters:
    
    newMasterJobDefinition - is the object to set MasterJobDefinition to. The master job definition for this job definition.
  - setDefaultQueue
```
void setDefaultQueue(Queue newDefaultQueue)
```
    Set the value for DefaultQueue. This value is optional.
    
    Parameters:
    
    newDefaultQueue - is the object to set DefaultQueue to. The default queue of a job definition.
  - setResource
```
void setResource(Resource newResource)
```
    Set the value for Resource. This value is optional.
    
    Parameters:
    
    newResource - is the object to set Resource to. The resource required by a job definition.
  - setTimeWindow
```
void setTimeWindow(TimeWindow newTimeWindow)
```
    Set the value for TimeWindow. This value is optional.
    
    Parameters:
    
    newTimeWindow - is the object to set TimeWindow to. The time window in which a job definition must run.
  - setTimeWindowTimeZone
```
void setTimeWindowTimeZone(TimeZone newTimeWindowTimeZone)
```
    Set the value for TimeWindowTimeZone. This value is optional.
    
    Parameters:
    
    newTimeWindowTimeZone - is the object to set TimeWindowTimeZone to. The time zone for the time window in which a job definition must run.
  - setJobTimeZone
```
void setJobTimeZone(TimeZone newJobTimeZone)
```
    Set the value for JobTimeZone. This value is optional.
    
    Parameters:
    
    newJobTimeZone - is the object to set JobTimeZone to. The time zone of this job.
  - setRELRelatedLibrary
```
void setRELRelatedLibrary(Library newRELRelatedLibrary)
```
    Set the value for RELRelatedLibrary. This value is optional.
    
    Parameters:
    
    newRELRelatedLibrary - is the object to set RELRelatedLibrary to. The library that is used for local REL expressions (without library name in REL expression), for backward compatibility reasons there is a fallback to the old behaviour: If no REL related library is given (=null) the Library of the Script entity is used
  - setActionSubject
```
void setActionSubject(Subject newActionSubject)
```
    Set the value for ActionSubject. This value is optional.
    
    Parameters:
    
    newActionSubject - is the object to set ActionSubject to. Who do jobs for this job-definition execute as?
  - getFinalStatusHandlers
```
RWIterable<FinalStatusHandler> getFinalStatusHandlers()
```
    Get an RWIterable over an ordered collection of FinalStatusHandlers. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. The final status handlers of a job definition.
    
    Specified by:
    
    getFinalStatusHandlers in interface JobDefinitionComp
    
    Returns:
    
    An RWIterable over an ordered collection of FinalStatusHandler objects .
  - createFinalStatusHandler
```
FinalStatusHandler createFinalStatusHandler()
```
    Create a new FinalStatusHandler linked to this object.
    
    Returns:
    
    a new FinalStatusHandler.
  - getFinalStatusHandlerByStatus
```
FinalStatusHandler getFinalStatusHandlerByStatus(JobStatus status)
```
    Get the FinalStatusHandler by JobDefinitionStatus.
    
    Parameters:
    
    status -
    
    Returns:
    
    the FinalStatusHandler, or null if it could not be found
  - getJobChainCalls
```
RWIterable<JobChainCall> getJobChainCalls()
```
    Get an RWIterable over an ordered collection of JobChainCalls. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. A call to a job definition from a job chain.
    
    Specified by:
    
    getJobChainCalls in interface JobDefinitionComp
    
    Returns:
    
    An RWIterable over an ordered collection of JobChainCall objects .
  - getJobDefinitionActions
```
RWIterable<JobDefinitionAction> getJobDefinitionActions()
```
    Get an RWIterable over an ordered collection of JobDefinitionActions. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. Actions defined for this job definition.
    
    Specified by:
    
    getJobDefinitionActions in interface JobDefinitionComp
    
    Returns:
    
    An RWIterable over an ordered collection of JobDefinitionAction objects .
  - createJobDefinitionAction
```
JobDefinitionAction createJobDefinitionAction()
```
    Create a new JobDefinitionAction linked to this object.
    
    Returns:
    
    a new JobDefinitionAction.
  - getJobDefinitionActionByType
```
JobDefinitionAction getJobDefinitionActionByType(JobDefinitionActionType type)
```
    Get the JobDefinitionAction by JobDefinitionActionType.
    
    Parameters:
    
    type -
    
    Returns:
    
    the JobDefinitionAction, or null if it could not be found
  - getJobDefinitionConstraints
```
RWIterable<JobDefinitionConstraint> getJobDefinitionConstraints()
```
    Get an RWIterable over an ordered collection of JobDefinitionConstraints. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. A constraint on a job definition.
    
    Specified by:
    
    getJobDefinitionConstraints in interface JobDefinitionComp
    
    Returns:
    
    An RWIterable over an ordered collection of JobDefinitionConstraint objects .
  - createJobDefinitionConstraint
```
JobDefinitionConstraint createJobDefinitionConstraint(ConstraintDefinition newConstraintDefinition)
```
    Create a new JobDefinitionConstraint linked to this object.
    
    Parameters:
    
    newConstraintDefinition - The other parent of the JobDefinitionConstraintConstraintDefinition association.
    
    Returns:
    
    a new JobDefinitionConstraint.
  - getJobDefinitionConstraintByName
```
JobDefinitionConstraint getJobDefinitionConstraintByName(String name)
```
    Get the JobDefinitionConstraint by JobDefinitionJobDefinitionConstraintName.
    
    Parameters:
    
    name -
    
    Returns:
    
    the JobDefinitionConstraint, or null if it could not be found
  - getJobDefinitionForms
```
RWIterable<JobDefinitionForm> getJobDefinitionForms()
```
    Get an RWIterable over an ordered collection of JobDefinitionForms. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. Job definition forms.
    
    Specified by:
    
    getJobDefinitionForms in interface JobDefinitionComp
    
    Returns:
    
    An RWIterable over an ordered collection of JobDefinitionForm objects .
  - createJobDefinitionForm
```
JobDefinitionForm createJobDefinitionForm()
```
    Create a new JobDefinitionForm linked to this object.
    
    Returns:
    
    a new JobDefinitionForm.
  - getJobDefinitionFormByName
```
JobDefinitionForm getJobDefinitionFormByName(String name)
```
    Get the JobDefinitionForm by JobDefinitionName.
    
    Parameters:
    
    name -
    
    Returns:
    
    the JobDefinitionForm, or null if it could not be found
  - getJobDefinitionParameters
```
RWIterable<JobDefinitionParameter> getJobDefinitionParameters()
```
    Get an RWIterable over a collection of JobDefinitionParameters, the collection will be ordered by DisplayOrder. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. Job definition parameters.
    
    Specified by:
    
    getJobDefinitionParameters in interface JobDefinitionComp
    
    Returns:
    
    An RWIterable over a collection of JobDefinitionParameter objects , the collection will be ordered by DisplayOrder.
  - createJobDefinitionParameter
```
JobDefinitionParameter createJobDefinitionParameter()
```
    Create a new JobDefinitionParameter linked to this object.
    
    Returns:
    
    a new JobDefinitionParameter.
  - getJobDefinitionParameterByName
```
JobDefinitionParameter getJobDefinitionParameterByName(String name)
```
    Get the JobDefinitionParameter by JobDefinitionName.
    
    Parameters:
    
    name -
    
    Returns:
    
    the JobDefinitionParameter, or null if it could not be found
  - getJobDefinitionJobLocks
```
RWIterable<JobDefinitionJobLock> getJobDefinitionJobLocks()
```
    Get an RWIterable over an ordered collection of JobDefinitionJobLocks. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. Predefined list of locks that a job needs to acquire before executing
    
    Specified by:
    
    getJobDefinitionJobLocks in interface JobDefinitionComp
    
    Returns:
    
    An RWIterable over an ordered collection of JobDefinitionJobLock objects .
  - createJobDefinitionJobLock
```
JobDefinitionJobLock createJobDefinitionJobLock(JobLock newJobLock)
```
    Create a new JobDefinitionJobLock linked to this object.
    
    Parameters:
    
    newJobLock - The other parent of the JobDefinitionJobLockJobLock association.
    
    Returns:
    
    a new JobDefinitionJobLock.
  - getJobDefinitionJobLockByJobLock
```
JobDefinitionJobLock getJobDefinitionJobLockByJobLock(JobLock jobLock)
```
    Get the JobDefinitionJobLock by JobDefinitionJobLock.
    
    Parameters:
    
    jobLock -
    
    Returns:
    
    the JobDefinitionJobLock, or null if it could not be found
  - getJobDefinitionRaiseEvents
```
RWIterable<JobDefinitionRaiseEvent> getJobDefinitionRaiseEvents()
```
    Get an RWIterable over an ordered collection of JobDefinitionRaiseEvents. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. Predefined list of events that a job will raise when it reaches a particular status.
    
    Specified by:
    
    getJobDefinitionRaiseEvents in interface JobDefinitionComp
    
    Returns:
    
    An RWIterable over an ordered collection of JobDefinitionRaiseEvent objects .
  - createJobDefinitionRaiseEvent
```
JobDefinitionRaiseEvent createJobDefinitionRaiseEvent()
```
    Create a new JobDefinitionRaiseEvent linked to this object.
    
    Returns:
    
    a new JobDefinitionRaiseEvent.
  - getJobDefinitionRuntimeLimits
```
RWIterable<JobDefinitionRuntimeLimit> getJobDefinitionRuntimeLimits()
```
    Get an RWIterable over an ordered collection of JobDefinitionRuntimeLimits. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. Job definition runtime limits.
    
    Specified by:
    
    getJobDefinitionRuntimeLimits in interface JobDefinitionComp
    
    Returns:
    
    An RWIterable over an ordered collection of JobDefinitionRuntimeLimit objects .
  - createJobDefinitionRuntimeLimit
```
JobDefinitionRuntimeLimit createJobDefinitionRuntimeLimit()
```
    Create a new JobDefinitionRuntimeLimit linked to this object.
    
    Returns:
    
    a new JobDefinitionRuntimeLimit.
  - getJobDefinitionRuntimeLimitByName
```
JobDefinitionRuntimeLimit getJobDefinitionRuntimeLimitByName(String name)
```
    Get the JobDefinitionRuntimeLimit by JobDefinitionName.
    
    Parameters:
    
    name -
    
    Returns:
    
    the JobDefinitionRuntimeLimit, or null if it could not be found
  - getJobDefinitionWaitEvents
```
RWIterable<JobDefinitionWaitEvent> getJobDefinitionWaitEvents()
```
    Get an RWIterable over an ordered collection of JobDefinitionWaitEvents. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. Predefined list of events that a job will wait for before executing
    
    Specified by:
    
    getJobDefinitionWaitEvents in interface JobDefinitionComp
    
    Returns:
    
    An RWIterable over an ordered collection of JobDefinitionWaitEvent objects .
  - createJobDefinitionWaitEvent
```
JobDefinitionWaitEvent createJobDefinitionWaitEvent()
```
    Create a new JobDefinitionWaitEvent linked to this object.
    
    Returns:
    
    a new JobDefinitionWaitEvent.
  - getJobFileSearches
```
RWIterable<JobFileSearch> getJobFileSearches()
```
    Get an RWIterable over an ordered collection of JobFileSearches. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. A JobFileSearch to be applied to all Jobs with the parent JobDefinition.
    
    Specified by:
    
    getJobFileSearches in interface JobDefinitionComp
    
    Returns:
    
    An RWIterable over an ordered collection of JobFileSearch objects .
  - createJobFileSearch
```
JobFileSearch createJobFileSearch()
```
    Create a new JobFileSearch linked to this object.
    
    Returns:
    
    a new JobFileSearch.
  - getJobFileSearchByProcessingOrder
```
JobFileSearch getJobFileSearchByProcessingOrder(Long processingOrder)
```
    Get the JobFileSearch by JobDefinitionProcessingOrder.
    
    Parameters:
    
    processingOrder -
    
    Returns:
    
    the JobFileSearch, or null if it could not be found
  - getJobDefinitionProcessMonitorUpdaters
```
RWIterable<JobDefinitionProcessMonitorUpdater> getJobDefinitionProcessMonitorUpdaters()
```
    Get an RWIterable over an ordered collection of JobDefinitionProcessMonitorUpdaters. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. The ProcessMonitorUpdaters for a JobDefinition
    
    Specified by:
    
    getJobDefinitionProcessMonitorUpdaters in interface JobDefinitionComp
    
    Returns:
    
    An RWIterable over an ordered collection of JobDefinitionProcessMonitorUpdater objects .
  - createJobDefinitionProcessMonitorUpdater
```
JobDefinitionProcessMonitorUpdater createJobDefinitionProcessMonitorUpdater()
```
    Create a new JobDefinitionProcessMonitorUpdater linked to this object.
    
    Returns:
    
    a new JobDefinitionProcessMonitorUpdater.
  - getPublishedWebServices
```
RWIterable<PublishedWebService> getPublishedWebServices()
```
    Get an RWIterable over an ordered collection of PublishedWebServices. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. The object that determines whether a JobDefinition is published as a web service.
    
    Specified by:
    
    getPublishedWebServices in interface JobDefinitionComp
    
    Returns:
    
    An RWIterable over an ordered collection of PublishedWebService objects .
  - createPublishedWebService
```
PublishedWebService createPublishedWebService()
```
    Create a new PublishedWebService linked to this object.
    
    Returns:
    
    a new PublishedWebService.
  - getStatistics
```
RWIterable<Statistics> getStatistics()
```
    Get an RWIterable over an ordered collection of Statistics. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. The Statistics for a JobDefinition
    
    Specified by:
    
    getStatistics in interface JobDefinitionComp
    
    Returns:
    
    An RWIterable over an ordered collection of Statistics objects .
  - createStatistics
```
Statistics createStatistics()
```
    Create a new Statistics linked to this object.
    
    Returns:
    
    a new Statistics.
  - checkCreatePrivilege
```
RequiredPermission checkCreatePrivilege()
```
    Check whether or not the create action can be performed on this object.
    
    Returns:
    
    a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.
  - checkViewPrivilege
```
RequiredPermission checkViewPrivilege()
```
    Check whether or not the view action can be performed on this object.
    
    Returns:
    
    a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.
  - checkViewJobsPrivilege
```
RequiredPermission checkViewJobsPrivilege()
```
    Check whether or not the viewJobs action can be performed on this object.
    
    Returns:
    
    a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.
  - checkSubmitPrivilege
```
RequiredPermission checkSubmitPrivilege()
```
    Check whether or not the submit action can be performed on this object.
    
    Returns:
    
    a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.
  - checkEditJobsPrivilege
```
RequiredPermission checkEditJobsPrivilege()
```
    Check whether or not the editJobs action can be performed on this object.
    
    Returns:
    
    a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.
  - checkEditPrivilege
```
RequiredPermission checkEditPrivilege()
```
    Check whether or not the edit action can be performed on this object.
    
    Returns:
    
    a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.
  - checkDeletePrivilege
```
RequiredPermission checkDeletePrivilege()
```
    Check whether or not the delete action can be performed on this object.
    
    Returns:
    
    a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.

Interface JobDefinition

Field Summary

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

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

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

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

Method Summary

Methods inherited from interface com.redwood.scheduler.api.model.interfaces.ActionSubjectObject

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

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

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

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

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

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

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

Field Detail

OBJECT_TYPE

TYPE

INTERNAL_CHAIN

SEC_PRIV_CREATE

SEC_PRIV_VIEW

SEC_PRIV_VIEWJOBS

SEC_PRIV_SUBMIT

SEC_PRIV_EDITJOBS

SEC_PRIV_EDIT

SEC_PRIV_DELETE

SEC_RANK_NONE

SEC_RANK_CREATE

SEC_RANK_VIEW

SEC_RANK_VIEWJOBS

SEC_RANK_SUBMIT

SEC_RANK_SUBMITANDVIEW

SEC_RANK_EDITJOBS

SEC_RANK_EDIT

SEC_RANK_DELETE

SEC_RANK_ALL

Method Detail

isEquivalentObject

getAverageLogFilesize

getAverageOutputFilesize

getAverageRunTime

getMinimumRunTime

getMaximumRunTime

getChangeOwnerTime

isCriticalProcess

getDeprecated2

isDiscarded

getExecutionCompletedCount

getExecutionErrorCount

getValidity

getJobDefinitionRelatedObject

isKeepForce

getKeepAmount

getKeepUnits

getKeepType

getKeepJobsInStatus

getKeepInStatusAmount

getKeepInStatusUnit

getMinimumOpenDurationExpression

isMonitorSchedule

isOverdue

getOverdueStatus

getOverviewFormat

getPriority

getMaxPriority

getRestartCount

getReturncodeMapToCompleted

getStandardDeviationLogFilesize

getStandardDeviationOutputFilesize

getStandardDeviationRunTime

isHoldOnSubmit

isTopLevel

isTemplate

isMaintenance

getReactionJobType

getEvaluationOwnerType

getCompletionStrategy

setEquivalentObject

setCriticalProcess

setDiscarded