org.eclipse.uml2
Interface Collaboration

All Superinterfaces:
BehavioredClassifier, Classifier, Element, EModelElement, EObject, NamedElement, Namespace, Notifier, PackageableElement, ParameterableElement, RedefinableElement, StructuredClassifier, TemplateableElement, Type

public interface Collaboration
extends BehavioredClassifier, StructuredClassifier

A representation of the model object 'Collaboration'. A collaboration is represented as a kind of classifier and defines a set of cooperating entities to be played by instances (its roles), as well as a set of connectors that define communication paths between the participating instances. The cooperating entities are the properties of the collaboration. A collaboration specifies a view (or projection) of a set of cooperating classifiers. It describes the required links between instances that play the roles of the collaboration, as well as the features required of the classifiers that specify the participating instances. Several collaborations may describe different projections of the same set of classifiers.

The following features are supported:

See Also:
UML2Package.getCollaboration()

Field Summary
static String copyright
           
 
Fields inherited from interface org.eclipse.uml2.NamedElement
SEPARATOR
 
Method Summary
 ConnectableElement getCollaborationRole(String unqualifiedName)
          Retrieves the ConnectableElement with the specified name from the 'Collaboration Role' reference list
 EList getCollaborationRoles()
          Returns the value of the 'Collaboration Role' reference list.
 EList getRoles()
           
 
Methods inherited from interface org.eclipse.uml2.BehavioredClassifier
createImplementation, createOwnedBehavior, createOwnedStateMachine, createOwnedTrigger, getClassifierBehavior, getClientDependencies, getImplementation, getImplementations, getImplementedInterfaces, getOwnedBehavior, getOwnedBehaviors, getOwnedElements, getOwnedMembers, getOwnedStateMachine, getOwnedStateMachines, getOwnedTrigger, getOwnedTriggers, setClassifierBehavior
 
Methods inherited from interface org.eclipse.uml2.Classifier
allFeatures, allParents, conformsTo, createGeneralization, createGeneralization, createOccurrence, createOwnedUseCase, createSubstitution, general, getAttribute, getAttributes, getFeature, getFeatures, getGeneral, getGeneralizations, getGenerals, getInheritedMember, getInheritedMembers, getMembers, getOccurrence, getOccurrences, getOwnedUseCase, getOwnedUseCases, getPowertypeExtent, getPowertypeExtents, getRedefinedClassifier, getRedefinedClassifiers, getRedefinedElements, getRepresentation, getSubstitution, getSubstitutions, getUseCase, getUseCases, getUsedInterfaces, hasVisibilityOf, inherit, inheritableMembers, inheritedMember, isAbstract, maySpecializeType, parents, setIsAbstract, setRepresentation, validateGeneralEqualsParents, validateInheritedMember, validateNoCyclesInGeneralization, validateSpecializeType
 
Methods inherited from interface org.eclipse.uml2.Namespace
createElementImport, createOwnedRule, createPackageImport, excludeCollisions, getElementImports, getImportedMember, getImportedMembers, getImportedPackages, getMember, getNamesOfMember, getOwnedRule, getOwnedRules, getPackageImports, importedMember, importElement, importMembers, importPackage, membersAreDistinguishable, validateImportedMemberDerived, validateMembersAreDistinguishable
 
Methods inherited from interface org.eclipse.uml2.NamedElement
allNamespaces, createNameExpression, 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
 
Methods inherited from interface org.eclipse.uml2.Type
conformsTo, createAssociation, getNamespace, getPackage
 
Methods inherited from interface org.eclipse.uml2.PackageableElement
getPackageableElement_visibility, getVisibility, setPackageableElement_visibility, setVisibility
 
Methods inherited from interface org.eclipse.uml2.ParameterableElement
getOwner, getOwningParameter, getTemplateParameter, setOwningParameter, setTemplateParameter
 
Methods inherited from interface org.eclipse.uml2.RedefinableElement
getRedefinitionContext, getRedefinitionContexts, isConsistentWith, isLeaf, isRedefinitionContextValid, setIsLeaf, validateRedefinitionConsistent, validateRedefinitionContextValid
 
Methods inherited from interface org.eclipse.uml2.StructuredClassifier
createOwnedAttribute, createOwnedConnector, getAttributes, getFeatures, getMembers, getOwnedAttribute, getOwnedAttributes, getOwnedConnector, getOwnedConnectors, getOwnedMembers, getPart, getParts, getRole
 

Field Detail

copyright

public static final String copyright

See Also:
Constant Field Values
Method Detail

getCollaborationRoles

public EList getCollaborationRoles()
Returns the value of the 'Collaboration Role' reference list. The list contents are of type ConnectableElement.

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

Returns:
the value of the 'Collaboration Role' reference list.
See Also:
UML2Package.getCollaboration_CollaborationRole()

getCollaborationRole

public ConnectableElement getCollaborationRole(String unqualifiedName)
Retrieves the ConnectableElement with the specified name from the 'Collaboration Role' reference list.

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

getRoles

public EList getRoles()

Specified by:
getRoles in interface StructuredClassifier
Returns:
the value of the 'Role' reference list.
See Also:
UML2Package.getStructuredClassifier_Role()

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