Package 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, METermAble, 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!

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	IMKeyRelationship.VAttr

Method Summary

Modifier and Type	Method	Description
String	getJoinExpressionFlow(IMViewFrom ohUniqueKeyFrom, IMViewFrom ohForeignKeyFrom)	Returns the expression for the key relationship join, formatted as flow document.
<T extends IMClassifier> List<T>	getKeyClassifier(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	Returns a list of two elements.
<T extends IMClassifier> List<T>	getKeyClassifier(Class<T> returnType, MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags)	The method calls getKeyClassifier and filters its return values according to the given stereotype value.
List<IMKeyRelationshipFeature>	getOwnedKeyRelationshipFeature(K_CONTROL_OPTION... behaviourFlags)	List of key relationship features of this IMKeyRelationship.
IMUniqueKey	getUniqueKey()	Reference to the unique key referenced by this key relationship.
IMClassifier	getUniqueKeyClassifier()	The classifier of the referenced IMUniqueKey.
<T extends IMViewFrom> List<T>	getViewFrom(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	All FROM Clauses using this IMKeyRelationship.
boolean	isIdentifying()	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.
boolean	isMaxOne()	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.
boolean	isOptional()	True, if this IMKeyRelationship is an optional foreign key. This is true if one member of it is nullable.
void	maintainDeleteForeignProperties()	This maintaining method deletes the key relationship features which reference to an illegal IMUniqueKeyFeature.
void	setUniqueKey(IMUniqueKey value)	Set the value of Foreign Key UniqueKey.
void	setUniqueKeyAndMaintain(IMUniqueKey value)	Set the value of Foreign Key UniqueKey.

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADClientAble

getAnnotation, getEndAnalysisDia, getLogic, getLogic, getPresentationContext, getSection, getStartAnalysisDia

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADHistoryAble

getCreateTime, getCreator, getHistory, getModifier, getModifyTime, modifyHistory, setHistory

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADM2AttrModifyAble

getTabCell, getTabCellObjectList, getTabCreateTemplate, getTabCreateTemplateObjectList, getTabElement, getTabElementRelshipTypeList, getTabElementRowList, getTabElementRowTypeList, getTabRelshipList, getTabRowList, tabCellModify, tabCreateTemplate, tabElementModify

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELContainerAble

getClientDependency, getOwnedElement, getOwnedElementTransitiveDown, getOwnedElementTransitiveDown, getOwnedElementTransitiveDownAndUnresolved, getOwnedElementTransitiveDownAndUnresolved, getOwnedOrReferencedElementTransitiveDown, getOwnedOrReferencedElementTransitiveDown, getOwnedRelshipBinDirWithTarget, getOwnedRelshipBinDirWithTarget, getRedirectedModelContainer, getRelshipBinDirSource, getSelfAndOwnedElementTransitiveDown, getSelfAndOwnedElementTransitiveDown, getSortedContents, sortContents

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELContAsgnAble

getAsgnKind, getContSortOrder, getFirstOwnerWhichIsConformTo, getOwner, getOwnerTransitive, getOwnerTransitive, getSelfAndOwnerTransitive, getSelfAndOwnerTransitive, getVersionRoot, isTransitiveChildOf, setAsgnKind, setContSortOrder, setOwner

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELDeleteAble

delete

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELElement

duplicateElement, getAssignAbleToVattr, getAssignAbleToVattr, getClientId, getCreateTemplateOfInstance, getDisplayBitmap, getDisplayColor, getDisplayFont, getDisplayLine, getDisplayName, getDisplayNameShort, getDisplayNSName, getElementCache, getElementMappingInformation, getNotificationElement, getQualifiedNamespaceName, getRelshipBinDir, getRelshipBinDir, getRelshipBinDirTarget, getUnitToLock, getValSpecElement, isContainedInProfile, isUnresolved, lockUnit, setUnresolved, unlockUnit

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELNamedElement

getName, getNameKind, getQualifiedDisplayName, getQualifiedName, getQualifiedTLName, getSupplierDependency, rename, setName, setNameKind

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELNamespaceAsgnAble

getMnClassicTREFName, getNamespace, getNamespaceName, getPath, getSeparator, getVisibility, setUniqueName, setVisibility

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELObject

getId, getLongId, getMetaClass, getMetaName, getOclClass, getSrvCon, hasRead

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELUUIDAble

getHyperlinkReferenceAble, getInnoRef, getNotToTranslateAttribute, getTranslatedValue, getUUID, setUUID

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELValueContainerAble

getValueReUseAble, setValueReUseAble

Methods inherited from interface de.mid.innovator.srv2api.icw2im.IMKey

getAddableProperty, getAddableProperty, getFeatureNames, getOwnedKeyFeature, getOwningClassifier, getProperty, getProperty, hasNullProperty, isCompleteInView, setFeatureNames, setNull

Methods inherited from interface de.mid.innovator.srv2api.icw2model.MECommentAble

getAssignedComment, getAssignedComment, getCommentAssign

Methods inherited from interface de.mid.innovator.srv2api.icw2model.MEConstraintAble

getAssignedConstraint, getAssignedConstraint, getConstraintAssign

Methods inherited from interface de.mid.innovator.srv2api.icw2model.MEModelElement

buildProxyConnection, getActivityPartition, getConsider, getContentStereotypeByClass, getCreateTemplateByClass, getDataModel, getDataModelName, getElementColor, getFirstValidContentStereotype, getIgnore, getKnownTypeSystems, getMEModelName, getModelElement, getModelElement, getPresContext, getPresContext, getPresetMapping, getPRPresContent, setElementColor

Methods inherited from interface de.mid.innovator.srv2api.icw2model.MENamedElement

getMappingSourceElement, getMappingSourceElement, getMESupplierDependency, getMESupplierMappingDependency

Methods inherited from interface de.mid.innovator.srv2api.icw2model.MENamespaceAsgnAble

getMENamespace, getSignatureMessage

Methods inherited from interface de.mid.innovator.srv2api.icw2model.MEStereotypeAble

getApplicableAnalysisDia, getClientMappingDependency, getDecisionMade, getDecisionOwned, getKnowledgeSourceOfOwner, getMappingTargetElement, getMappingTargetElement, getProxyAsgProperty, getRepresentingArtifact, getRequirementOfStakeholder, getRequirementOfStakeholderOwner, isMapped, setMapped, setRequirementOfStakeholder

Methods inherited from interface de.mid.innovator.srv2api.icw2model.METermAble

getTerm, setTerm

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMAttachmentAble

getAssignedAttachment, getAttachmentAssign, getDefaultAttachment, getOwnedAttachment, setDefaultAttachment

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMCommentContainerAble

getOutgoingConceptRealization, getOwnedComment, getRealizedConcept, getRealizedConcept, replaceRealizedConcepts, setRealizedConcept

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMLabelAble

getLabel, getLabelBoolValue, getLabelColor, getLabelInfo, getLabelLongValue, getLabelNameValue, getLabelStringValue, getLabelValueByPattern, getLabelValueByPattern, getLabelValueList, getOwnedLabelValSpec, hasLabel, modifyLabelValuesByName, setLabelInfo

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMStereotypeAble

assignStereotypeDlg, cloneElement, completelySynchronizeOthers, completelySynchronizeThis, getAttrCnstrEffective, getCreateTemplate, getDisplayType, getOwnedFormat, getOwnedStereotypePropertyValSpec, getOwnedStereotypeTSOptionValSpec, getOwnedSyncedElement, getPropBoolValue, getPropLongValue, getPropStringValue, getPropValueList, getStereoPropValueByPattern, getStereoPropValueByPattern, getStereotype, getStereotypeName, getStereotypeProperty, getStereotypePropertyInfo, getStereotypePropertyNameValue, getStereotypeTSOption, getStereotypeTSOptionBoolValue, getStereotypeTSOptionInfo, getStereotypeTSOptionLongValue, getStereotypeTSOptionNameValue, getStereotypeTSOptionStringValue, getStereotypeTSOptionValueByPattern, getStereotypeTSOptionValueByPattern, getStereotypeTSOptionValueList, getSyncedElement, getSyncedStereotypeAble, getSyncedStereotypeAble, isCloneAbleElement, modifyStereotypePropertyValuesByName, modifyStereotypeTSOptionValuesByName, setStereotype, setStereotypePropertyInfo, setStereotypeTSOptionInfo, setSyncedStereotypeAble

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMTextAble

getFlowExpandedValue, getModifyFlowDocuments, getModifyTextValues, getModifyTextValuesDlgInit, getOwnedTextValue, getOwnedTextValueByPattern, getText, getTextExpandedValue, getTextStringValue, getURIList, modifyFlowDocuments, modifyTextValuesDlg

Method Details

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

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

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

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

getUniqueKeyClassifier

IMClassifier getUniqueKeyClassifier()
                             throws InoNetException,
SrvErrorException

The classifier of the referenced IMUniqueKey.

Throws:

InoNetException

SrvErrorException

getJoinExpressionFlow

String getJoinExpressionFlow(IMViewFrom ohUniqueKeyFrom,
 IMViewFrom ohForeignKeyFrom)
                      throws InoNetException,
SrvErrorException

Returns the expression for the key relationship join, formatted as flow document.

Parameters:

ohUniqueKeyFrom - The From Clause referencing the unique key classifier

ohForeignKeyFrom - The From Clause referencing the foreign key classifier

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

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.

getViewFrom

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

All FROM Clauses using this IMKeyRelationship.

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

getUniqueKey

IMUniqueKey getUniqueKey()
                  throws InoNetException,
SrvErrorException

Reference to the unique key referenced by this key relationship.

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

setUniqueKeyAndMaintain

void setUniqueKeyAndMaintain(IMUniqueKey value)
                      throws InoNetException,
SrvErrorException

Set the value of Foreign Key UniqueKey.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException