Package com.redwood.scheduler.api.model

Interface TableDefinition

All Superinterfaces:

ApplicationObject, BusinessKeyObject, NamedRootObject, NamedRootObjectComp, PartitionableObject, PartitionableObjectComp, Readable, Root, SchedulerEntity, SchedulerEntityComp, TableDefinitionComp, UniqueNamedApplicationObject

public interface TableDefinition
extends TableDefinitionComp, UniqueNamedApplicationObject, Readable

A table definition for a user or system defined table.

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "TableDefinition" 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_VIEW	This privilege can be granted at a group level.
static String	SEC_RANK_ALL	This rank is made of the following privileges: create , view , 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 , delete
static String	SEC_RANK_EDIT	This rank is made of the following privileges: create , view , edit
static String	SEC_RANK_NONE	This rank has no privileges assigned to it.
static String	SEC_RANK_VIEW	This rank is made of the following privileges: view
static QueryObjectType<TableDefinition>	TYPE	Type that can be used in SchedulerSession.executeObjectQuery(QueryObjectType, String, Object...).
static String	VARIABLES_DEFINITION	The name of the standard variables table definition

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

COPYRIGHT_MESSAGE_BKO, ID_BKO

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

COPYRIGHT_MESSAGE_E, ID_E

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
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	checkEditPrivilege()	Check whether or not the edit action can be performed on this object.
RequiredPermission	checkViewPrivilege()	Check whether or not the view action can be performed on this object.
TableDefinitionColumn	createTableDefinitionColumn()	Create a new TableDefinitionColumn linked to this object.
TableDefinitionConstraint	createTableDefinitionConstraint(ConstraintDefinition newConstraintDefinition)	Create a new TableDefinitionConstraint linked to this object.
TableDefinitionColumn	getTableDefinitionColumnByColumnName(String columnName)	Get the TableDefinitionColumn by TableDefinitionColumnName.
RWIterable<TableDefinitionColumn>	getTableDefinitionColumns()	Get an RWIterable over a collection of TableDefinitionColumns, the collection will be ordered by DisplayOrder.
TableDefinitionConstraint	getTableDefinitionConstraintByName(String name)	Get the TableDefinitionConstraint by TableDefinitionTableDefinitionConstraintName.
RWIterable<TableDefinitionConstraint>	getTableDefinitionConstraints()	Get an RWIterable over an ordered collection of TableDefinitionConstraints.
RWIterable<Table>	getTables()	Get an RWIterable over an ordered collection of Tables.

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

getParentApplication, setParentApplication

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

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

See Also:

Constant Field Values

TYPE

static final QueryObjectType<TableDefinition> TYPE

Type that can be used in SchedulerSession.executeObjectQuery(QueryObjectType, String, Object...).

VARIABLES_DEFINITION

static final String VARIABLES_DEFINITION

The name of the standard variables table definition

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_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_EDIT

static final String SEC_RANK_EDIT

This rank is made of the following privileges: create , view , 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 , 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 , edit , delete

See Also:

Constant Field Values

Method Detail

getTables

RWIterable<Table> getTables()

Get an RWIterable over an ordered collection of Tables. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. What type of object raised this alert?

Specified by:

getTables in interface TableDefinitionComp

Returns:

An RWIterable over an ordered collection of Table objects .

getTableDefinitionColumns

RWIterable<TableDefinitionColumn> getTableDefinitionColumns()

Get an RWIterable over a collection of TableDefinitionColumns, 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. Email alert gateway headers.

Specified by:

getTableDefinitionColumns in interface TableDefinitionComp

Returns:

An RWIterable over a collection of TableDefinitionColumn objects , the collection will be ordered by DisplayOrder.

createTableDefinitionColumn

TableDefinitionColumn createTableDefinitionColumn()

Create a new TableDefinitionColumn linked to this object.

Returns:

a new TableDefinitionColumn.

getTableDefinitionColumnByColumnName

TableDefinitionColumn getTableDefinitionColumnByColumnName(String columnName)

Get the TableDefinitionColumn by TableDefinitionColumnName.

Parameters:

columnName -

Returns:

the TableDefinitionColumn, or null if it could not be found

getTableDefinitionConstraints

RWIterable<TableDefinitionConstraint> getTableDefinitionConstraints()

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

Specified by:

getTableDefinitionConstraints in interface TableDefinitionComp

Returns:

An RWIterable over an ordered collection of TableDefinitionConstraint objects .

createTableDefinitionConstraint

TableDefinitionConstraint createTableDefinitionConstraint(ConstraintDefinition newConstraintDefinition)

Create a new TableDefinitionConstraint linked to this object.

Parameters:

newConstraintDefinition - The other parent of the TableDefinitionConstraintConstraintDefinition association.

Returns:

a new TableDefinitionConstraint.

getTableDefinitionConstraintByName

TableDefinitionConstraint getTableDefinitionConstraintByName(String name)

Get the TableDefinitionConstraint by TableDefinitionTableDefinitionConstraintName.

Parameters:

name -

Returns:

the TableDefinitionConstraint, or null if it could not be found

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.

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.