Package de.mid.innovator.srv2api.icw2er

Interface ERRole

All Superinterfaces:

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

public interface ERRole
extends ELProperty, IMStructuralFeature, IMForeignKeyAble

A ERRole is a part of a ERRelationship which connects the relationship to an EREntity. The (min,max) cardinaltiy of this role defines how often an instance of the connected entity can take part at the relationship.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	ERRole.VAttr

Method Summary

Modifier and Type	Method	Description
EREntity	getConnectedEntity()	The entity connected by this role.
String	getMax()	Maximum cardinality of this ERRole.
String	getMaxUML()	Maximum cardinality of this ERRole for UML notation.
String	getMin()	The minimum number how often the connected entity must participate in the relationship.
String	getMinMaxString()	Gets a string with the cardinality in Chen notation - (Min,Max).
String	getMinMaxStringUML()	Gets a string with the cardinality in UML notation using the minimum and maximum of the partner role.
String	getMinUML()	Minimum cardinality of this ERRole for UML notation.
String	getNameUML()	Role name of this ERRole for UML notation.
MMCreateCLInst	getOwningCreateCLInst()	Template dummy instance needed as owner substitute for EREntity.
EREntity	getOwningEntity()	Reference to the entity that owns the role.
ERRelationship	getOwningRelationship()	Reference to the relationship that owns the role.
ERRole	getPartnerRole()	Gets the partner role of this role (the opposite role of the relationship.
ERRelationship	getRelationship()	The relationship this role is assigned to.
boolean	isForeignKeyCandidate()	If true, the ERRole can be set to be on the foreign key side. A role is a foreign key candidate if the upper value is 1, unless the partner role does not have a (1,1) cardinality.
boolean	isForeignKeySide()	If true, the ERRole is on the foreign key side of its ERRelationship.
boolean	isUniqueKeySide()	If true, the ERRole is on the unique key side of its ERRelationship.
List<MEStereotypeAble>	maintain()	Runs all maintaining methods for this ERRole in the following order: maintainCreateForeignKey(...)
ERForeignKey	maintainForeignKey()	This maintaining method creates the missed ERForeignKey for this ERRole. Returns the newly-created foreign key or null.
void	setConnectedEntity(EREntity value)	Set the value of Foreign Key ConnectedEntity.
void	setForeignKeySide(boolean value)	Set the value of Info IsForeignKeySide.
void	setForeignKeySideAndMaintain(boolean value)	Set the value of Info IsForeignKeySide.
void	setMax(String value)	Set the value of Info Max.
void	setMaxAndMaintain(String value)	Set the value of Info Max.
void	setMaxUML(String value)	Set the value of Info MaxUML.
void	setMaxUMLAndMaintain(String value)	Set the value of Info MaxUML.
void	setMin(String value)	Set the value of Info Min.
void	setMinAndMaintain(String value)	Set the value of Info Min.
void	setMinMax(String Min, String Max, boolean Maintain)	Sets the role cardinality to (min,max).
void	setMinUML(String value)	Set the value of Info MinUML.
void	setMinUMLAndMaintain(String value)	Set the value of Info MinUML.
void	setNameUML(String value)	Set the value of Info NameUML.

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

getCubeDimension, getDimensionPrecedence, getForeignKey, isHierarchical, isNotNull

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

isForeignKeyCandidate

boolean isForeignKeyCandidate()
                       throws InoNetException,
SrvErrorException

If true, the ERRole can be set to be on the foreign key side.
A role is a foreign key candidate if the upper value is 1, unless the partner role does not have a (1,1) cardinality.

Throws:

InoNetException

SrvErrorException

isForeignKeySide

boolean isForeignKeySide()
                  throws InoNetException,
SrvErrorException

If true, the ERRole is on the foreign key side of its ERRelationship.

Throws:

InoNetException

SrvErrorException

setForeignKeySide

void setForeignKeySide(boolean value)
                throws InoNetException,
SrvErrorException

Set the value of Info IsForeignKeySide.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

setForeignKeySideAndMaintain

void setForeignKeySideAndMaintain(boolean value)
                           throws InoNetException,
SrvErrorException

Set the value of Info IsForeignKeySide.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

isUniqueKeySide

boolean isUniqueKeySide()
                 throws InoNetException,
SrvErrorException

If true, the ERRole is on the unique key side of its ERRelationship.

Throws:

InoNetException

SrvErrorException

getMin

String getMin()
       throws InoNetException,
SrvErrorException

The minimum number how often the connected entity must participate in the relationship.

Throws:

InoNetException

SrvErrorException

setMin

void setMin(String value)
     throws InoNetException,
SrvErrorException

Set the value of Info Min.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

setMinAndMaintain

void setMinAndMaintain(String value)
                throws InoNetException,
SrvErrorException

Set the value of Info Min.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getMax

String getMax()
       throws InoNetException,
SrvErrorException

Maximum cardinality of this ERRole. This is equal to the 'upper' attribute of its super class ELMultiplicityAble.
The maintaining variant of the setter will eventually set one role of the ERRelationship to be on the foreign key side. This depends on the cardinality of both roles. In this case, the foreign key and the foreign key attributes will be created automatically.
The property dialog of an Innovator Client uses the maintaining variant.
Note: 'Min' and 'Max' of the role define how often an instance of the entity can take part to its relationship. P.e. the (1,1) cardinality leads to an foreign key in the connected EREntity.

Throws:

InoNetException

SrvErrorException

setMax

void setMax(String value)
     throws InoNetException,
SrvErrorException

Set the value of Info Max.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

setMaxAndMaintain

void setMaxAndMaintain(String value)
                throws InoNetException,
SrvErrorException

Set the value of Info Max.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getMinMaxString

String getMinMaxString()
                throws InoNetException,
SrvErrorException

Gets a string with the cardinality in Chen notation - (Min,Max).

Throws:

InoNetException

SrvErrorException

getMinUML

String getMinUML()
          throws InoNetException,
SrvErrorException

Minimum cardinality of this ERRole for UML notation. Sets the minimum of the partner role which is the logical location for this property in the ER context!
The maintaining variant of the setter will eventually set one role of the ERRelationship to be on the foreign key side. This depends on the cardinality of both roles. In this case, the foreign key and the foreign key attributes will be created.
The property dialog of an Innovator Client uses the maintaining variant.

Throws:

InoNetException

SrvErrorException

setMinUML

void setMinUML(String value)
        throws InoNetException,
SrvErrorException

Set the value of Info MinUML.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

setMinUMLAndMaintain

void setMinUMLAndMaintain(String value)
                   throws InoNetException,
SrvErrorException

Set the value of Info MinUML.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getMaxUML

String getMaxUML()
          throws InoNetException,
SrvErrorException

Maximum cardinality of this ERRole for UML notation. Sets the maximum of the partner role which is the logical location for this property in the ER context!
The maintaining variant of the setter will eventually set one role of the ERRelationship to be on the foreign key side. This depends on the cardinality of both roles. In this case, the foreign key and the foreign key attributes will be created automatically.
The property dialog of an Innovator Client uses the maintaining variant.
Note: 'Min' and 'Max' of the role define how often an instance of the connected entity can be in a relationship with an instance of the partner entity. E.g. the (1,1) cardinality leads to an foreign key in the connected EREntity.

Throws:

InoNetException

SrvErrorException

setMaxUML

void setMaxUML(String value)
        throws InoNetException,
SrvErrorException

Set the value of Info MaxUML.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

setMaxUMLAndMaintain

void setMaxUMLAndMaintain(String value)
                   throws InoNetException,
SrvErrorException

Set the value of Info MaxUML.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getMinMaxStringUML

String getMinMaxStringUML()
                   throws InoNetException,
SrvErrorException

Gets a string with the cardinality in UML notation using the minimum and maximum of the partner role.

Throws:

InoNetException

SrvErrorException

getNameUML

String getNameUML()
           throws InoNetException,
SrvErrorException

Role name of this ERRole for UML notation. This is the name of the partner role which is the logical location for this property in the ER context!

Throws:

InoNetException

SrvErrorException

setNameUML

void setNameUML(String value)
         throws InoNetException,
SrvErrorException

Set the value of Info NameUML.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

maintain

List<MEStereotypeAble> maintain()
                         throws InoNetException,
SrvErrorException

Runs all maintaining methods for this ERRole in the following order:
maintainCreateForeignKey(...)

Throws:

InoNetException

SrvErrorException

maintainForeignKey

ERForeignKey maintainForeignKey()
                         throws InoNetException,
SrvErrorException

This maintaining method creates the missed ERForeignKey for this ERRole.
Returns the newly-created foreign key or null.

Throws:

InoNetException

SrvErrorException

setMinMax

void setMinMax(String Min,
 String Max,
 boolean Maintain)
        throws InoNetException,
SrvErrorException

Sets the role cardinality to (min,max).

Parameters:

Min - Minimum value

Max - Maximum value

Maintain - if true, call MaintainCmd at the end

Throws:

InoNetException

SrvErrorException

getPartnerRole

ERRole getPartnerRole()
               throws InoNetException,
SrvErrorException

Gets the partner role of this role (the opposite role of the relationship. Generic view of 'opposite association end' in class property.

Throws:

InoNetException

SrvErrorException

getConnectedEntity

EREntity getConnectedEntity()
                     throws InoNetException,
SrvErrorException

The entity connected by this role.

Throws:

InoNetException

SrvErrorException

setConnectedEntity

void setConnectedEntity(EREntity value)
                 throws InoNetException,
SrvErrorException

Set the value of Foreign Key ConnectedEntity.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getOwningCreateCLInst

MMCreateCLInst getOwningCreateCLInst()
                              throws InoNetException,
SrvErrorException

Template dummy instance needed as owner substitute for EREntity.

Throws:

InoNetException

SrvErrorException

getOwningEntity

EREntity getOwningEntity()
                  throws InoNetException,
SrvErrorException

Reference to the entity that owns the role. The reference may be empty if the role is owned by the relationship. If the role is owned by an entity, this entity is at the referencing side (foreign key) of the relationship.

Throws:

InoNetException

SrvErrorException

getOwningRelationship

ERRelationship getOwningRelationship()
                              throws InoNetException,
SrvErrorException

Reference to the relationship that owns the role. The reference may be empty if the role is owned by an entity.

Throws:

InoNetException

SrvErrorException

getRelationship

ERRelationship getRelationship()
                        throws InoNetException,
SrvErrorException

The relationship this role is assigned to.

Throws:

InoNetException

SrvErrorException