org.eclipse.uml2
Interface CollaborationOccurrence

All Superinterfaces:
Element, EModelElement, EObject, NamedElement, Notifier, TemplateableElement

public interface CollaborationOccurrence
extends NamedElement

A representation of the model object 'Collaboration Occurrence'. A collaboration occurrence represents one particular use of a collaboration to explain the relationships between the properties of a classifier. A collaboration occurrence indicates a set of roles and connectors that cooperate within the classifier according to a given collaboration, indicated by the type of the collaboration occurrence. There may be multiple occurrences of a given collaboration within a classifier, each involving a different set of roles and connectors. A given role or connector may be involved in multiple occurrences of the same or different collaborations. Associated dependencies map features of the collaboration type to features in the classifier. These dependencies indicate which role in the classifier plays which role in the collaboration.

The following features are supported:

See Also:
UML2Package.getCollaborationOccurrence()

Field Summary
static String copyright
           
 
Fields inherited from interface org.eclipse.uml2.NamedElement
SEPARATOR
 
Method Summary
 Dependency createRoleBinding(EClass eClass)
          Creates a Dependency and appends it to the 'Role Binding' containment reference list
 EList getOwnedElements()
           
 Dependency getRoleBinding(String unqualifiedName)
          Retrieves the Dependency with the specified name from the 'Role Binding' containment reference list
 EList getRoleBindings()
          Returns the value of the 'Role Binding' containment reference list.
 Collaboration getType()
          Returns the value of the 'Type' reference
 void setType(Collaboration value)
          Sets the value of the 'Type' reference
 
Methods inherited from interface org.eclipse.uml2.NamedElement
allNamespaces, createNameExpression, getClientDependencies, getClientDependency, getName, getNameExpression, getNamespace, getOwner, getQualifiedName, getVisibility, isDistinguishableFrom, qualifiedName, separator, setName, setNameExpression, setVisibility, validateNoName, validateQualifiedName, validateVisibilityNeedsOwnership
 
Methods inherited from interface org.eclipse.uml2.TemplateableElement
createOwnedTemplateSignature, createTemplateBinding, getOwnedTemplateSignature, getTemplateBindings, parameterableElements, setOwnedTemplateSignature
 
Methods inherited from interface org.eclipse.uml2.Element
addKeyword, allOwnedElements, apply, createEAnnotation, createOwnedComment, destroy, getApplicableStereotype, getApplicableStereotypes, getAppliedStereotype, getAppliedStereotypes, getAppliedVersion, getKeywords, getModel, getNearestPackage, getOwnedComments, getValue, hasKeyword, isApplied, isRequired, mustBeOwned, removeKeyword, setValue, unapply, validateHasOwner, validateNotOwnSelf
 
Methods inherited from interface org.eclipse.emf.ecore.EModelElement
getEAnnotation, getEAnnotations
 
Methods inherited from interface org.eclipse.emf.ecore.EObject
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset
 
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
 

Field Detail

copyright

public static final String copyright

See Also:
Constant Field Values
Method Detail

getType

public Collaboration getType()
Returns the value of the 'Type' reference.

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

The collaboration which is used in this occurrence. The collaboration defines the cooperation between its roles which are mapped to properties of the classifier owning the collaboration occurrence.

Returns:
the value of the 'Type' reference.
See Also:
setType(Collaboration), UML2Package.getCollaborationOccurrence_Type()

setType

public void setType(Collaboration value)
Sets the value of the 'Type' reference.

Parameters:
value - the new value of the 'Type' reference.
See Also:
getType()

getRoleBindings

public EList getRoleBindings()
Returns the value of the 'Role Binding' containment reference list. The list contents are of type Dependency.

If the meaning of the 'Role Binding' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Role Binding' containment reference list.
See Also:
UML2Package.getCollaborationOccurrence_RoleBinding()

getRoleBinding

public Dependency getRoleBinding(String unqualifiedName)
Retrieves the Dependency with the specified name from the 'Role Binding' containment reference list.

Parameters:
unqualifiedName - The unqualified name of the Dependency to retrieve.
Returns:
The Dependency with the specified name, or null.
See Also:
getRoleBindings()

createRoleBinding

public Dependency createRoleBinding(EClass eClass)
Creates a Dependency and appends it to the 'Role Binding' containment reference list.

Parameters:
eClass - The Ecore class of the Dependency to create.
Returns:
The new Dependency.
See Also:
getRoleBindings()

getOwnedElements

public EList getOwnedElements()

Specified by:
getOwnedElements in interface NamedElement

Copyright 2003, 2004 IBM Corporation and others.
All Rights Reserved.