Interface ERRelationship
- All Superinterfaces:
ADAccessAble, ADClientAble, ADFindAble, ADHistoryAble, ADLockAble, ADM2AttrModifyAble, ADOptionAble, ADReferenceAble, ADVersionAble, ELAssociation, ELClassifier, ELContainerAble, ELContAsgnAble, ELDeleteAble, ELElement, ELNamedElement, ELNamespaceAble, ELNamespaceAsgnAble, ELObject, ELPackageAble, ELRedefAble, ELShortNameAble, ELType, ELUUIDAble, ELValueContainerAble, IMAssociation, IMClassifier, MECommentAble, MEConstraintAble, MEModelElement, MENamedElement, MENamespaceAsgnAble, MEPackageAble, MEStereotypeAble, METermAble, MMAttachmentAble, MMCommentContainerAble, MMLabelAble, MMLabelTextAttachmentAble, MMStereotypeAble, MMTextAble
- All Known Subinterfaces:
BIHierarchyRole
A
ERRelationship connects two entities via ERRole roles.
The meaning of an relationships strongly depends on the cardinality of it roles.- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionList of all entities of thisERRelationship.Returns theEREntityat the foreign key side of thisERRelationship.Returns theEREntityat the left side of anERRelationshipwhich conforms to SERM.Returns theEREntityat the right side of anERRelationshipwhich conforms to SERM.Returns theEREntityat the unique key side of thisERRelationship.Gets theERForeignKeyimplementing thisERRelationship.Gets the foreign key attributes implementing thisERRelationship.getForeignKeyAttributes(MMStereotype stereotype) The method calls getForeignKeyAttributes and filters its return values according to the given stereotype value.This enumeration value indicates how many instances of the child entity can reference the same instance of the parent entity.
Setting this value to explicit will set the cardinality to (2,5)! For other values use the setter methods 'Min' and 'Max' of the parent entityERRole.This enumeration value indicates if an instance of the child entity must or can have a relationship to an instance of the parent entity.getOwnedRole(K_CONTROL_OPTION... behaviourFlags) List of roles owned by this relationship.getRole()All roles that are assigned to this relationship.Returns theERRoleat the foreign key side of thisERRelationship.Returns theERRoleat the left side of anERRelationshipwhich conforms to SERM.Returns theERRoleat the right side of anERRelationshipwhich conforms to SERM.Returns theERRoleat the unique key side of thisERRelationship.Gets theERUniqueKeyreferenced by thisERRelationship.Gets the attributes referenced by thisERRelationship.getUniqueKeyAttributes(MMStereotype stereotype) The method calls getUniqueKeyAttributes and filters its return values according to the given stereotype value.booleanTrue: the semantics of the name reads from the foreign key entity to the primary key entity.booleanIf true, the referencing entity of the relationship is a weak entity.booleanisMaxOne()True, if theERRoleon the unique key side has a cardinality with maximum one, e.g.booleanisMinOne()True, if theERRoleon the unique key side has a cardinality with minimum one or greater, e.g.booleanTrue, if thisERRelationshipis optional.
This is true if theERRoleon the foreign key side has a cardinality with minimum of zero, e.g.booleanIf true, this relationship conforms to SERM.maintain()voidRuns the R type maintaining method for the connected entities of thisERRelationship.Runs the maintaining methods for all roles of thisERRelationship.voidsetHowMany(K_RS_HOWMANY value) Set the value of Info HowMany.voidsetInverseReadDirection(boolean value) Set the value of Attribut HasInverseReadDirection.voidsetMustOrCan(K_RS_MUST_CAN value) Set the value of Info MustOrCan.voidsetWeakEntity(boolean value) Set the value of Attribut HasWeakEntity.Not yet implemented!
ThisERRelationshipwill be transformed to a hierarchicalERGeneralization.
The relationship must be hierarchical with cardinalities (0,1) and (1,1).Precondition: thisERRelationshipmust not be implemented by anERForeignKey!
ThisERRelationshipwill be transformed to an R typeEREntity.
Note: given specifications, labels, stereotype properties and dependencies will be lost!Methods inherited from interface ADAccessAble
getAccessRole, getReadRole, hasAccess, setAccessRole, setReadRoleMethods inherited from interface ADClientAble
getAnnotation, getEndAnalysisDia, getLogic, getLogic, getPresentationContext, getSection, getStartAnalysisDiaMethods inherited from interface ADHistoryAble
getCreateTime, getCreator, getHistory, getModifier, getModifyTime, modifyHistory, setHistoryMethods inherited from interface ADLockAble
getLock, getLockableCache, getLockLogin, getLockName, hasClutch, hasLock, hasNoLock, hasOthLock, hasOwnLock, isLockable, lock, unlockMethods inherited from interface ADM2AttrModifyAble
getTabCell, getTabCellObjectList, getTabCreateTemplate, getTabCreateTemplateObjectList, getTabElement, getTabElementRelshipTypeList, getTabElementRowList, getTabElementRowTypeList, getTabRelshipList, getTabRowList, tabCellModify, tabCreateTemplate, tabElementModifyMethods inherited from interface ADOptionAble
getOwnedOption, modifyOptionDlgMethods inherited from interface ADReferenceAble
getReferenceContainer, setReferenceContainerMethods inherited from interface ADVersionAble
getVersionFile, getVersionList, getVersionListWithoutOpenInfoMethods inherited from interface ELAssociation
getAggregationEnd, getAssociationEnd, getAssociationEnd, getAssociationEndsOfEndType, getAssociationEndsOfEndType, getClassifierOfAssociationEnd, getClassifierOfAssociationEnd, getOwnedAssociationEnd, getOwnedAssociationEnd, getProperty, getPropertyNotAssociationEnd, getPropertyNotAssociationEnd, getSortedAssociationEnds, reconnectAssociationMethods inherited from interface ELClassifier
getAssociation, getAssociation, getAssociationEndFirstTypedBySelf, getAssociationEndFirstTypedBySelf, getAssociationEndNavigableTypedBySelf, getAssociationEndNavigableTypedBySelf, getAssociationEndNavigableTypedBySelfOrGeneralTransitive, getAssociationEndNavigableTypedBySelfOrGeneralTransitive, getAssociationEndTypedBySelf, getAssociationEndTypedBySelf, getAssociationEndTypedBySelfOrGeneralTransitive, getAssociationEndTypedBySelfOrGeneralTransitive, getAssociationNavigableFrom, getAssociationNavigableFrom, getAssociationOfSelfOrGeneralTransitive, getAssociationOfSelfOrGeneralTransitive, getAssociationTypedBySelf, getAssociationTypedBySelf, getClassifierViewGroup, getEffectiveRedefinerOfAssocEnd, getEffectiveRedefinerOfAssocEnd, getEffectiveSubsetterOfAssocEnd, getEffectiveSubsetterOfAssocEnd, getGeneralDirect, getGeneralDirect, getGeneralGeneralizationSet, getGeneralGeneralizationSet, getGeneralization, getGeneralTransitive, getGeneralTransitive, getOwnedAndInheritedMember, getOwnedAndInheritedMember, getPropertyNavigableFrom, getPropertyNavigableFrom, getPropertyNavigableFromSelfOrGeneralTransitive, getPropertyNavigableFromSelfOrGeneralTransitive, getSelfAndGeneralTransitive, getSelfAndGeneralTransitive, getSelfAndSpecificTransitive, getSelfAndSpecificTransitive, getSelfAndSpecificTransitiveNotAbstract, getSelfAndSpecificTransitiveNotAbstract, getSpecialization, getSpecificDirect, getSpecificDirect, getSpecificGeneralization, getSpecificGeneralizationSet, getSpecificGeneralizationSet, getSpecificTransitive, getSpecificTransitive, getSpecificTransitiveNotAbstract, getSpecificTransitiveNotAbstract, getSpecificTransitiveNotAbstractRange, getSpecificTransitiveNotAbstractRange, getSpecificTransitiveNotAbstractTypesOfEffectiveSubsetterOfAssocEnd, getSpecificTransitiveNotAbstractTypesOfEffectiveSubsetterOfAssocEnd, getSpecificTransitiveNotAbstractTypesOfEffectiveSubsetterOfAssocEndIntersectedByInverseAssocEnd, getSpecificTransitiveNotAbstractTypesOfEffectiveSubsetterOfAssocEndIntersectedByInverseAssocEnd, getTypedCLStructureEntry, getTypedMaskField, getTypesOfEffectiveSubsetterOfAssocEnd, getTypesOfEffectiveSubsetterOfAssocEnd, getViewTransitive, getViewTransitive, isAbstract, isRoot, isSpecificTransitive, setAbstractMethods inherited from interface ELContainerAble
getClientDependency, getOwnedElement, getOwnedElementTransitiveDown, getOwnedElementTransitiveDown, getOwnedElementTransitiveDownAndUnresolved, getOwnedElementTransitiveDownAndUnresolved, getOwnedOrReferencedElementTransitiveDown, getOwnedOrReferencedElementTransitiveDown, getOwnedRelshipBinDirWithTarget, getOwnedRelshipBinDirWithTarget, getRedirectedModelContainer, getRelshipBinDirSource, getSelfAndOwnedElementTransitiveDown, getSelfAndOwnedElementTransitiveDown, getSortedContents, sortContentsMethods inherited from interface ELContAsgnAble
getAsgnKind, getContSortOrder, getFirstOwnerWhichIsConformTo, getOwner, getOwnerTransitive, getOwnerTransitive, getSelfAndOwnerTransitive, getSelfAndOwnerTransitive, getVersionRoot, isTransitiveChildOf, setAsgnKind, setContSortOrder, setOwnerMethods inherited from interface ELDeleteAble
deleteMethods inherited from interface 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, unlockUnitMethods inherited from interface ELNamedElement
getName, getNameKind, getQualifiedDisplayName, getQualifiedName, getQualifiedTLName, getSupplierDependency, rename, setName, setNameKindMethods inherited from interface ELNamespaceAble
getElementImport, getImportedElement, getImportedElement, getImportedPackage, getImportedPackage, getItemDefinition, getMember, getMember, getMemberByPattern, getMemberByPattern, getOwnedConstraint, getOwnedMember, getOwnedMemberByPath, getOwnedMemberByPattern, getOwnedMemberByPattern, getOwnedMemberTransitiveByPattern, getOwnedMemberTransitiveByPattern, getOwnedMemberTransitiveByPatternIgnoreCase, getOwnedMemberTransitiveByPatternIgnoreCase, getPackageImportMethods inherited from interface ELNamespaceAsgnAble
getMnClassicTREFName, getNamespace, getNamespaceName, getPath, getSeparator, getVisibility, setUniqueName, setVisibilityMethods inherited from interface ELObject
getId, getLongId, getMetaClass, getMetaName, getOclClass, getSrvCon, hasReadMethods inherited from interface ELPackageAble
getElementImportingNamespace, getElementImportingNamespace, getImportedPackageAble, getOwningPackageMethods inherited from interface ELRedefAble
getRedefined, getRedefining, isLeaf, isRedefined, isRedefining, setLeaf, setRedefinedMethods inherited from interface ELShortNameAble
getShortName, getShortNameKind, setShortName, setShortNameKind, setUniqueShortNameMethods inherited from interface ELType
getRaisingAsException, getTypedElement, getTypedElementNotAssocEnd, getTypedElementNotAssocEnd, isTypeReuseableMethods inherited from interface ELUUIDAble
getHyperlinkReferenceAble, getInnoRef, getNotToTranslateAttribute, getTranslatedValue, getUUID, setUUIDMethods inherited from interface ELValueContainerAble
getValueReUseAble, setValueReUseAbleMethods inherited from interface IMClassifier
getAllAssignedConstraint, getAllAssignedConstraint, getDirectlyCheckConstraintAssign, getForeignKeyReferencingOwnedUniqueKey, getForeignKeyReferencingOwnedUniqueKey, getImplementation, getOwnedFeature, getOwnedGeneralizationSet, getOwnedIMConstraint, getOwnedIMTrigger, getOwnedKey, getOwnedProperty, getPrimaryKey, getUniqueKeyReferencedByDefault, setImplementationMethods inherited from interface MECommentAble
getAssignedComment, getAssignedComment, getCommentAssignMethods inherited from interface MEConstraintAble
getAssignedConstraint, getAssignedConstraint, getConstraintAssignMethods inherited from interface MEModelElement
buildProxyConnection, getActivityPartition, getConsider, getContentStereotypeByClass, getCreateTemplateByClass, getDataModel, getDataModelName, getElementColor, getFirstValidContentStereotype, getIgnore, getKnownTypeSystems, getMEModelName, getModelElement, getModelElement, getPresContext, getPresContext, getPresetMapping, getPRPresContent, setElementColorMethods inherited from interface MENamedElement
getMappingSourceElement, getMappingSourceElement, getMESupplierDependency, getMESupplierMappingDependencyMethods inherited from interface MENamespaceAsgnAble
getSignatureMessageMethods inherited from interface MEPackageAble
getComponent, getManifestMethods inherited from interface MEStereotypeAble
getClientMappingDependency, getDecisionMade, getDecisionOwned, getKnowledgeSourceOfOwner, getMappingTargetElement, getMappingTargetElement, getMEClientDependency, getProxyAsgProperty, getRepresentingArtifact, getRequirementOfStakeholder, getRequirementOfStakeholderOwner, isMapped, setMapped, setRequirementOfStakeholderMethods inherited from interface METermAble
getTerm, setTermMethods inherited from interface MMAttachmentAble
getAssignedAttachment, getAttachmentAssign, getDefaultAttachment, getOwnedAttachment, setDefaultAttachmentMethods inherited from interface MMCommentContainerAble
getOutgoingConceptRealization, getOwnedComment, getRealizedConcept, getRealizedConcept, replaceRealizedConcepts, setRealizedConceptMethods inherited from interface MMLabelAble
getLabel, getLabelBoolValue, getLabelColor, getLabelInfo, getLabelLongValue, getLabelNameValue, getLabelStringValue, getLabelValueByPattern, getLabelValueByPattern, getLabelValueList, getOwnedLabelValSpec, hasLabel, modifyLabelValuesByName, setLabelInfoMethods inherited from interface MMStereotypeAble
assignStereotypeDlg, cloneElement, completelySynchronizeOthers, completelySynchronizeThis, getAttrCnstrEffective, getCreateTemplate, getDisplayType, getExtendingStereotype, getExtendingStereotypeNames, 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, setExtendingStereotype, setStereotype, setStereotypePropertyInfo, setStereotypeTSOptionInfo, setSyncedStereotypeAble
-
Method Details
-
hasWeakEntity
If true, the referencing entity of the relationship is a weak entity. A hierarchical relationship models a weak entity.- Throws:
InoNetExceptionSrvErrorException
-
setWeakEntity
Set the value of Attribut HasWeakEntity.- Parameters:
value- The value to be set.- Throws:
InoNetExceptionSrvErrorException
-
hasInverseReadDirection
True: the semantics of the name reads from the foreign key entity to the primary key entity.- Throws:
InoNetExceptionSrvErrorException
-
setInverseReadDirection
Set the value of Attribut HasInverseReadDirection.- Parameters:
value- The value to be set.- Throws:
InoNetExceptionSrvErrorException
-
isSERMConform
If true, this relationship conforms to SERM. A relationship which conforms to SERM has got exactly oneERRolewith cardinality (1,1), so that it leads to a not null foreign key.- Throws:
InoNetExceptionSrvErrorException
-
isOptional
True, if thisERRelationshipis optional.
This is true if theERRoleon the foreign key side has a cardinality with minimum of zero, e.g. (0,1).- Throws:
InoNetExceptionSrvErrorException
-
isMaxOne
True, if theERRoleon the unique key side has a cardinality with maximum one, e.g. (0,1).- Throws:
InoNetExceptionSrvErrorException
-
isMinOne
True, if theERRoleon the unique key side has a cardinality with minimum one or greater, e.g. (1,*).- Throws:
InoNetExceptionSrvErrorException
-
getHowMany
This enumeration value indicates how many instances of the child entity can reference the same instance of the parent entity.
Setting this value to explicit will set the cardinality to (2,5)! For other values use the setter methods 'Min' and 'Max' of the parent entityERRole.- Throws:
InoNetExceptionSrvErrorException
-
setHowMany
Set the value of Info HowMany.- Parameters:
value- The value to be set.- Throws:
InoNetExceptionSrvErrorException
-
getMustOrCan
This enumeration value indicates if an instance of the child entity must or can have a relationship to an instance of the parent entity.- Throws:
InoNetExceptionSrvErrorException
-
setMustOrCan
Set the value of Info MustOrCan.- Parameters:
value- The value to be set.- Throws:
InoNetExceptionSrvErrorException
-
getEntitySERMLeft
Returns theEREntityat the left side of anERRelationshipwhich conforms to SERM.- Throws:
InoNetExceptionSrvErrorException
-
getEntitySERMRight
Returns theEREntityat the right side of anERRelationshipwhich conforms to SERM.- Throws:
InoNetExceptionSrvErrorException
-
getRoleSERMLeft
Returns theERRoleat the left side of anERRelationshipwhich conforms to SERM.- Throws:
InoNetExceptionSrvErrorException
-
getRoleSERMRight
Returns theERRoleat the right side of anERRelationshipwhich conforms to SERM.- Throws:
InoNetExceptionSrvErrorException
-
getEntityUniqueKey
Returns theEREntityat the unique key side of thisERRelationship.- Throws:
InoNetExceptionSrvErrorException
-
getEntityForeignKey
Returns theEREntityat the foreign key side of thisERRelationship.- Throws:
InoNetExceptionSrvErrorException
-
getRoleUniqueKey
Returns theERRoleat the unique key side of thisERRelationship.- Throws:
InoNetExceptionSrvErrorException
-
getRoleForeignKey
Returns theERRoleat the foreign key side of thisERRelationship.- Throws:
InoNetExceptionSrvErrorException
-
getUniqueKey
Gets theERUniqueKeyreferenced by thisERRelationship.- Throws:
InoNetExceptionSrvErrorException
-
getForeignKey
Gets theERForeignKeyimplementing thisERRelationship.- Throws:
InoNetExceptionSrvErrorException
-
getUniqueKeyAttributes
Gets the attributes referenced by thisERRelationship.- Throws:
InoNetExceptionSrvErrorException
-
getUniqueKeyAttributes
List<ERAttribute> getUniqueKeyAttributes(MMStereotype stereotype) throws InoNetException, SrvErrorException The method calls getUniqueKeyAttributes and filters its return values according to the given stereotype value.- Parameters:
stereotype- The stereotype used to filter the result list- Throws:
InoNetExceptionSrvErrorException
-
getForeignKeyAttributes
Gets the foreign key attributes implementing thisERRelationship.- Throws:
InoNetExceptionSrvErrorException
-
getForeignKeyAttributes
List<ERAttribute> getForeignKeyAttributes(MMStereotype stereotype) throws InoNetException, SrvErrorException The method calls getForeignKeyAttributes and filters its return values according to the given stereotype value.- Parameters:
stereotype- The stereotype used to filter the result list- Throws:
InoNetExceptionSrvErrorException
-
maintain
- Throws:
InoNetExceptionSrvErrorException
-
maintainIsRType
Runs the R type maintaining method for the connected entities of thisERRelationship.- Throws:
InoNetExceptionSrvErrorException
-
maintainRoles
Runs the maintaining methods for all roles of thisERRelationship.- Throws:
InoNetExceptionSrvErrorException
-
transformToGeneralization
Not yet implemented!
ThisERRelationshipwill be transformed to a hierarchicalERGeneralization.
The relationship must be hierarchical with cardinalities (0,1) and (1,1).- Throws:
InoNetExceptionSrvErrorException
-
transformToRType
Precondition: thisERRelationshipmust not be implemented by anERForeignKey!
ThisERRelationshipwill be transformed to an R typeEREntity.
Note: given specifications, labels, stereotype properties and dependencies will be lost!- Throws:
InoNetExceptionSrvErrorException
-
getEntity
List of all entities of thisERRelationship.- Throws:
InoNetExceptionSrvErrorException
-
getOwnedRole
List<ERRole> getOwnedRole(K_CONTROL_OPTION... behaviourFlags) throws InoNetException, SrvErrorException List of roles owned by this relationship. Do not confuse this view with the view to the list of all roles.- Parameters:
behaviourFlags- An optional list of enum values to control the behaviour of the command.- Throws:
InoNetExceptionSrvErrorException- Sorted:
- the result may be sorted.
-
getRole
All roles that are assigned to this relationship.- Throws:
InoNetExceptionSrvErrorException
-