Package de.mid.innovator.srv2api.icw2im

Interface IMKey

All Superinterfaces:

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

All Known Subinterfaces:

DBForeignKey, DBUniqueKey, ERForeignKey, ERUniqueKey, IMKeyRelationship, IMUniqueKey

public interface IMKey
extends ADHistoryAble, MEConstraintAble, MEStereotypeAble, MECommentAble, MENamespaceAsgnAble, MMLabelTextAttachmentAble

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

Note:

The interface IMKey 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 class	IMKey.VAttr

Method Summary

Modifier and Type	Method	Description
<T extends IMProperty> java.util.List<T>	getAddableProperty(java.lang.Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	List of all addable properties.
<T extends IMProperty> java.util.List<T>	getAddableProperty(java.lang.Class<T> returnType, MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags)	The method calls getAddableProperty and filters its return values according to the given stereotype value.
java.lang.String	getFeatureNames()	Returns the names of the features as a comma separated string.
<T extends IMKeyFeature> java.util.List<T>	getOwnedKeyFeature(java.lang.Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	List of key features of this IMKey.
IMClassifier	getOwningClassifier()	Reference to the classifier (ER entity or DB table) of this key.
<T extends IMFeature> java.util.List<T>	getProperty(java.lang.Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	Gets all features of this IMKey, unique or foreign key. In DB context, these features are columns; in ER context, these features are attributes.
<T extends IMFeature> java.util.List<T>	getProperty(java.lang.Class<T> returnType, MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags)	The method calls getProperty and filters its return values according to the given stereotype value.
boolean	hasNullProperty()	If true, a nullable IMProperty is part of this key.
boolean	isCompleteInView(ELView refObj)	Is true, if all features of the key are viewed by the argument refObj.
void	setFeatureNames(java.lang.String value)	Set the value of Info FeatureNames.
void	setNull(boolean setNull)	Sets all DBTableColumns of the IMKey to null or not null.

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.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.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

hasNullProperty

boolean hasNullProperty()
                 throws InoNetException,
                        SrvErrorException

If true, a nullable IMProperty is part of this key.

Throws:

InoNetException

SrvErrorException

getFeatureNames

java.lang.String getFeatureNames()
                          throws InoNetException,
                                 SrvErrorException

Returns the names of the features as a comma separated string.

Throws:

InoNetException

SrvErrorException

setFeatureNames

void setFeatureNames(java.lang.String value)
              throws InoNetException,
                     SrvErrorException

Set the value of Info FeatureNames.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

isCompleteInView

boolean isCompleteInView(ELView refObj)
                  throws InoNetException,
                         SrvErrorException

Is true, if all features of the key are viewed by the argument refObj.

Parameters:

refObj - A further instance of type ELView which is used to control the behaviour of the method. (see description above)

Throws:

InoNetException

SrvErrorException

getAddableProperty

<T extends IMProperty> java.util.List<T> getAddableProperty(java.lang.Class<T> returnType,
                                                            K_CONTROL_OPTION... behaviourFlags)
                                                     throws InoNetException,
                                                            SrvErrorException

List of all addable properties. These are all properties of the owning classifier which are not yet part of the 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

getAddableProperty

<T extends IMProperty> java.util.List<T> getAddableProperty(java.lang.Class<T> returnType,
                                                            MMStereotype stereotype,
                                                            K_CONTROL_OPTION... behaviourFlags)
                                                     throws InoNetException,
                                                            SrvErrorException

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

getProperty

<T extends IMFeature> java.util.List<T> getProperty(java.lang.Class<T> returnType,
                                                    K_CONTROL_OPTION... behaviourFlags)
                                             throws InoNetException,
                                                    SrvErrorException

Gets all features of this IMKey, unique or foreign key.
In DB context, these features are columns; in ER context, these features are attributes.

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

Sorted:

the list is sorted according to appropriate feature order in the key.

getProperty

<T extends IMFeature> java.util.List<T> getProperty(java.lang.Class<T> returnType,
                                                    MMStereotype stereotype,
                                                    K_CONTROL_OPTION... behaviourFlags)
                                             throws InoNetException,
                                                    SrvErrorException

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

setNull

void setNull(boolean setNull)
      throws InoNetException,
             SrvErrorException

Sets all DBTableColumns of the IMKey to null or not null.

Parameters:

setNull -

Throws:

InoNetException

SrvErrorException

getOwnedKeyFeature

<T extends IMKeyFeature> java.util.List<T> getOwnedKeyFeature(java.lang.Class<T> returnType,
                                                              K_CONTROL_OPTION... behaviourFlags)
                                                       throws InoNetException,
                                                              SrvErrorException

List of key features of this IMKey.

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

Sorted:

the list is sorted according to appropriate feature order in the key.

getOwningClassifier

IMClassifier getOwningClassifier()
                          throws InoNetException,
                                 SrvErrorException

Reference to the classifier (ER entity or DB table) of this key.

Throws:

InoNetException

SrvErrorException