Package com.redwood.scheduler.api.model

Interface JobDefinitionConstraint

All Superinterfaces:

Association, BusinessKeyObject, EntityDefinitionConstraint, JobDefinitionConstraintComp, Readable, SchedulerEntity, SchedulerEntityComp

public interface JobDefinitionConstraint
extends JobDefinitionConstraintComp, EntityDefinitionConstraint, BusinessKeyObject, Readable

A constraint on a job definition. Job definition constraints are created from constraint definitions by specifying a constraint definition and constraint definition parameters.

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "JobDefinitionConstraint" 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<JobDefinitionConstraint>	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
JobDefinitionConstraintParameterMapping	createJobDefinitionConstraintParameterMapping()	Create a new JobDefinitionConstraintParameterMapping linked to this object.
ConstraintDefinition	getConstraintDefinition()	Get the ConstraintDefinition.
JobDefinition	getJobDefinition()	Get the JobDefinition.
JobDefinitionConstraintParameterMapping	getJobDefinitionConstraintParameterMappingByParameterName(String parameterName)	Get the JobDefinitionConstraintParameterMapping by JobDefi.
RWIterable<JobDefinitionConstraintParameterMapping>	getJobDefinitionConstraintParameterMappings()	Get an RWIterable over an ordered collection of JobDefinitionConstraintParameterMappings.

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

getBusinessKey

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

getComment, getConstraintParameterMappingByName, getConstraintParameterMappings, getDescription, getName, setComment, setDescription, setName

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

See Also:

Constant Field Values

TYPE

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

getConstraintDefinition

ConstraintDefinition getConstraintDefinition()

Get the ConstraintDefinition.

Returns:

ConstraintDefinition

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.

getJobDefinitionConstraintParameterMappings

RWIterable<JobDefinitionConstraintParameterMapping> getJobDefinitionConstraintParameterMappings()

Get an RWIterable over an ordered collection of JobDefinitionConstraintParameterMappings. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. The parameters to a job definition constraint.

Specified by:

getJobDefinitionConstraintParameterMappings in interface JobDefinitionConstraintComp

Returns:

An RWIterable over an ordered collection of JobDefinitionConstraintParameterMapping objects .

createJobDefinitionConstraintParameterMapping

JobDefinitionConstraintParameterMapping createJobDefinitionConstraintParameterMapping()

Create a new JobDefinitionConstraintParameterMapping linked to this object.

Returns:

a new JobDefinitionConstraintParameterMapping.

getJobDefinitionConstraintParameterMappingByParameterName

JobDefinitionConstraintParameterMapping getJobDefinitionConstraintParameterMappingByParameterName(String parameterName)

Get the JobDefinitionConstraintParameterMapping by JobDefi.

Parameters:

parameterName -

Returns:

the JobDefinitionConstraintParameterMapping, or null if it could not be found