Package de.mid.innovator.srv2api.icw2im

Interface IMProperty

All Superinterfaces:

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

All Known Subinterfaces:

DBColumn, DBTableColumn, DBViewColumn, ERAttribute, ERUsedAttribute, ERViewAttribute

public interface IMProperty
extends ELProperty, IMStructuralFeature

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

See Also:

• IMPropertyHelper

Note:

The interface IMProperty 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 enum	IMProperty.VAttr

Method Summary

Modifier and Type	Method	Description
String	getConcreteFirstMasterParameter()	The concrete first parameter of the IMDataTypeDefinition.
String	getConcreteSecondMasterParameter()	The concrete second parameter of the IMDataTypeDefinition.
K_DEFAULT_SETTING	getDefaultSetting()	The default setting says if the property has either no default value, a default value set by system or an user defined default value.
IMDataTypeDefinition	getDerivedDataTypeDefinition()	Gets the IMDataTypeDefinition which is valid for this IMProperty.
String	getDerivedImplementation()	Technical type, as used in the source code.
String	getDerivedImplementationFormatted(String pattern, int mode)	Formatted technical type, as used in SQL.
ELType	getDerivedIMType()	Gets the ELType which is valid for this IMProperty.
IMSemanticDataType	getDerivedSemanticDataType()	Gets the IMSemanticDataType which is valid for this IMProperty.
ADClientAble	getDerivedTypingTSOrDTType()	Gets the IMDataTypeDefinition which types this DBTableColumn.
IMProperty	getFirstValidDerivingTypeProperty()	Gets the IMProperty which is the first candidate property for deriving its IMDataType to this property, regardless of whether this property is typed by itself.
IMProperty	getFirstValidTypeProperty()	Gets the IMProperty which is valid to evaluate the IMDataType of this property.
<T extends IMKeyRelationship> List<T>	getKeyRelationship(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	List of foreign keys that use this IMProperty.
<T extends IMKeyRelationship> List<T>	getKeyRelationship(Class<T> returnType, MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags)	The method calls getKeyRelationship and filters its return values according to the given stereotype value.
IMProperty	getOriginProperty()	Gets the origin IMProperty of this foreign key property.
List<IMDataTypeDefinition>	getOwnedTypeDefinition(K_CONTROL_OPTION... behaviourFlags)	List of type definitions of this property which is an entity attribute or a database table column.
String	getTypeClassName()	Name of the MMTSTypeClass of the master type of this IMProperty.
IMDataType	getTypingDataType()	The data type that types this property.
IMDataTypeDefinition	getTypingDataTypeDefinition()	The data type definition that types this property.
IMSemanticDataType	getTypingSemanticDataType()	The semantic data type that types this property.
<T extends IMUniqueKey> List<T>	getUniqueKey(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	List of unique keys that use this IMProperty.
<T extends IMUniqueKey> List<T>	getUniqueKey(Class<T> returnType, MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags)	The method calls getUniqueKey and filters its return values according to the given stereotype value.
<T extends IMProperty> List<T>	getUniqueKeyProperty(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	List of unique key properties, referenced by this foreign key property.
<T extends IMProperty> List<T>	getUniqueKeyProperty(Class<T> returnType, MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags)	The method calls getUniqueKeyProperty and filters its return values according to the given stereotype value.
<T extends IMProperty> List<T>	getUniqueKeyPropertyOrigin(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	Gets the origin properties of this foreign key property.
<T extends IMProperty> List<T>	getUniqueKeyPropertyOrigin(Class<T> returnType, MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags)	The method calls getUniqueKeyPropertyOrigin and filters its return values according to the given stereotype value.
boolean	isArray()	True, the property can hold several values of its type in an array.
boolean	isLocal()	True, if the property is a local property, otherwise false.
boolean	isNotNull()	True, if the property is mandatory, otherwise false.
void	merge(List<? extends IMStructuralFeature> seq)	This method merges several properties of the same concrete class ERAttribute or DBTableColumn. The modified property keeps all information about this input property.
void	setArray(boolean value)	Set the value of Info IsArray.
void	setArrayAndMaintain(boolean value)	Set the value of Info IsArray.
void	setConcreteFirstMasterParameter(String value)	Set the value of Info ConcreteFirstMasterParameter.
void	setConcreteSecondMasterParameter(String value)	Set the value of Info ConcreteSecondMasterParameter.
void	setDataTypeByString(String item)	Sets the data type of this property by a string.
void	setDataTypeDefinitionByString(String item)	Sets the technical type of this property by a string with concrete parameters.
void	setDefaultSetting(K_DEFAULT_SETTING value)	Set the value of Attribut DefaultSetting.
void	setDerivedImplementation(String value)	Set the value of Info DerivedImplementation.
void	setDerivedIMType(ELType value)	Set the value of View DerivedIMType.
void	setDerivedSemanticDataType(IMSemanticDataType value)	Set the value of View DerivedSemanticDataType.
void	setDerivedTypingTSOrDTType(ADClientAble value)	Set the value of View DerivedTypingTSOrDTType.
void	setNull(boolean setNull)	Sets the DBTableColumn respectively ERAttribute to null or not null.
List<IMProperty>	split()	This method splits an IMProperty, (ERAttribute or DBTableColumn) to several features. If more than one IMKeyRelationshipFeature of this feature exists, one of these remains at this feature.
void	typeMapping()	If the property is typed by an IMDataTypeDefinition, this command will create data type definitions (if missing) or modify existing data type definitions (if they are not marked as user implementation) according to the type mappings in the configuration.

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, getTabElementRelshipTypeList, getTabElementRowList, getTabElementRowTypeList, getTabRelshipList, 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, getNotificationElement, 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.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, getInnoRef, 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.icw2im.IMFeature

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

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, getDataModel, getDataModelName, 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.icw2model.METermAble

getTerm, setTerm

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

Method Details

getDefaultSetting

K_DEFAULT_SETTING getDefaultSetting()
                             throws InoNetException,
SrvErrorException

The default setting says if the property has either no default value, a default value set by system or an user defined default value.

Throws:

InoNetException

SrvErrorException

setDefaultSetting

void setDefaultSetting(K_DEFAULT_SETTING value)
                throws InoNetException,
SrvErrorException

Set the value of Attribut DefaultSetting.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getDerivedImplementation

String getDerivedImplementation()
                         throws InoNetException,
SrvErrorException

Technical type, as used in the source code.

Throws:

InoNetException

SrvErrorException

setDerivedImplementation

void setDerivedImplementation(String value)
                       throws InoNetException,
SrvErrorException

Set the value of Info DerivedImplementation.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getDerivedImplementationFormatted

String getDerivedImplementationFormatted(String pattern,
 int mode)
                                  throws InoNetException,
SrvErrorException

Formatted technical type, as used in SQL. Use the argument pattern to specify the formatting of structure types! The first two characters are open and close quote unless they are space. A following colon or the letter 'n' means that component names are added, with or without a colon as type separator. And a following newline means that newlines are added. Use the argument mode to give the number of indent blanks.

Parameters:

pattern - A string pattern. This parameter is optional. (Its value can be given as null.)

mode - A value of type TInteger that controls the behaviour of the underlying method. (see description)This parameter is optional. (Its value can be given as null.)

Throws:

InoNetException

SrvErrorException

isNotNull

boolean isNotNull()
           throws InoNetException,
SrvErrorException

True, if the property is mandatory, otherwise false. At the time of creating the owner element, a value for each mandatory property must be known.
Examples: - mandatory attribute of an entity in the entity relationship model - NOT NULL column of an database table

Throws:

InoNetException

SrvErrorException

isArray

boolean isArray()
         throws InoNetException,
SrvErrorException

True, the property can hold several values of its type in an array.

Throws:

InoNetException

SrvErrorException

setArray

void setArray(boolean value)
       throws InoNetException,
SrvErrorException

Set the value of Info IsArray.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

setArrayAndMaintain

void setArrayAndMaintain(boolean value)
                  throws InoNetException,
SrvErrorException

Set the value of Info IsArray.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getTypeClassName

String getTypeClassName()
                 throws InoNetException,
SrvErrorException

Name of the MMTSTypeClass of the master type of this IMProperty.

Throws:

InoNetException

SrvErrorException

getConcreteFirstMasterParameter

String getConcreteFirstMasterParameter()
                                throws InoNetException,
SrvErrorException

The concrete first parameter of the IMDataTypeDefinition.

Throws:

InoNetException

SrvErrorException

setConcreteFirstMasterParameter

void setConcreteFirstMasterParameter(String value)
                              throws InoNetException,
SrvErrorException

Set the value of Info ConcreteFirstMasterParameter.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getConcreteSecondMasterParameter

String getConcreteSecondMasterParameter()
                                 throws InoNetException,
SrvErrorException

The concrete second parameter of the IMDataTypeDefinition.

Throws:

InoNetException

SrvErrorException

setConcreteSecondMasterParameter

void setConcreteSecondMasterParameter(String value)
                               throws InoNetException,
SrvErrorException

Set the value of Info ConcreteSecondMasterParameter.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

isLocal

boolean isLocal()
         throws InoNetException,
SrvErrorException

True, if the property is a local property, otherwise false. A local property is not part of a key, and, if it is a view element, it does not view a non local property

Throws:

InoNetException

SrvErrorException

getDerivedSemanticDataType

IMSemanticDataType getDerivedSemanticDataType()
                                       throws InoNetException,
SrvErrorException

Gets the IMSemanticDataType which is valid for this IMProperty. This could be the type element of this property or evaluated via IMKeyRelationshipFeature.
e.g. a foreign key column derives its type from the referenced primary key column.
The set method assigns the semantic data type to this property, even if the property is a foreign key property! In that case the type of the foreign key property is fixed and will not be derived from the primary key property.

Throws:

InoNetException

SrvErrorException

setDerivedSemanticDataType

void setDerivedSemanticDataType(IMSemanticDataType value)
                         throws InoNetException,
SrvErrorException

Set the value of View DerivedSemanticDataType.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getDerivedDataTypeDefinition

IMDataTypeDefinition getDerivedDataTypeDefinition()
                                           throws InoNetException,
SrvErrorException

Gets the IMDataTypeDefinition which is valid for this IMProperty. This could be owned by this property or evaluated via IMKeyRelationshipFeature.
e.g. a foreign key column derives its type from the referenced primary key column.

Throws:

InoNetException

SrvErrorException

getDerivedIMType

ELType getDerivedIMType()
                 throws InoNetException,
SrvErrorException

Gets the ELType which is valid for this IMProperty. This could be the type element of this property or evaluated via IMKeyRelationshipFeature.
e.g. a foreign key column derives its type from the referenced primary key column.
The set method assigns the type to this property, even if the property is a foreign key property or a view property! In that case the type of the property is fixed and will not be derived from the referenced property.

Throws:

InoNetException

SrvErrorException

setDerivedIMType

void setDerivedIMType(ELType value)
               throws InoNetException,
SrvErrorException

Set the value of View DerivedIMType.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getFirstValidTypeProperty

IMProperty getFirstValidTypeProperty()
                              throws InoNetException,
SrvErrorException

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

Throws:

InoNetException

SrvErrorException

getFirstValidDerivingTypeProperty

IMProperty getFirstValidDerivingTypeProperty()
                                      throws InoNetException,
SrvErrorException

Gets the IMProperty which is the first candidate property for deriving its IMDataType to this property, regardless of whether this property is typed by itself.

Throws:

InoNetException

SrvErrorException

getOriginProperty

IMProperty getOriginProperty()
                      throws InoNetException,
SrvErrorException

Gets the origin IMProperty of this foreign key property. The origin property is the pure unique key property at the beginning of the foreign/primary key chain.

Throws:

InoNetException

SrvErrorException

getKeyRelationship

<T extends IMKeyRelationship> List<T> getKeyRelationship(Class<T> returnType,
 K_CONTROL_OPTION... behaviourFlags)
                                                  throws InoNetException,
SrvErrorException

List of foreign keys that use this IMProperty.

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

getKeyRelationship

<T extends IMKeyRelationship> List<T> getKeyRelationship(Class<T> returnType,
 MMStereotype stereotype,
 K_CONTROL_OPTION... behaviourFlags)
                                                  throws InoNetException,
SrvErrorException

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

getUniqueKey

<T extends IMUniqueKey> List<T> getUniqueKey(Class<T> returnType,
 K_CONTROL_OPTION... behaviourFlags)
                                      throws InoNetException,
SrvErrorException

List of unique keys that use this IMProperty.

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

getUniqueKey

<T extends IMUniqueKey> List<T> getUniqueKey(Class<T> returnType,
 MMStereotype stereotype,
 K_CONTROL_OPTION... behaviourFlags)
                                      throws InoNetException,
SrvErrorException

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

getUniqueKeyProperty

<T extends IMProperty> List<T> getUniqueKeyProperty(Class<T> returnType,
 K_CONTROL_OPTION... behaviourFlags)
                                             throws InoNetException,
SrvErrorException

List of unique key properties, referenced by this foreign key property.

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

getUniqueKeyProperty

<T extends IMProperty> List<T> getUniqueKeyProperty(Class<T> returnType,
 MMStereotype stereotype,
 K_CONTROL_OPTION... behaviourFlags)
                                             throws InoNetException,
SrvErrorException

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

getUniqueKeyPropertyOrigin

<T extends IMProperty> List<T> getUniqueKeyPropertyOrigin(Class<T> returnType,
 K_CONTROL_OPTION... behaviourFlags)
                                                   throws InoNetException,
SrvErrorException

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

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

getUniqueKeyPropertyOrigin

<T extends IMProperty> List<T> getUniqueKeyPropertyOrigin(Class<T> returnType,
 MMStereotype stereotype,
 K_CONTROL_OPTION... behaviourFlags)
                                                   throws InoNetException,
SrvErrorException

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

getDerivedTypingTSOrDTType

ADClientAble getDerivedTypingTSOrDTType()
                                 throws InoNetException,
SrvErrorException

Gets the IMDataTypeDefinition which types this DBTableColumn. This type is called the master implementation and leads to mapped types of other type systems.
Setter characteristic:
If this IMProperty doesn't own a data type definition yet, the input value must be a configured MMTSType. In this case, a data type definition will be created and used for typing this column.

Throws:

InoNetException

SrvErrorException

setDerivedTypingTSOrDTType

void setDerivedTypingTSOrDTType(ADClientAble value)
                         throws InoNetException,
SrvErrorException

Set the value of View DerivedTypingTSOrDTType.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

merge

void merge(List<? extends IMStructuralFeature> seq)
    throws InoNetException,
SrvErrorException

This method merges several properties of the same concrete class ERAttribute or DBTableColumn.
The modified property keeps all information about this input property. e.g. name, stereotype, specifications, labels ...
Some information about the merged properties given by the input sequence will be added:
- Dependencies (this property is source or target) - key features, if this property is not yet part of the same key. - key features, if this property is not yet part of the same index. - For table columns: assignments to instances, if this column is not yet assigned to the same instance.
The added properties will be deleted at the end.

Parameters:

seq -

Throws:

InoNetException

SrvErrorException

setDataTypeByString

void setDataTypeByString(String item)
                  throws InoNetException,
SrvErrorException

Sets the data type of this property by a string. This command accepts types with ARRAY, STRUCT and MAP. If there are more than one known type systems, each inner datatype defintion starts with the name of the type system followed by two colons.

Parameters:

item -

Throws:

InoNetException

SrvErrorException

setDataTypeDefinitionByString

void setDataTypeDefinitionByString(String item)
                            throws InoNetException,
SrvErrorException

Sets the technical type of this property by a string with concrete parameters. If there are more than one known type systems the string starts with the name of the type system followed by two colons.

Parameters:

item -

Throws:

InoNetException

SrvErrorException

setNull

void setNull(boolean setNull)
      throws InoNetException,
SrvErrorException

Sets the DBTableColumn respectively ERAttribute to null or not null.

Parameters:

setNull -

Throws:

InoNetException

SrvErrorException

split

List<IMProperty> split()
                throws InoNetException,
SrvErrorException

This method splits an IMProperty, (ERAttribute or DBTableColumn) to several features.
If more than one IMKeyRelationshipFeature of this feature exists, one of these remains at this feature. For all others, a new feature will be created by copying this feature and reconnecting the key relationship feature.

Throws:

InoNetException

SrvErrorException

typeMapping

void typeMapping()
          throws InoNetException,
SrvErrorException

If the property is typed by an IMDataTypeDefinition, this command will create data type definitions (if missing) or modify existing data type definitions (if they are not marked as user implementation) according to the type mappings in the configuration.

Throws:

InoNetException

SrvErrorException

getOwnedTypeDefinition

List<IMDataTypeDefinition> getOwnedTypeDefinition(K_CONTROL_OPTION... behaviourFlags)
                                           throws InoNetException,
SrvErrorException

List of type definitions of this property which is an entity attribute or a database table column.

Parameters:

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

Throws:

InoNetException

SrvErrorException

Sorted:

the result may be sorted.

getTypingDataType

IMDataType getTypingDataType()
                      throws InoNetException,
SrvErrorException

The data type that types this property.

Throws:

InoNetException

SrvErrorException

getTypingDataTypeDefinition

IMDataTypeDefinition getTypingDataTypeDefinition()
                                          throws InoNetException,
SrvErrorException

The data type definition that types this property.

Throws:

InoNetException

SrvErrorException

getTypingSemanticDataType

IMSemanticDataType getTypingSemanticDataType()
                                      throws InoNetException,
SrvErrorException

The semantic data type that types this property.

Throws:

InoNetException

SrvErrorException