de.mid.innovator.srv2api.icw2er
Interface ERUniqueKey

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

public interface ERUniqueKey
extends IMUniqueKey

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
static class ERUniqueKey.VAttr
           
 
Method Summary
 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).
 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.
 String getShortName()
          Short name of this ERUniqueKey.
 List<MEStereotypeAble> maintain()
          Runs all maintaining methods for this ERUniqueKey in the following order:
maintainRoles(...)
 List<MEStereotypeAble> maintainForeignKeys()
          Runs the maintaining methods for all foreign keys of this ERUniqueKey which are not yet assigned to a relationship.
 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.
 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.
 void setShortName(String value)
          Set the value of Attribut ShortName.
 
Methods inherited from interface de.mid.innovator.srv2api.icw2im.IMUniqueKey
getKeyKind, getKeyRelationship, getOwnedUniqueKeyFeature, setKeyKind
 
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.icw2meta.ADHistoryAble
getCreateTime, getCreator, getHistory, getModifier, getModifyTime, modifyHistory, setHistory
 
Methods inherited from interface de.mid.innovator.srv2api.icw2model.MEConstraintAble
getAssignedConstraint, getAssignedConstraint, getConstraintAssign
 
Methods inherited from interface de.mid.innovator.srv2api.icw2model.MEStereotypeAble
getClientMappingDependency, getOutgoingConceptRealization, getProxyAsgProperty, getRealizedConcept, getRealizedConcept, getRepresentingArtifact, getRequirementOfStakeholder, getRequirementOfStakeholderOwner, isMapped, replaceRealizedConcepts, setMapped, setRealizedConcept, setRequirementOfStakeholder
 
Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMCommentContainerAble
getOwnedComment
 
Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMStereotypeAble
assignStereotypeDlg, cloneElement, getAttrCnstrEffective, getCreateTemplate, getDisplayType, getOwnedFormat, getOwnedStereotypePropertyValSpec, getPropBoolValue, getPropLongValue, getPropStringValue, getPropValueList, getStereoPropValueByPattern, getStereoPropValueByPattern, getStereotype, getStereotypeName, getStereotypeProperty, getStereotypePropertyInfo, getStereotypePropertyNameValue, isCloneAbleElement, modifyStereotypePropertyValuesByName, setStereotype, setStereotypePropertyInfo
 
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.ELValueContainerAble
getValueReUseAble, setValueReUseAble
 
Methods inherited from interface de.mid.innovator.srv2api.icw2model.MECommentAble
getAssignedComment, getAssignedComment, getCommentAssign
 
Methods inherited from interface de.mid.innovator.srv2api.icw2model.MENamespaceAsgnAble
getMENamespace
 
Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELUUIDAble
getUUID, setUUID
 
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.icw2model.MENamedElement
getMESupplierDependency, getMESupplierMappingDependency
 
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.icw2meta.ADClientAble
getAnnotation, getLogic, getLogic, getPresentationContext, getSection
 
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.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.ELObject
getId, getLongId, getMetaClass, getMetaName, getOclClass, getSrvCon, hasRead
 
Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELNamedElement
getName, getNameKind, getQualifiedDisplayName, getQualifiedName, getQualifiedTLName, getResetDefaultName, getSupplierDependency, rename, setName, setNameKind, setResetDefaultName
 
Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMTextAble
getFlowExpandedValue, getModifyFlowDocuments, getModifyTextValues, getModifyTextValuesDlgInit, getOwnedTextValue, getOwnedTextValueByPattern, getTextExpandedValue, getTextStringValue, getURIList, modifyFlowDocuments, modifyTextValuesDlg
 
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.MMAttachmentAble
getAssignedAttachment, getAttachmentAssign, getDefaultAttachment, getOwnedAttachment, setDefaultAttachment
 

Method Detail

getForeignKeyWithoutForeignKeyAble

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
Sorted:
the result may be sorted according to the key order in the table.

getForeignKeyWithoutForeignKeyAble

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

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

getShortName

String getShortName()
                    throws InoNetException,
                           SrvErrorException
Short name of this ERUniqueKey.

Throws:
InoNetException
SrvErrorException

maintain

List<MEStereotypeAble> maintain()
                                throws InoNetException,
                                       SrvErrorException
Runs all maintaining methods for this ERUniqueKey in the following order:
maintainRoles(...) maintainForeignKeys(...)

Throws:
InoNetException
SrvErrorException

maintainForeignKeys

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

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

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

setShortName

void setShortName(String value)
                  throws InoNetException,
                         SrvErrorException
Set the value of Attribut ShortName.

Parameters:
value - The value to be set.
Throws:
InoNetException
SrvErrorException