de.mid.innovator.srv2api.icw2db
Interface DBForeignKey

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

public interface DBForeignKey
extends IMKeyRelationship, DBOptionAble, DBSQLObject


Nested Class Summary
static class DBForeignKey.VAttr
           
 
Method Summary
 List<DBMergedInstance> getMergedInstance()
          List of all instances using this DBForeignKey.
 List<DBOptionForeignKey> getOwnedDBOptionForeignKey(K_CONTROL_OPTION... behaviourFlags)
          All foreign key options of this DBForeignKey.
 DBTable getOwningTable()
          Reference to the DBTable of this DBForeignKey.
 DBTable getUniqueKeyTable()
          The DB Table that owns the referenced key.
 List<MEStereotypeAble> maintain()
          Runs all maintaining methods for this foreign key in the following order:
maintainCreateForeignAttributes(...)
 List<IMKeyRelationshipFeature> maintainCreateForeignColumns()
          This maintaining method creates the missing foreign key columns.
 
Methods inherited from interface de.mid.innovator.srv2api.icw2im.IMKeyRelationship
getKeyClassifier, getKeyClassifier, getOwnedKeyRelationshipFeature, getUniqueKey, getUniqueKeyClassifier, isIdentifying, isMaxOne, isOptional, maintainDeleteForeignProperties, setUniqueKey
 
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
 
Methods inherited from interface de.mid.innovator.srv2api.icw2db.DBOptionAble
getConfiguredOption, getOwnedDBOption
 
Methods inherited from interface de.mid.innovator.srv2api.icw2db.DBSQLObject
getPrivilege, getReferencedSQLObject, getReferencingSQLObject, setPrivilege, setReferencedSQLObject, setReferencingSQLObject
 

Method Detail

getMergedInstance

List<DBMergedInstance> getMergedInstance()
                                         throws InoNetException,
                                                SrvErrorException
List of all instances using this DBForeignKey.

Throws:
InoNetException
SrvErrorException

getOwnedDBOptionForeignKey

List<DBOptionForeignKey> getOwnedDBOptionForeignKey(K_CONTROL_OPTION... behaviourFlags)
                                                    throws InoNetException,
                                                           SrvErrorException
All foreign key options of this DBForeignKey.

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 DBTable of this DBForeignKey.

Throws:
InoNetException
SrvErrorException

getUniqueKeyTable

DBTable getUniqueKeyTable()
                          throws InoNetException,
                                 SrvErrorException
The DB Table that owns the referenced key.

Throws:
InoNetException
SrvErrorException

maintain

List<MEStereotypeAble> maintain()
                                throws InoNetException,
                                       SrvErrorException
Runs all maintaining methods for this foreign key in the following order:
maintainCreateForeignAttributes(...)

Throws:
InoNetException
SrvErrorException

maintainCreateForeignColumns

List<IMKeyRelationshipFeature> maintainCreateForeignColumns()
                                                            throws InoNetException,
                                                                   SrvErrorException
This maintaining method creates the missing foreign key columns. It looks to the unique key referenced by this foreign key. A new column will be created and assigned to all unique key features which have not got a referencing key relationship feature in this foreign key.
Ifthis foreign key has no key relationship feature at the start, the sort order of a new key relationship feature will be equal to its referenced unique key feature.
Returns the list of the created key relationship features.

Throws:
InoNetException
SrvErrorException