org.eclipse.uml2
Interface BehavioralFeature

All Superinterfaces:
Element, EModelElement, EObject, Feature, NamedElement, Namespace, Notifier, RedefinableElement, TemplateableElement
All Known Subinterfaces:
Operation, Reception

public interface BehavioralFeature
extends Namespace, Feature

A representation of the model object 'Behavioral Feature'. A behavioral feature specifies that an instance of a classifier will respond to a designated request by invoking a behavior. BehavioralFeature is an abstract metaclass specializing Feature and Namespace. Kinds of behavioral aspects are modeled by subclasses of BehavioralFeature.

The following features are supported:

See Also:
UML2Package.getBehavioralFeature()

Field Summary
static String copyright
           
 
Fields inherited from interface org.eclipse.uml2.NamedElement
SEPARATOR
 
Method Summary
 Parameter createFormalParameter(EClass eClass)
          Creates a Parameter and appends it to the 'Formal Parameter' containment reference list
 Parameter createReturnResult(EClass eClass)
          Creates a Parameter and appends it to the 'Return Result' containment reference list
 CallConcurrencyKind getConcurrency()
          Returns the value of the 'Concurrency' attribute.
 Parameter getFormalParameter(String unqualifiedName)
          Retrieves the Parameter with the specified name from the 'Formal Parameter' containment reference list
 EList getFormalParameters()
          Returns the value of the 'Formal Parameter' containment reference list.
 EList getMembers()
           
 Behavior getMethod(String unqualifiedName)
          Retrieves the Behavior with the specified name from the 'Method' reference list
 EList getMethods()
          Returns the value of the 'Method' reference list.
 EList getOwnedMembers()
           
 Parameter getParameter(String unqualifiedName)
          Retrieves the Parameter with the specified name from the 'Parameter' reference list
 EList getParameters()
          Returns the value of the 'Parameter' reference list.
 Type getRaisedException(String unqualifiedName)
          Retrieves the Type with the specified name from the 'Raised Exception' reference list
 EList getRaisedExceptions()
          Returns the value of the 'Raised Exception' reference list.
 Parameter getReturnResult(String unqualifiedName)
          Retrieves the Parameter with the specified name from the 'Return Result' containment reference list
 EList getReturnResults()
          Returns the value of the 'Return Result' containment reference list.
 boolean isAbstract()
          Returns the value of the 'Is Abstract' attribute
 boolean isDistinguishableFrom(NamedElement n, Namespace ns)
           A query based on the following OCL expression: if n.oclIsKindOf(BehavioralFeature) then if ns.getNamesOfMember(self)->intersection(ns.getNamesOfMember(n))->notEmpty() then Set{}->include(self)->include(n)->isUnique( bf | bf.parameter->collect(type)) else true endif else true endif
 void setConcurrency(CallConcurrencyKind value)
          Sets the value of the 'Concurrency' attribute
 void setIsAbstract(boolean value)
          Sets the value of the 'Is Abstract' attribute
 
Methods inherited from interface org.eclipse.uml2.Namespace
createElementImport, createOwnedRule, createPackageImport, excludeCollisions, getElementImports, getImportedMember, getImportedMembers, getImportedPackages, getMember, getNamesOfMember, getOwnedElements, getOwnedRule, getOwnedRules, getPackageImports, importedMember, importElement, importMembers, importPackage, membersAreDistinguishable, validateImportedMemberDerived, validateMembersAreDistinguishable
 
Methods inherited from interface org.eclipse.uml2.NamedElement
allNamespaces, createNameExpression, getClientDependencies, getClientDependency, getName, getNameExpression, getNamespace, getOwner, getQualifiedName, getVisibility, 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.Feature
getFeaturingClassifier, getFeaturingClassifiers, isStatic, setIsStatic
 
Methods inherited from interface org.eclipse.uml2.RedefinableElement
getRedefinedElements, getRedefinitionContext, getRedefinitionContexts, isConsistentWith, isLeaf, isRedefinitionContextValid, setIsLeaf, validateRedefinitionConsistent, validateRedefinitionContextValid
 

Field Detail

copyright

public static final String copyright

See Also:
Constant Field Values
Method Detail

isAbstract

public boolean isAbstract()
Returns the value of the 'Is Abstract' attribute.

If the meaning of the 'Is Abstract' attribute isn't clear, there really should be more of a description here...

If true, then the behavioral feature does not have an implementation, and one must be supplied by a more specific element. If false, the behavioral feature must have an implementation in the classifier or one must be inherited from a more general element. Communications

Returns:
the value of the 'Is Abstract' attribute.
See Also:
setIsAbstract(boolean), UML2Package.getBehavioralFeature_IsAbstract()

setIsAbstract

public void setIsAbstract(boolean value)
Sets the value of the 'Is Abstract' attribute.

Parameters:
value - the new value of the 'Is Abstract' attribute.
See Also:
isAbstract()

getConcurrency

public CallConcurrencyKind getConcurrency()
Returns the value of the 'Concurrency' attribute. The literals are from the enumeration CallConcurrencyKind.

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

Returns:
the value of the 'Concurrency' attribute.
See Also:
CallConcurrencyKind, setConcurrency(CallConcurrencyKind), UML2Package.getBehavioralFeature_Concurrency()

setConcurrency

public void setConcurrency(CallConcurrencyKind value)
Sets the value of the 'Concurrency' attribute.

Parameters:
value - the new value of the 'Concurrency' attribute.
See Also:
CallConcurrencyKind, getConcurrency()

getParameters

public EList getParameters()
Returns the value of the 'Parameter' reference list. The list contents are of type Parameter.

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

Specifies the parameters of the BehavioralFeature. Subsets Namespace::member. This is a derived union and is ordered.

Returns:
the value of the 'Parameter' reference list.
See Also:
UML2Package.getBehavioralFeature_Parameter()

getParameter

public Parameter getParameter(String unqualifiedName)
Retrieves the Parameter with the specified name from the 'Parameter' reference list.

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

getFormalParameters

public EList getFormalParameters()
Returns the value of the 'Formal Parameter' containment reference list. The list contents are of type Parameter.

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

Specifies the ordered set of formal parameters of this BehavioralFeature. Subsets BehavioralFeature::parameter and Namespace::ownedMember.

Returns:
the value of the 'Formal Parameter' containment reference list.
See Also:
UML2Package.getBehavioralFeature_FormalParameter()

getFormalParameter

public Parameter getFormalParameter(String unqualifiedName)
Retrieves the Parameter with the specified name from the 'Formal Parameter' containment reference list.

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

createFormalParameter

public Parameter createFormalParameter(EClass eClass)
Creates a Parameter and appends it to the 'Formal Parameter' containment reference list.

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

getReturnResults

public EList getReturnResults()
Returns the value of the 'Return Result' containment reference list. The list contents are of type Parameter.

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

Specifies the ordered set of return results of this BehavioralFeature. Subsets Behavioral- Feature::parameter and Namespace::ownedMember.

Returns:
the value of the 'Return Result' containment reference list.
See Also:
UML2Package.getBehavioralFeature_ReturnResult()

getReturnResult

public Parameter getReturnResult(String unqualifiedName)
Retrieves the Parameter with the specified name from the 'Return Result' containment reference list.

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

createReturnResult

public Parameter createReturnResult(EClass eClass)
Creates a Parameter and appends it to the 'Return Result' containment reference list.

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

getRaisedExceptions

public EList getRaisedExceptions()
Returns the value of the 'Raised Exception' reference list. The list contents are of type Type.

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

References the Types representing exceptions that may be raised during an invocation of this operation.

Returns:
the value of the 'Raised Exception' reference list.
See Also:
UML2Package.getBehavioralFeature_RaisedException()

getRaisedException

public Type getRaisedException(String unqualifiedName)
Retrieves the Type with the specified name from the 'Raised Exception' reference list.

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

getMethods

public EList getMethods()
Returns the value of the 'Method' reference list. The list contents are of type Behavior. It is bidirectional and its opposite is 'Specification'.

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

A behavioral description that implements the behavioral feature. There may be at most one behavior for a particular pairing of a classifier (as owner of the behavior) and a behavioral feature (as specification of the behavior).

Returns:
the value of the 'Method' reference list.
See Also:
UML2Package.getBehavioralFeature_Method(), Behavior.getSpecification()

getMethod

public Behavior getMethod(String unqualifiedName)
Retrieves the Behavior with the specified name from the 'Method' reference list.

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

isDistinguishableFrom

public boolean isDistinguishableFrom(NamedElement n,
                                     Namespace ns)
A query based on the following OCL expression: if n.oclIsKindOf(BehavioralFeature) then if ns.getNamesOfMember(self)->intersection(ns.getNamesOfMember(n))->notEmpty() then Set{}->include(self)->include(n)->isUnique( bf | bf.parameter->collect(type)) else true endif else true endif

Specified by:
isDistinguishableFrom in interface NamedElement

getMembers

public EList getMembers()

Specified by:
getMembers in interface Namespace
Returns:
the value of the 'Member' reference list.
See Also:
UML2Package.getNamespace_Member()

getOwnedMembers

public EList getOwnedMembers()

Specified by:
getOwnedMembers in interface Namespace

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