com.nomagic.uml2.ext.magicdraw.compositestructures.mdcollaborations

Interface CollaborationUse

All Superinterfaces:

BaseElement, java.lang.Cloneable, java.lang.Comparable, Element, org.eclipse.emf.ecore.EObject, MDObject, ModelObject, NamedElement, org.eclipse.emf.common.notify.Notifier, javax.jmi.reflect.RefBaseObject, javax.jmi.reflect.RefFeatured, javax.jmi.reflect.RefObject

public interface CollaborationUse
extends NamedElement

A representation of the model object 'Collaboration Use'.

A CollaborationUse is used to specify the application of a pattern specified by a Collaboration to a specific situation.

The following features are supported:

• Type
• classifier Of Representation
• classifier Of Collaboration Use
• Role Binding

See Also:

UMLPackage.getCollaborationUse()

Method Summary

Modifier and Type	Method and Description
Classifier	get_classifierOfCollaborationUse() Returns the value of the 'classifier Of Collaboration Use' container reference.
Classifier	get_classifierOfRepresentation() Returns the value of the 'classifier Of Representation' reference.
java.util.Collection<Dependency>	getRoleBinding() Returns the value of the 'Role Binding' containment reference list.
Collaboration	getType() Returns the value of the 'Type' reference.
boolean	hasRoleBinding()
void	set_classifierOfCollaborationUse(Classifier value) Sets the value of the 'classifier Of Collaboration Use' container reference.
void	set_classifierOfRepresentation(Classifier value) Sets the value of the 'classifier Of Representation' reference.
void	setType(Collaboration value) Sets the value of the 'Type' reference.

Methods inherited from interface com.nomagic.uml2.ext.magicdraw.classes.mdkernel.NamedElement

get_considerIgnoreFragmentOfMessage, get_durationObservationOfEvent, get_informationFlowOfInformationSource, get_informationFlowOfInformationTarget, get_messageOfSignature, get_namespaceOfMember, get_timeObservationOfEvent, getClientDependency, getName, getNameExpression, getNamespace, getQualifiedName, getSupplierDependency, getVisibility, has_considerIgnoreFragmentOfMessage, has_durationObservationOfEvent, has_informationFlowOfInformationSource, has_informationFlowOfInformationTarget, has_messageOfSignature, has_namespaceOfMember, has_timeObservationOfEvent, hasClientDependency, hasSupplierDependency, setName, setNameExpression, setNamespace, setVisibility

Methods inherited from interface com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element

get_activityPartitionOfRepresents, get_commentOfAnnotatedElement, get_constraintOfConstrainedElement, get_diagramOfContext, get_directedRelationshipOfSource, get_directedRelationshipOfTarget, get_elementOfSyncElement, get_elementValueOfElement, get_relationshipOfRelatedElement, getAppliedStereotypeInstance, getOwnedComment, getOwnedElement, getOwner, getSyncElement, has_activityPartitionOfRepresents, has_commentOfAnnotatedElement, has_constraintOfConstrainedElement, has_diagramOfContext, has_directedRelationshipOfSource, has_directedRelationshipOfTarget, has_elementOfSyncElement, has_elementValueOfElement, has_relationshipOfRelatedElement, hasOwnedComment, hasOwnedElement, setAppliedStereotypeInstance, setOwner, setSyncElement

Methods inherited from interface com.nomagic.uml2.ext.magicdraw.base.ModelObject

get_representationText, getLocalID, isInvalid, set_representationText, setLocalID, sGetLocalID

Methods inherited from interface com.nomagic.magicdraw.foundation.MDObject

getID, getMDExtension, getMdExtensions, setID

Methods inherited from interface org.eclipse.emf.ecore.EObject

eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eInvoke, eIsProxy, eIsSet, eResource, eSet, eUnset

Methods inherited from interface org.eclipse.emf.common.notify.Notifier

eAdapters, eDeliver, eNotify, eSetDeliver

Methods inherited from interface com.nomagic.magicdraw.uml.BaseElement

accept, addPropertyChangeListener, canAdd, canAdd, canAddChild, canBeDeleted, firePropertyChange, getClassType, getHumanName, getHumanType, getObjectParent, isEditable, removePropertyChangeListener, sGetID

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface javax.jmi.reflect.RefObject

refClass, refDelete, refImmediateComposite, refIsInstanceOf, refOutermostComposite

Methods inherited from interface javax.jmi.reflect.RefFeatured

refGetValue, refGetValue, refInvokeOperation, refInvokeOperation, refSetValue, refSetValue

Methods inherited from interface javax.jmi.reflect.RefBaseObject

equals, hashCode, refImmediatePackage, refMetaObject, refMofId, refOutermostPackage, refVerifyConstraints

Method Detail

getRoleBinding

java.util.Collection<Dependency> getRoleBinding()

Returns the value of the 'Role Binding' containment reference list. The list contents are of type Dependency. It is bidirectional and its opposite is 'collaboration Use Of Role Binding'. A mapping between features of the Collaboration and features of the owning Classifier. This mapping indicates which ConnectableElement of the Classifier plays which role(s) in the Collaboration. A ConnectableElement may be bound to multiple roles in the same CollaborationUse (that is, it may play multiple roles).

Returns:

the value of the 'Role Binding' containment reference list.

See Also:

UMLPackage.getCollaborationUse_RoleBinding(), Dependency.get_collaborationUseOfRoleBinding()

get_classifierOfCollaborationUse

@CheckForNull
Classifier get_classifierOfCollaborationUse()

Returns the value of the 'classifier Of Collaboration Use' container reference. It is bidirectional and its opposite is 'Collaboration Use'.

If the meaning of the 'classifier Of Collaboration Use' container reference isn't clear, there really should be more of a description here...

Returns:

the value of the 'classifier Of Collaboration Use' container reference.

See Also:

set_classifierOfCollaborationUse(Classifier), UMLPackage.getCollaborationUse__classifierOfCollaborationUse(), Classifier.getCollaborationUse()

set_classifierOfCollaborationUse

void set_classifierOfCollaborationUse(@CheckForNull
                                      Classifier value)

Sets the value of the 'classifier Of Collaboration Use' container reference.

Parameters:

value - the new value of the 'classifier Of Collaboration Use' container reference.

See Also:

get_classifierOfCollaborationUse()

get_classifierOfRepresentation

@CheckForNull
Classifier get_classifierOfRepresentation()

Returns the value of the 'classifier Of Representation' reference. It is bidirectional and its opposite is 'Representation'.

If the meaning of the 'classifier Of Representation' reference isn't clear, there really should be more of a description here...

Returns:

the value of the 'classifier Of Representation' reference.

See Also:

set_classifierOfRepresentation(Classifier), UMLPackage.getCollaborationUse__classifierOfRepresentation(), Classifier.getRepresentation()

set_classifierOfRepresentation

void set_classifierOfRepresentation(@CheckForNull
                                    Classifier value)

Sets the value of the 'classifier Of Representation' reference.

Parameters:

value - the new value of the 'classifier Of Representation' reference.

See Also:

get_classifierOfRepresentation()

getType

@CheckForNull
Collaboration getType()

Returns the value of the 'Type' reference. It is bidirectional and its opposite is 'collaboration Use Of Type'. The Collaboration which is used in this CollaborationUse. The Collaboration defines the cooperation between its roles which are mapped to ConnectableElements relating to the Classifier owning the CollaborationUse.

Returns:

the value of the 'Type' reference.

See Also:

setType(Collaboration), UMLPackage.getCollaborationUse_Type(), Collaboration.get_collaborationUseOfType()

setType

void setType(@CheckForNull
             Collaboration value)

Sets the value of the 'Type' reference.

Parameters:

value - the new value of the 'Type' reference.

See Also:

getType()

hasRoleBinding

boolean hasRoleBinding()
                throws javax.jmi.reflect.JmiException

Throws:

javax.jmi.reflect.JmiException