Package com.redwood.scheduler.api.model

Interface TableDefinitionConstraint

All Superinterfaces:

Association, BusinessKeyObject, EntityDefinitionConstraint, Readable, SchedulerEntity, SchedulerEntityComp, TableDefinitionConstraintComp

public interface TableDefinitionConstraint
extends TableDefinitionConstraintComp, EntityDefinitionConstraint, BusinessKeyObject, Readable

A constraint on a table definition. Table 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 "TableDefinitionConstraint" 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<TableDefinitionConstraint>	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
TableDefinitionConstraintParameterMapping	createTableDefinitionConstraintParameterMapping()	Create a new TableDefinitionConstraintParameterMapping linked to this object.
ConstraintDefinition	getConstraintDefinition()	Get the ConstraintDefinition.
TableDefinition	getTableDefinition()	Get the TableDefinition.
TableDefinitionConstraintParameterMapping	getTableDefinitionConstraintParameterMappingByParameterName(String parameterName)	Get the TableDefinitionConstraintParameterMapping by TabDefConParName.
RWIterable<TableDefinitionConstraintParameterMapping>	getTableDefinitionConstraintParameterMappings()	Get an RWIterable over an ordered collection of TableDefinitionConstraintParameterMappings.

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

See Also:

Constant Field Values

TYPE

static final QueryObjectType<TableDefinitionConstraint> 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.

getTableDefinition

TableDefinition getTableDefinition()

Get the TableDefinition.

Returns:

TableDefinition

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.

getTableDefinitionConstraintParameterMappings

RWIterable<TableDefinitionConstraintParameterMapping> getTableDefinitionConstraintParameterMappings()

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

Specified by:

getTableDefinitionConstraintParameterMappings in interface TableDefinitionConstraintComp

Returns:

An RWIterable over an ordered collection of TableDefinitionConstraintParameterMapping objects .

createTableDefinitionConstraintParameterMapping

TableDefinitionConstraintParameterMapping createTableDefinitionConstraintParameterMapping()

Create a new TableDefinitionConstraintParameterMapping linked to this object.

Returns:

a new TableDefinitionConstraintParameterMapping.

getTableDefinitionConstraintParameterMappingByParameterName

TableDefinitionConstraintParameterMapping getTableDefinitionConstraintParameterMappingByParameterName(String parameterName)

Get the TableDefinitionConstraintParameterMapping by TabDefConParName.

Parameters:

parameterName -

Returns:

the TableDefinitionConstraintParameterMapping, or null if it could not be found