Package com.redwood.scheduler.api.model

Interface JobDefinitionJobLock

All Superinterfaces:

Association, Branchable, BusinessKeyObject, Readable, SchedulerEntity, SchedulerEntityComp

public interface JobDefinitionJobLock
extends Association, Branchable, BusinessKeyObject, Readable

A job definition can require job locks. This relationship shows what locks a job definition requires.

Field Summary

Fields

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

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

ACTION_AUDIT, ACTION_EXPORT, ACTION_READ, BEHAVIOR_DEPRECATED, BEHAVIOR_NONE, BEHAVIOR_SYSTEM

Method Summary

Modifier and Type	Method	Description
JobDefinition	getJobDefinition()	Get the JobDefinition.
JobLock	getJobLock()	Get the JobLock.
Long	getRequiredCount()	Get the value for RequiredCount.
boolean	isMasterVersion()	Get the value for MasterVersion.
void	setRequiredCount(Long newRequiredCount)	Set the value for RequiredCount.

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

getBusinessKey

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

See Also:

Constant Field Values

TYPE

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

isMasterVersion

boolean isMasterVersion()

Get the value for MasterVersion. (Whether this object belongs to a master object or not.)

Specified by:

isMasterVersion in interface Branchable

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.

getRequiredCount

Long getRequiredCount()

Get the value for RequiredCount. (The number of locks that will be taken when running a job. The job will not run until this amount is available.) 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.

setRequiredCount

void setRequiredCount(Long newRequiredCount)

Set the value for RequiredCount. (The number of locks that will be taken when running a job. The job will not run until this amount is available.) This value is mandatory.

Parameters:

newRequiredCount - the new value for RequiredCount. 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.

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.

getJobLock

JobLock getJobLock()

Get the JobLock.

Returns:

JobLock

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.