de.mid.innovator.srv2api.icw2db
Interface DBTableColumn

All Superinterfaces:

ADClientAble, ADFindAble, ADHistoryAble, ADM2AttrModifyAble, DBColumn, DBOptionAble, DBSQLObject, ELContainerAble, ELContAsgnAble, ELDeleteAble, ELElement, ELFeature, ELMultiplicityAble, ELMultiplicityAbleTypedElement, ELNamedElement, ELNamespaceAble, ELNamespaceAsgnAble, ELObject, ELProperty, ELRedefAble, ELStructFeature, ELTypedElement, ELUUIDAble, ELValueContainerAble, ELViewNavigAble, IMFeature, IMProperty, IMStructuralFeature, MECommentAble, MEConstraintAble, MEModelElement, MENamedElement, MENamespaceAsgnAble, MEStereotypeAble, MMAttachmentAble, MMCommentContainerAble, MMLabelAble, MMLabelTextAttachmentAble, MMStereotypeAble, MMTextAble

public interface DBTableColumn
extends DBColumn, DBOptionAble

getDBForeignKey

List<DBForeignKey> getDBForeignKey(K_CONTROL_OPTION... behaviourFlags)
                                   throws InoNetException,
                                          SrvErrorException

List of foreign keys that use this column.

Parameters:

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

Sorted:

the result may be sorted according to the key order in the table.

getDBIndex

List<DBIndex> getDBIndex(K_CONTROL_OPTION... behaviourFlags)
                         throws InoNetException,
                                SrvErrorException

List of indices that use this column.

Parameters:

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

Sorted:

The result may be sorted according to the index order in the table.

getDBIndex

List<DBIndex> getDBIndex(MMStereotype stereotype,
                         K_CONTROL_OPTION... behaviourFlags)
                         throws InoNetException,
                                SrvErrorException

The method calls getDBIndex and filters its return values according to the given stereotype value.

Parameters:

stereotype - The stereotype used to filter the result list

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

getDBKeyRelationshipColumn

List<DBTableColumn> getDBKeyRelationshipColumn(K_CONTROL_OPTION... behaviourFlags)
                                               throws InoNetException,
                                                      SrvErrorException

List of foreign key columns, referencing this unique key column.

Parameters:

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

getDBKeyRelationshipColumnRecursive

List<DBTableColumn> getDBKeyRelationshipColumnRecursive(DBTable refObj,
                                                        K_CONTROL_OPTION... behaviourFlags)
                                                        throws InoNetException,
                                                               SrvErrorException

List of foreign key columns, referencing this unique key column indirectly. This means that if a direct foreign key column is part of an unique key referenced by a following foreign key, the column of the following foreign key will be returned in this list.
Note: the direct foreign columns are not part of this list!
The result can be restricted to columns of the given argument refObj.

Parameters:

refObj - A further instance of type DBTable which is used to control the behaviour of the method. (see description above)

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

getDBTypingSemanticDataType

IMSemanticDataType getDBTypingSemanticDataType()
                                               throws InoNetException,
                                                      SrvErrorException

The semantic data type that types this DBTableColumn.

Throws:

InoNetException

SrvErrorException

getDBUniqueKey

List<DBUniqueKey> getDBUniqueKey(K_CONTROL_OPTION... behaviourFlags)
                                 throws InoNetException,
                                        SrvErrorException

List of unique keys (primary, candidate or unique) that use this column.

Parameters:

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

Sorted:

the result may be sorted according to the key order in the table.

getDBUniqueKeyColumn

<T extends DBColumn> List<T> getDBUniqueKeyColumn(Class<T> returnType,
                                                  K_CONTROL_OPTION... behaviourFlags)
                                              throws InoNetException,
                                                     SrvErrorException

List of unique key columns, referenced by this foreign key column.

Parameters:

returnType - Specifies the type of elements to be returned.

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

getDBUniqueKeyColumnOrigin

<T extends DBColumn> List<T> getDBUniqueKeyColumnOrigin(Class<T> returnType,
                                                        K_CONTROL_OPTION... behaviourFlags)
                                                    throws InoNetException,
                                                           SrvErrorException

Gets the origin columns of this foreign key column. An origin column is a pure unique key column at the beginning of a foreign/primary key chain. If a foreign key column references more than one unique key column the result may contain more than one column.

Parameters:

returnType - Specifies the type of elements to be returned.

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

getFirstValidTypeColumn

DBTableColumn getFirstValidTypeColumn()
                                      throws InoNetException,
                                             SrvErrorException

Gets the DBTableColumn which is valid to evaluate the IMDataType of this column. The result column is normally this column itself, unless this column is part of a foreign key. In the second case, the type is normally derived from a unique key column which will be returned.

Throws:

InoNetException

SrvErrorException

getMergedInstance

List<DBMergedInstance> getMergedInstance()
                                         throws InoNetException,
                                                SrvErrorException

List of all instances using this DBTableColumn.

Throws:

InoNetException

SrvErrorException

getOwnedDBCheckConstraint

List<DBCheckConstraint> getOwnedDBCheckConstraint(K_CONTROL_OPTION... behaviourFlags)
                                                  throws InoNetException,
                                                         SrvErrorException

List of check constraints owned by this DBTableColumn.

Parameters:

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

Sorted:

the list is sorted according to appropriate constraint order in the column.

getOwnedDBOptionTableColumn

List<DBOptionTableColumn> getOwnedDBOptionTableColumn(K_CONTROL_OPTION... behaviourFlags)
                                                      throws InoNetException,
                                                             SrvErrorException

All table column options of this DBTableColumn.

Parameters:

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

Sorted:

the result may be sorted.

getOwningTable

DBTable getOwningTable()
                       throws InoNetException,
                              SrvErrorException

Reference to the table of the column.

Throws:

InoNetException

SrvErrorException

setDBIndex

void setDBIndex(List<? extends DBIndex> values)
                throws InoNetException,
                       SrvErrorException

Set the value of View DBIndex.

Parameters:

values - The value to be set.

Throws:

InoNetException

SrvErrorException

setPrimary

void setPrimary(boolean setPrimary)
                throws InoNetException,
                       SrvErrorException

Sets the DBTableColumn to primary or not primary.

Parameters:

setPrimary -

Throws:

InoNetException

SrvErrorException