Package de.mid.innovator.srv2api.icw2er

Interface ERUniqueKey

All Superinterfaces:

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

public interface ERUniqueKey
extends IMUniqueKey, ELShortNameAble

An ERUniqueKey is a collection of attributes of its ERAttributeSet. The values of this collection are unique for one instance of the attributes set. If these values cannot change within the lifetime of the instance, the unique key is called a key candidate. One key candidate can be choosen as primary key for identifying the instance by default.

See Also:

ERUniqueKeyHelper

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ERUniqueKey.VAttr

Method Summary

Modifier and Type	Method	Description
java.util.List<ERForeignKey>	getForeignKeyWithoutForeignKeyAble(K_CONTROL_OPTION... behaviourFlags)	List of all foreign keys that reference this ERUniqueKey and are not yet assigned to an IMForeignKeyAble (ERRole or ERGeneralization).
java.util.List<ERForeignKey>	getForeignKeyWithoutForeignKeyAble(MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags)	The method calls getForeignKeyWithoutForeignKeyAble and filters its return values according to the given stereotype value.
EREntity	getOwningEntity()	Reference to the entity of the key.
ERView	getOwningView()	Reference to the EREntity of the ERUniqueKey.
java.util.List<MEStereotypeAble>	maintain()	Runs all maintaining methods for this ERUniqueKey in the following order: maintainRoles(...)
java.util.List<MEStereotypeAble>	maintainForeignKeys()	Runs the maintaining methods for all foreign keys of this ERUniqueKey which are not yet assigned to a relationship.
java.util.List<MEStereotypeAble>	maintainGeneralizations()	Runs the maintaining methods for all generalizations of the EREntity of this ERUniqueKey in order to maintain the foreign keys in dependent entities.
java.util.List<MEStereotypeAble>	maintainRoles()	Runs the maintaining methods for all unique key roles of the EREntity of this ERUniqueKey in order to maintain the foreign keys.

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, getTabElementRowList, getTabElementRowTypeList, 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, 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.ELShortNameAble

getShortName, setShortName

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

getHyperlinkReferenceAble, 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.icw2im.IMUniqueKey

getKeyKind, getKeyRelationship, getOwnedUniqueKeyFeature, setKeyKind

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, 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.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, getTextExpandedValue, getTextStringValue, getURIList, modifyFlowDocuments, modifyTextValuesDlg

Method Detail

getForeignKeyWithoutForeignKeyAble

java.util.List<ERForeignKey> getForeignKeyWithoutForeignKeyAble(K_CONTROL_OPTION... behaviourFlags)
                                                         throws InoNetException,
                                                                SrvErrorException

List of all foreign keys that reference this ERUniqueKey and are not yet assigned to an IMForeignKeyAble (ERRole or ERGeneralization).

Parameters:

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

Throws:

InoNetException

SrvErrorException

getForeignKeyWithoutForeignKeyAble

java.util.List<ERForeignKey> getForeignKeyWithoutForeignKeyAble(MMStereotype stereotype,
                                                                K_CONTROL_OPTION... behaviourFlags)
                                                         throws InoNetException,
                                                                SrvErrorException

The method calls getForeignKeyWithoutForeignKeyAble 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

maintain

java.util.List<MEStereotypeAble> maintain()
                                   throws InoNetException,
                                          SrvErrorException

Runs all maintaining methods for this ERUniqueKey in the following order:
maintainRoles(...) maintainForeignKeys(...)

Throws:

InoNetException

SrvErrorException

maintainForeignKeys

java.util.List<MEStereotypeAble> maintainForeignKeys()
                                              throws InoNetException,
                                                     SrvErrorException

Runs the maintaining methods for all foreign keys of this ERUniqueKey which are not yet assigned to a relationship.

Throws:

InoNetException

SrvErrorException

maintainGeneralizations

java.util.List<MEStereotypeAble> maintainGeneralizations()
                                                  throws InoNetException,
                                                         SrvErrorException

Runs the maintaining methods for all generalizations of the EREntity of this ERUniqueKey in order to maintain the foreign keys in dependent entities.

Throws:

InoNetException

SrvErrorException

maintainRoles

java.util.List<MEStereotypeAble> maintainRoles()
                                        throws InoNetException,
                                               SrvErrorException

Runs the maintaining methods for all unique key roles of the EREntity of this ERUniqueKey in order to maintain the foreign keys.

Throws:

InoNetException

SrvErrorException

getOwningEntity

EREntity getOwningEntity()
                  throws InoNetException,
                         SrvErrorException

Reference to the entity of the key.

Throws:

InoNetException

SrvErrorException

getOwningView

ERView getOwningView()
              throws InoNetException,
                     SrvErrorException

Reference to the EREntity of the ERUniqueKey.

Throws:

InoNetException

SrvErrorException