|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Operation
A representation of the model object 'Operation'. An Operation is a BehavioralFeature of a Classifier that specifies the name, type, parameters, and constraints for invoking an associated Behavior. An Operation may invoke both the execution of method behaviors as well as other behavioral responses. Operation specializes TemplateableElement in order to support specification of template operations and bound operations. Operation specializes ParameterableElement to specify that an operation can be exposed as a formal template parameter, and provided as an actual parameter in a binding of a template.
From package UML::Classification.
The following features are supported:
Body Condition
Class
Datatype
Interface
Is Ordered
Is Query
Is Unique
Lower
Postcondition
Precondition
Redefined Operation
Type
Upper
UMLPackage.getOperation()
Field Summary |
---|
Fields inherited from interface org.eclipse.uml2.uml.NamedElement |
---|
SEPARATOR |
Method Summary | |
---|---|
Constraint |
createBodyCondition(java.lang.String name)
Creates a new Constraint ,with the specified 'Name', and sets the 'Body Condition' reference |
Constraint |
createBodyCondition(java.lang.String name,
org.eclipse.emf.ecore.EClass eClass)
Creates a new Constraint , with the specified 'Name', and sets the 'Body Condition' reference |
Constraint |
createPostcondition(java.lang.String name)
Creates a new Constraint , with the specified 'Name', and appends it to the 'Postcondition' reference list |
Constraint |
createPostcondition(java.lang.String name,
org.eclipse.emf.ecore.EClass eClass)
Creates a new Constraint , with the specified 'Name', and appends it to the 'Postcondition' reference list |
Constraint |
createPrecondition(java.lang.String name)
Creates a new Constraint , with the specified 'Name', and appends it to the 'Precondition' reference list |
Constraint |
createPrecondition(java.lang.String name,
org.eclipse.emf.ecore.EClass eClass)
Creates a new Constraint , with the specified 'Name', and appends it to the 'Precondition' reference list |
Constraint |
getBodyCondition()
Returns the value of the 'Body Condition' reference. |
Class |
getClass_()
Returns the value of the 'Class' container reference. |
DataType |
getDatatype()
Returns the value of the 'Datatype' container reference. |
Interface |
getInterface()
Returns the value of the 'Interface' container reference. |
int |
getLower()
Returns the value of the 'Lower' attribute. |
Constraint |
getPostcondition(java.lang.String name)
Retrieves the first Constraint with the specified 'Name' from the 'Postcondition' reference list |
Constraint |
getPostcondition(java.lang.String name,
boolean ignoreCase,
org.eclipse.emf.ecore.EClass eClass,
boolean createOnDemand)
Retrieves the first Constraint with the specified 'Name' from the 'Postcondition' reference list |
org.eclipse.emf.common.util.EList<Constraint> |
getPostconditions()
Returns the value of the 'Postcondition' reference list. |
Constraint |
getPrecondition(java.lang.String name)
Retrieves the first Constraint with the specified 'Name' from the 'Precondition' reference list |
Constraint |
getPrecondition(java.lang.String name,
boolean ignoreCase,
org.eclipse.emf.ecore.EClass eClass,
boolean createOnDemand)
Retrieves the first Constraint with the specified 'Name' from the 'Precondition' reference list |
org.eclipse.emf.common.util.EList<Constraint> |
getPreconditions()
Returns the value of the 'Precondition' reference list. |
Operation |
getRedefinedOperation(java.lang.String name,
org.eclipse.emf.common.util.EList<java.lang.String> ownedParameterNames,
org.eclipse.emf.common.util.EList<Type> ownedParameterTypes)
Retrieves the first Operation with the specified 'Name', 'Owned Parameter Names', and 'Owned Parameter Types' from the 'Redefined Operation' reference list |
Operation |
getRedefinedOperation(java.lang.String name,
org.eclipse.emf.common.util.EList<java.lang.String> ownedParameterNames,
org.eclipse.emf.common.util.EList<Type> ownedParameterTypes,
boolean ignoreCase)
Retrieves the first Operation with the specified 'Name', 'Owned Parameter Names', and 'Owned Parameter Types' from the 'Redefined Operation' reference list |
org.eclipse.emf.common.util.EList<Operation> |
getRedefinedOperations()
Returns the value of the 'Redefined Operation' reference list. |
Parameter |
getReturnResult()
Retrieves the (only) return result parameter for this operation |
Type |
getType()
Returns the value of the 'Type' reference |
int |
getUpper()
Returns the value of the 'Upper' attribute. |
boolean |
isOrdered()
Returns the value of the 'Is Ordered' attribute |
boolean |
isQuery()
Returns the value of the 'Is Query' attribute. |
boolean |
isUnique()
Returns the value of the 'Is Unique' attribute. |
org.eclipse.emf.common.util.EList<Parameter> |
returnResult()
The query returnResult() returns the set containing the return parameter of the Operation if one exists, otherwise, it returns an empty set result = (ownedParameter->select (direction = ParameterDirectionKind::return)->asSet()) From package UML::Classification. |
void |
setBodyCondition(Constraint value)
Sets the value of the ' Body Condition ' reference |
void |
setClass_(Class value)
Sets the value of the ' Class ' container reference |
void |
setDatatype(DataType value)
Sets the value of the ' Datatype ' container reference |
void |
setInterface(Interface value)
Sets the value of the ' Interface ' container reference |
void |
setIsOrdered(boolean newIsOrdered)
|
void |
setIsQuery(boolean value)
Sets the value of the ' Is Query ' attribute |
void |
setIsUnique(boolean newIsUnique)
|
void |
setLower(int newLower)
|
void |
setType(Type newType)
|
void |
setUpper(int newUpper)
|
boolean |
validateAtMostOneReturn(org.eclipse.emf.common.util.DiagnosticChain diagnostics,
java.util.Map<java.lang.Object,java.lang.Object> context)
An Operation can have at most one return parameter; i.e., an owned parameter with the direction set to 'return.' |
boolean |
validateOnlyBodyForQuery(org.eclipse.emf.common.util.DiagnosticChain diagnostics,
java.util.Map<java.lang.Object,java.lang.Object> context)
A bodyCondition can only be specified for a query Operation. |
Methods inherited from interface org.eclipse.uml2.uml.BehavioralFeature |
---|
createOwnedParameter, createOwnedParameterSet, createReturnResult, getConcurrency, getMethod, getMethod, getMethods, getOwnedParameter, getOwnedParameter, getOwnedParameters, getOwnedParameterSet, getOwnedParameterSet, getOwnedParameterSets, getRaisedException, getRaisedException, getRaisedExceptions, inputParameters, isAbstract, outputParameters, setConcurrency, setIsAbstract, validateAbstractNoMethod |
Methods inherited from interface org.eclipse.uml2.uml.Feature |
---|
getFeaturingClassifier, getFeaturingClassifier, getFeaturingClassifiers, isStatic, setIsStatic |
Methods inherited from interface org.eclipse.uml2.uml.RedefinableElement |
---|
getRedefinedElement, getRedefinedElement, getRedefinedElements, getRedefinitionContext, getRedefinitionContext, getRedefinitionContexts, isConsistentWith, isLeaf, isRedefinitionContextValid, setIsLeaf, validateNonLeafRedefinition, validateRedefinitionConsistent, validateRedefinitionContextValid |
Methods inherited from interface org.eclipse.uml2.uml.NamedElement |
---|
allNamespaces, allOwningPackages, createDependency, createNameExpression, createUsage, getClientDependencies, getClientDependency, getClientDependency, getLabel, getLabel, getName, getNameExpression, getNamespace, getQualifiedName, getVisibility, isDistinguishableFrom, isSetName, isSetVisibility, separator, setName, setNameExpression, setVisibility, unsetName, unsetVisibility, validateHasNoQualifiedName, validateHasQualifiedName, validateVisibilityNeedsOwnership |
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, eInvoke, 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.uml.ParameterableElement |
---|
getOwningTemplateParameter, getTemplateParameter, isCompatibleWith, isTemplateParameter, setOwningTemplateParameter, setTemplateParameter |
Methods inherited from interface org.eclipse.uml2.uml.TemplateableElement |
---|
createOwnedTemplateSignature, createOwnedTemplateSignature, createTemplateBinding, getOwnedTemplateSignature, getTemplateBinding, getTemplateBinding, getTemplateBindings, isTemplate, parameterableElements, setOwnedTemplateSignature |
Method Detail |
---|
boolean isQuery()
"false"
.
Specifies whether an execution of the BehavioralFeature leaves the state of the system unchanged (isQuery=true) or whether side effects may occur (isQuery=false).
From package UML::Classification.
setIsQuery(boolean)
,
UMLPackage.getOperation_IsQuery()
void setIsQuery(boolean value)
Is Query
' attribute.
value
- the new value of the 'Is Query' attribute.isQuery()
boolean isOrdered()
From package UML::Classification.
UMLPackage.getOperation_IsOrdered()
boolean isUnique()
"true"
.
Specifies whether the return parameter is unique or not, if present. This information is derived from the return result for this Operation.
From package UML::Classification.
UMLPackage.getOperation_IsUnique()
int getLower()
"1"
.
Specifies the lower multiplicity of the return parameter, if present. This information is derived from the return result for this Operation.
From package UML::Classification.
UMLPackage.getOperation_Lower()
int getUpper()
"1"
.
The upper multiplicity of the return parameter, if present. This information is derived from the return result for this Operation.
From package UML::Classification.
UMLPackage.getOperation_Upper()
Class getClass_()
Owned Operation
'.
This feature subsets the following features:
The Class that owns this operation, if any.From package UML::Classification.
setClass_(org.eclipse.uml2.uml.Class)
,
UMLPackage.getOperation_Class()
,
Class.getOwnedOperations()
void setClass_(Class value)
Class
' container reference.
value
- the new value of the 'Class' container reference.getClass_()
org.eclipse.emf.common.util.EList<Constraint> getPreconditions()
Constraint
.
This feature subsets the following features:
An optional set of Constraints on the state of the system when the Operation is invoked.From package UML::Classification.
UMLPackage.getOperation_Precondition()
Constraint createPrecondition(java.lang.String name, org.eclipse.emf.ecore.EClass eClass)
Constraint
, with the specified 'Name', and appends it to the 'Precondition' reference list.
name
- The 'Name' for the new Constraint
, or null
.eClass
- The Ecore class of the Constraint
to create.
Constraint
.getPreconditions()
Constraint createPrecondition(java.lang.String name)
Constraint
, with the specified 'Name', and appends it to the 'Precondition' reference list.
name
- The 'Name' for the new Constraint
, or null
.
Constraint
.getPreconditions()
Constraint getPrecondition(java.lang.String name)
Constraint
with the specified 'Name' from the 'Precondition' reference list.
name
- The 'Name' of the Constraint
to retrieve, or null
.
Constraint
with the specified 'Name', or null
.getPreconditions()
Constraint getPrecondition(java.lang.String name, boolean ignoreCase, org.eclipse.emf.ecore.EClass eClass, boolean createOnDemand)
Constraint
with the specified 'Name' from the 'Precondition' reference list.
name
- The 'Name' of the Constraint
to retrieve, or null
.ignoreCase
- Whether to ignore case in String
comparisons.eClass
- The Ecore class of the Constraint
to retrieve, or null
.createOnDemand
- Whether to create a Constraint
on demand if not found.
Constraint
with the specified 'Name', or null
.getPreconditions()
org.eclipse.emf.common.util.EList<Constraint> getPostconditions()
Constraint
.
This feature subsets the following features:
An optional set of Constraints specifying the state of the system when the Operation is completed.From package UML::Classification.
UMLPackage.getOperation_Postcondition()
Constraint createPostcondition(java.lang.String name, org.eclipse.emf.ecore.EClass eClass)
Constraint
, with the specified 'Name', and appends it to the 'Postcondition' reference list.
name
- The 'Name' for the new Constraint
, or null
.eClass
- The Ecore class of the Constraint
to create.
Constraint
.getPostconditions()
Constraint createPostcondition(java.lang.String name)
Constraint
, with the specified 'Name', and appends it to the 'Postcondition' reference list.
name
- The 'Name' for the new Constraint
, or null
.
Constraint
.getPostconditions()
Constraint getPostcondition(java.lang.String name)
Constraint
with the specified 'Name' from the 'Postcondition' reference list.
name
- The 'Name' of the Constraint
to retrieve, or null
.
Constraint
with the specified 'Name', or null
.getPostconditions()
Constraint getPostcondition(java.lang.String name, boolean ignoreCase, org.eclipse.emf.ecore.EClass eClass, boolean createOnDemand)
Constraint
with the specified 'Name' from the 'Postcondition' reference list.
name
- The 'Name' of the Constraint
to retrieve, or null
.ignoreCase
- Whether to ignore case in String
comparisons.eClass
- The Ecore class of the Constraint
to retrieve, or null
.createOnDemand
- Whether to create a Constraint
on demand if not found.
Constraint
with the specified 'Name', or null
.getPostconditions()
org.eclipse.emf.common.util.EList<Operation> getRedefinedOperations()
Operation
.
This feature subsets the following features:
The Operations that are redefined by this Operation.From package UML::Classification.
UMLPackage.getOperation_RedefinedOperation()
Operation getRedefinedOperation(java.lang.String name, org.eclipse.emf.common.util.EList<java.lang.String> ownedParameterNames, org.eclipse.emf.common.util.EList<Type> ownedParameterTypes)
Operation
with the specified 'Name', 'Owned Parameter Names', and 'Owned Parameter Types' from the 'Redefined Operation' reference list.
name
- The 'Name' of the Operation
to retrieve, or null
.ownedParameterNames
- The 'Owned Parameter Names' of the Operation
to retrieve, or null
.ownedParameterTypes
- The 'Owned Parameter Types' of the Operation
to retrieve, or null
.
Operation
with the specified 'Name', 'Owned Parameter Names', and 'Owned Parameter Types', or null
.getRedefinedOperations()
Operation getRedefinedOperation(java.lang.String name, org.eclipse.emf.common.util.EList<java.lang.String> ownedParameterNames, org.eclipse.emf.common.util.EList<Type> ownedParameterTypes, boolean ignoreCase)
Operation
with the specified 'Name', 'Owned Parameter Names', and 'Owned Parameter Types' from the 'Redefined Operation' reference list.
name
- The 'Name' of the Operation
to retrieve, or null
.ownedParameterNames
- The 'Owned Parameter Names' of the Operation
to retrieve, or null
.ownedParameterTypes
- The 'Owned Parameter Types' of the Operation
to retrieve, or null
.ignoreCase
- Whether to ignore case in String
comparisons.
Operation
with the specified 'Name', 'Owned Parameter Names', and 'Owned Parameter Types', or null
.getRedefinedOperations()
DataType getDatatype()
Owned Operation
'.
This feature subsets the following features:
The DataType that owns this Operation, if any.From package UML::Classification.
setDatatype(DataType)
,
UMLPackage.getOperation_Datatype()
,
DataType.getOwnedOperations()
void setDatatype(DataType value)
Datatype
' container reference.
value
- the new value of the 'Datatype' container reference.getDatatype()
Constraint getBodyCondition()
This feature subsets the following features:
An optional Constraint on the result values of an invocation of this Operation.From package UML::Classification.
setBodyCondition(Constraint)
,
UMLPackage.getOperation_BodyCondition()
void setBodyCondition(Constraint value)
Body Condition
' reference.
value
- the new value of the 'Body Condition' reference.getBodyCondition()
Constraint createBodyCondition(java.lang.String name, org.eclipse.emf.ecore.EClass eClass)
Constraint
, with the specified 'Name', and sets the 'Body Condition' reference.
name
- The 'Name' for the new Constraint
, or null
.eClass
- The Ecore class of the Constraint
to create.
Constraint
.getBodyCondition()
Constraint createBodyCondition(java.lang.String name)
Constraint
,with the specified 'Name', and sets the 'Body Condition' reference.
name
- The 'Name' for the new Constraint
, or null
.
Constraint
.getBodyCondition()
Type getType()
From package UML::Classification.
UMLPackage.getOperation_Type()
Interface getInterface()
Owned Operation
'.
This feature subsets the following features:
The Interface that owns this Operation, if any.From package UML::Classification.
setInterface(Interface)
,
UMLPackage.getOperation_Interface()
,
Interface.getOwnedOperations()
void setInterface(Interface value)
Interface
' container reference.
value
- the new value of the 'Interface' container reference.getInterface()
boolean validateAtMostOneReturn(org.eclipse.emf.common.util.DiagnosticChain diagnostics, java.util.Map<java.lang.Object,java.lang.Object> context)
diagnostics
- The chain of diagnostics to which problems are to be appended.context
- The cache of context-specific information.
boolean validateOnlyBodyForQuery(org.eclipse.emf.common.util.DiagnosticChain diagnostics, java.util.Map<java.lang.Object,java.lang.Object> context)
diagnostics
- The chain of diagnostics to which problems are to be appended.context
- The cache of context-specific information.
Parameter getReturnResult()
void setIsOrdered(boolean newIsOrdered)
void setIsUnique(boolean newIsUnique)
void setLower(int newLower)
void setType(Type newType)
void setUpper(int newUpper)
org.eclipse.emf.common.util.EList<Parameter> returnResult()
From package UML::Classification.
|
Copyright 2003, 2014 IBM Corporation, CEA, and others. All Rights Reserved. |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |