de.mid.innovator.srv2api.icw2im
Interface IMKeyRelationship

All Superinterfaces:

ADClientAble, ADFindAble, ADHistoryAble, ADM2AttrModifyAble, ELContainerAble, ELContAsgnAble, ELDeleteAble, ELElement, ELNamedElement, ELNamespaceAsgnAble, ELObject, ELUUIDAble, ELValueContainerAble, IMKey, MECommentAble, MEConstraintAble, MEModelElement, MENamedElement, MENamespaceAsgnAble, MEStereotypeAble, MMAttachmentAble, MMCommentContainerAble, MMLabelAble, MMLabelTextAttachmentAble, MMStereotypeAble, MMTextAble

All Known Subinterfaces:

DBForeignKey, ERForeignKey

public interface IMKeyRelationship
extends IMKey

This is a utility class for IMKeyRelationship that provides static methods for creation or other purposes.

Note:

The interface IMKeyRelationship describes an abstract ability of an object. Therefore no instances of this type can be found in the repository!

getKeyClassifier

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

Returns a list of two elements. The first element is the classifier which owns the referenced unique key. The second element is the classifier which owns this foreign key.

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

getKeyClassifier

<T extends IMClassifier> List<T> getKeyClassifier(Class<T> returnType,
                                                  MMStereotype stereotype,
                                                  K_CONTROL_OPTION... behaviourFlags)
                                              throws InoNetException,
                                                     SrvErrorException

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

Parameters:

returnType - Specifies the type of elements to be returned.

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

getOwnedKeyRelationshipFeature

List<IMKeyRelationshipFeature> getOwnedKeyRelationshipFeature(K_CONTROL_OPTION... behaviourFlags)
                                                              throws InoNetException,
                                                                     SrvErrorException

List of key relationship features of this IMKeyRelationship.

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 feature order in the key.

getUniqueKey

IMUniqueKey getUniqueKey()
                         throws InoNetException,
                                SrvErrorException

Reference to the unique key referenced by this key relationship.

Throws:

InoNetException

SrvErrorException

getUniqueKeyClassifier

IMClassifier getUniqueKeyClassifier()
                                    throws InoNetException,
                                           SrvErrorException

The classifier of the referenced IMUniqueKey.

Throws:

InoNetException

SrvErrorException

isIdentifying

boolean isIdentifying()
                      throws InoNetException,
                             SrvErrorException

True, if this IMKeyRelationship is an identifying foreign key.
This is true if all of its members are part of the primary key of its IMClassifier.

Throws:

InoNetException

SrvErrorException

isMaxOne

boolean isMaxOne()
                 throws InoNetException,
                        SrvErrorException

True, if this IMKeyRelationship can store no more than one row for the same referenced row of the IMUniqueKey.
This is true if this foreign key contains the same set of members as any unique key of its IMClassifier.

Throws:

InoNetException

SrvErrorException

isOptional

boolean isOptional()
                   throws InoNetException,
                          SrvErrorException

True, if this IMKeyRelationship is an optional foreign key.
This is true if one member of it is nullable.

Throws:

InoNetException

SrvErrorException

maintainDeleteForeignProperties

void maintainDeleteForeignProperties()
                                     throws InoNetException,
                                            SrvErrorException

This maintaining method deletes the key relationship features which reference to an illegal IMUniqueKeyFeature. A unique key feature is illegal in this context if the owning IMUniqueKey is not the same as referenced by the IMKeyRelationship.
If a key relationship feature will be deleted within this maintaining method, the used IMStructuralFeature will be deleted too if no further key relationship features exist for this structural feature.

Throws:

InoNetException

SrvErrorException

setUniqueKey

void setUniqueKey(IMUniqueKey value)
                  throws InoNetException,
                         SrvErrorException

Set the value of Foreign Key UniqueKey.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException