Package de.mid.innovator.srv2api.icw2er

Interface ERAttribute

All Superinterfaces:

ADClientAble, ADFindAble, ADHistoryAble, ADM2AttrModifyAble, ELContainerAble, ELContAsgnAble, ELDeleteAble, ELElement, ELFeature, ELMultiplicityAble, ELMultiplicityAbleTypedElement, ELNamedElement, ELNamespaceAsgnAble, ELObject, ELProperty, ELRedefAble, ELShortNameAble, ELStructFeature, ELTypedElement, ELUUIDAble, ELValueContainerAble, ELViewNavigAble, ERUsedAttribute, IMFeature, IMProperty, IMStructuralFeature, MECommentAble, MEConstraintAble, MEModelElement, MENamedElement, MENamespaceAsgnAble, MEStereotypeAble, MMAttachmentAble, MMCommentContainerAble, MMLabelAble, MMLabelTextAttachmentAble, MMStereotypeAble, MMTextAble

public interface ERAttribute
extends ERUsedAttribute

An ERAttribute is a property of an EREntity.

See Also:

ERAttributeHelper

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ERAttribute.VAttr

Method Summary

Modifier and Type	Method	Description
java.util.List<ERForeignKey>	getERForeignKey(K_CONTROL_OPTION... behaviourFlags)	List of foreign keys that use this attribute.
java.util.List<ERAttribute>	getERKeyRelationshipAttribute(K_CONTROL_OPTION... behaviourFlags)	List of foreign key attributes, referencing this unique key attribute.
java.util.List<ERAttribute>	getERKeyRelationshipAttributeRecursive(EREntity refObj, K_CONTROL_OPTION... behaviourFlags)	List of foreign key attributes, referencing this unique key attribute indirectly.
IMSemanticDataType	getERTypingSemanticDataType()	The semantic data type that types this ERAttribute.
java.util.List<ERUniqueKey>	getERUniqueKey(K_CONTROL_OPTION... behaviourFlags)	List of unique keys (primary, candidate or unique) that use this attribute.
<T extends ERUsedAttribute> java.util.List<T>	getERUniqueKeyAttribute(java.lang.Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	List of unique key attributes, referenced by this foreign key attribute.
<T extends ERUsedAttribute> java.util.List<T>	getERUniqueKeyAttributeOrigin(java.lang.Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	Gets the origin attributes of this foreign key attribute.
ERAttribute	getFirstValidTypeAttribute()	Gets the ERAttribute which is valid to evaluate the IMDataType of this attribute.
java.util.List<ERCheckConstraint>	getOwnedERCheckConstraint(K_CONTROL_OPTION... behaviourFlags)	List of check constraints owned by this ERAttribute.
EREntity	getOwningEntity()	Reference to the entity of the attribute definition.
void	setPrimary(boolean setPrimary)	Sets the ERAttribute to primary or not primary.

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

getEntryInGroupAble, getEntryInGroupAble, getUsingViewElement, isStatic, setStatic

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

getLower, getLowerBoundAsString, getLowerUpperVal, getUpper, getUpperBoundAsString, hasMultiplicity11, hasUpper1, isMany, isMultivalued, isOptional, isOrdered, isUnique, setLower, setMany, setOptional, setOrdered, setUnique, setUpper

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

getAggregation, getAssociation, getClassifierOfAssociationEnd, getDefaultValue, getOppositeAssociationEnd, getSelfAndSubsettedTransitive, getSelfAndSubsettedTransitive, getSelfAndSubsettingTransitive, getSelfAndSubsettingTransitive, getSubsettedProperty, getSubsettedTransitive, getSubsettedTransitive, getSubsettingProperty, getSubsettingTransitive, getSubsettingTransitive, getTypingCreateCLInst, isAssocOwner, isComposite, isDerived, isDerivedUnion, isNavigable, isNavigableAssocEnd, isSubsetted, isSubsetting, reconnectAssociation, setAggregation, setAssocOwner, setDefaultValue, setDerived, setDerivedUnion, setNavigableAssocEnd, setSubsettedProperty

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

getRedefined, getRedefining, isLeaf, isRedefined, isRedefining, setLeaf, setRedefined

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

getShortName, setShortName

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

getSlot, getStructuralFeatureAction, isReadOnly, setReadOnly

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

getModifyTypedElementDeclaration, getType, getTypedElementCnstr, getTypeKind, getValSpecOfTypedElement, getValSpecOfTypedElementWithPattern, getValSpecOfTypedElementWithPattern, isBitmapAble, isColorAble, modifyTypedElementDeclaration, setType

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

getViewNavigAbleGroup

Methods inherited from interface de.mid.innovator.srv2api.icw2er.ERUsedAttribute

getBILevelAttribute, getBISortAttribute, getDimensionAttribute, getPropagationViews, getPropagationViews, getUsingERViewElement, getUsingViewAttributeByRef, getUsingViewAttributeByRef

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

getIndex, getIndex, getIndexedFeature, getKey, getKey, getKeyFeature, getKeyRelationshipProperty, getKeyRelationshipProperty, getKeyRelationshipPropertyRecursive, getKeyRelationshipPropertyRecursive, getOwningClassifier

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

getConcreteFirstMasterParameter, getConcreteSecondMasterParameter, getDefaultSetting, getDerivedDataTypeDefinition, getDerivedSemanticDataType, getDerivedTypingTSOrDTType, getFirstValidDerivingTypeProperty, getFirstValidTypeProperty, getKeyRelationship, getKeyRelationship, getOriginProperty, getOwnedTypeDefinition, getTypeClassName, getTypingDataType, getTypingDataTypeDefinition, getTypingSemanticDataType, getUniqueKey, getUniqueKey, getUniqueKeyProperty, getUniqueKeyProperty, getUniqueKeyPropertyOrigin, getUniqueKeyPropertyOrigin, isLocal, isNotNull, merge, setConcreteFirstMasterParameter, setConcreteSecondMasterParameter, setDefaultSetting, setDerivedSemanticDataType, setDerivedTypingTSOrDTType, setNull, split, typeMapping

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

setPrimary

void setPrimary(boolean setPrimary)
         throws InoNetException,
                SrvErrorException

Sets the ERAttribute to primary or not primary.

Parameters:

setPrimary -

Throws:

InoNetException

SrvErrorException

getERForeignKey

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

List of foreign keys that use this attribute.

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.

getERKeyRelationshipAttribute

java.util.List<ERAttribute> getERKeyRelationshipAttribute(K_CONTROL_OPTION... behaviourFlags)
                                                   throws InoNetException,
                                                          SrvErrorException

List of foreign key attributes, referencing this unique key attribute.

Parameters:

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

Throws:

InoNetException

SrvErrorException

getERKeyRelationshipAttributeRecursive

java.util.List<ERAttribute> getERKeyRelationshipAttributeRecursive(EREntity refObj,
                                                                   K_CONTROL_OPTION... behaviourFlags)
                                                            throws InoNetException,
                                                                   SrvErrorException

List of foreign key attributes, referencing this unique key attribute indirectly. This means that if a direct foreign key attribute is part of an unique key referenced by a following foreign key, the attribute of the following foreign key will be returned in this list.
Note: the direct foreign attributes are not part of this list!
The result can be restricted to attributes of the given argument refObj.

Parameters:

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

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

Throws:

InoNetException

SrvErrorException

getERUniqueKey

java.util.List<ERUniqueKey> getERUniqueKey(K_CONTROL_OPTION... behaviourFlags)
                                    throws InoNetException,
                                           SrvErrorException

List of unique keys (primary, candidate or unique) that use this attribute.

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.

getERUniqueKeyAttribute

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

List of unique key attributes, referenced by this foreign key attribute.

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

getERUniqueKeyAttributeOrigin

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

Gets the origin attributes of this foreign key attribute. An origin attribute is a pure unique key attribute at the beginning of a foreign/primary key chain. If a foreign key attribute references more than one unique key attribute the result may contain more than one attribute.

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

getFirstValidTypeAttribute

ERAttribute getFirstValidTypeAttribute()
                                throws InoNetException,
                                       SrvErrorException

Gets the ERAttribute which is valid to evaluate the IMDataType of this attribute. The result attribute is normally this attribute itself, unless this attribute is part of a foreign key. In the second case, the type is normally derived from a unique key attribute which will be returned.

Throws:

InoNetException

SrvErrorException

getOwnedERCheckConstraint

java.util.List<ERCheckConstraint> getOwnedERCheckConstraint(K_CONTROL_OPTION... behaviourFlags)
                                                     throws InoNetException,
                                                            SrvErrorException

List of check constraints owned by this ERAttribute.

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 constraint order in the attribute.

getERTypingSemanticDataType

IMSemanticDataType getERTypingSemanticDataType()
                                        throws InoNetException,
                                               SrvErrorException

The semantic data type that types this ERAttribute.

Throws:

InoNetException

SrvErrorException

getOwningEntity

EREntity getOwningEntity()
                  throws InoNetException,
                         SrvErrorException

Reference to the entity of the attribute definition.

Throws:

InoNetException

SrvErrorException