org.eclipse.ocl.pivot

Interface Operation

All Superinterfaces:

Element, org.eclipse.emf.ecore.EObject, Feature, Nameable, NamedElement, Namespace, org.eclipse.emf.common.notify.Notifier, TemplateableElement, TypedElement, Visitable

All Known Subinterfaces:

Iteration

All Known Implementing Classes:

AbstractExecutorOperation, ExecutorOperation, IterationImpl, OperationImpl

public interface Operation
extends Feature, Namespace, TemplateableElement

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.

The following features are supported:

• Body Expression
• Is Invalidating
• Is Typeof
• Is Validating
• Owned Parameters
• Owned Postconditions
• Owned Preconditions
• Owning Class
• Precedence
• Raised Exceptions
• Redefined Operations

See Also:

PivotPackage.getOperation()

Generated

Method Summary

Modifier and Type	Method and Description
LanguageExpression	getBodyExpression() Returns the value of the 'Body Expression' containment reference.
int	getIndex() Return the index of this operation in the operation dispatch table.
CompleteInheritance	getInheritance(StandardLibrary standardLibrary) Return the Inheritance dispatch table for the owning type, or null for am orphan property owned by an Annotation.
OperationId	getOperationId()
java.util.List<Parameter>	getOwnedParameters() Returns the value of the 'Owned Parameters' containment reference list.
java.util.List<Constraint>	getOwnedPostconditions() Returns the value of the 'Owned Postconditions' containment reference list.
java.util.List<Constraint>	getOwnedPreconditions() Returns the value of the 'Owned Preconditions' containment reference list.
Class	getOwningClass() Returns the value of the 'Owning Class' container reference.
ParametersId	getParametersId() Return the unique identity of the ordered list of parameters of this operation.
ParameterTypes	getParameterTypes() Return the ordered list of parameters of this operation.
Precedence	getPrecedence() Returns the value of the 'Precedence' reference.
java.util.List<Type>	getRaisedExceptions() Returns the value of the 'Raised Exceptions' reference list.
java.util.List<Operation>	getRedefinedOperations() Returns the value of the 'Redefined Operations' reference list.
TemplateParameters	getTypeParameters() Return the ordered list of type parameters of this operation.
boolean	isIsInvalidating() Returns the value of the 'Is Invalidating' attribute.
boolean	isIsTypeof() Returns the value of the 'Is Typeof' attribute.
boolean	isIsValidating() Returns the value of the 'Is Validating' attribute.
void	setBodyExpression(LanguageExpression value) Sets the value of the 'Body Expression' containment reference.
void	setIsInvalidating(boolean value) Sets the value of the 'Is Invalidating' attribute.
void	setIsTypeof(boolean value) Sets the value of the 'Is Typeof' attribute.
void	setIsValidating(boolean value) Sets the value of the 'Is Validating' attribute.
void	setOwningClass(Class value) Sets the value of the 'Owning Class' container reference.
void	setPrecedence(Precedence value) Sets the value of the 'Precedence' reference.
boolean	validateCompatibleReturn(org.eclipse.emf.common.util.DiagnosticChain diagnostics, java.util.Map<java.lang.Object,java.lang.Object> context)
boolean	validateLoadableImplementation(org.eclipse.emf.common.util.DiagnosticChain diagnostics, java.util.Map<java.lang.Object,java.lang.Object> context)
boolean	validateUniquePostconditionName(org.eclipse.emf.common.util.DiagnosticChain diagnostics, java.util.Map<java.lang.Object,java.lang.Object> context)
boolean	validateUniquePreconditionName(org.eclipse.emf.common.util.DiagnosticChain diagnostics, java.util.Map<java.lang.Object,java.lang.Object> context)

Methods inherited from interface org.eclipse.ocl.pivot.Feature

getImplementation, getImplementationClass, isIsStatic, setImplementation, setImplementationClass, setIsStatic, validateTypeIsNotInvalid

Methods inherited from interface org.eclipse.ocl.pivot.TypedElement

CompatibleBody, getType, getTypeId, isIsMany, isIsRequired, setIsRequired, setType

Methods inherited from interface org.eclipse.ocl.pivot.NamedElement

getName, setName

Methods inherited from interface org.eclipse.ocl.pivot.Element

accept, allOwnedElements, getAnnotatingComments, getESObject, getETarget, getOwnedAnnotations, getOwnedComments, getOwnedExtensions, getValue

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.ocl.pivot.util.Visitable

eClass

Methods inherited from interface org.eclipse.ocl.pivot.Namespace

getOwnedConstraints

Methods inherited from interface org.eclipse.ocl.pivot.TemplateableElement

getOwnedBindings, getOwnedSignature, getUnspecializedElement, setOwnedSignature, setUnspecializedElement

Method Detail

getRaisedExceptions

@NonNull
java.util.List<Type> getRaisedExceptions()

Returns the value of the 'Raised Exceptions' reference list. The list contents are of type Type. The Types representing exceptions that may be raised during an invocation of this BehavioralFeature. The Types representing exceptions that may be raised during an invocation of this operation.

Returns:

the value of the 'Raised Exceptions' reference list.

See Also:

PivotPackage.getOperation_RaisedExceptions()

Generated

getRedefinedOperations

@NonNull
java.util.List<Operation> getRedefinedOperations()

Returns the value of the 'Redefined Operations' reference list. The list contents are of type Operation.

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

The Operations that are redefined by this Operation.

Returns:

the value of the 'Redefined Operations' reference list.

See Also:

PivotPackage.getOperation_RedefinedOperations()

Generated

getOwnedParameters

@NonNull
java.util.List<Parameter> getOwnedParameters()

Returns the value of the 'Owned Parameters' containment reference list. The list contents are of type Parameter. It is bidirectional and its opposite is 'Owning Operation'. The ordered set of formal Parameters of this BehavioralFeature. The parameters owned by this Operation.

Returns:

the value of the 'Owned Parameters' containment reference list.

See Also:

PivotPackage.getOperation_OwnedParameters(), Parameter.getOwningOperation()

Generated

getOwnedPostconditions

@NonNull
java.util.List<Constraint> getOwnedPostconditions()

Returns the value of the 'Owned Postconditions' containment reference list. The list contents are of type Constraint. It is bidirectional and its opposite is 'Owning Post Context'.

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

An optional set of Constraints specifying the state of the system when the Operation is completed.

Returns:

the value of the 'Owned Postconditions' containment reference list.

See Also:

PivotPackage.getOperation_OwnedPostconditions(), Constraint.getOwningPostContext()

Generated

getOwnedPreconditions

@NonNull
java.util.List<Constraint> getOwnedPreconditions()

Returns the value of the 'Owned Preconditions' containment reference list. The list contents are of type Constraint. It is bidirectional and its opposite is 'Owning Pre Context'.

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

An optional set of Constraints on the state of the system when the Operation is invoked.

Returns:

the value of the 'Owned Preconditions' containment reference list.

See Also:

PivotPackage.getOperation_OwnedPreconditions(), Constraint.getOwningPreContext()

Generated

getPrecedence

Precedence getPrecedence()

Returns the value of the 'Precedence' reference.

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

Returns:

the value of the 'Precedence' reference.

See Also:

setPrecedence(Precedence), PivotPackage.getOperation_Precedence()

Generated

setPrecedence

void setPrecedence(Precedence value)

Sets the value of the 'Precedence' reference.

Parameters:

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

See Also:

getPrecedence()

Generated

getBodyExpression

LanguageExpression getBodyExpression()

Returns the value of the 'Body Expression' containment reference.

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

Returns:

the value of the 'Body Expression' containment reference.

See Also:

setBodyExpression(LanguageExpression), PivotPackage.getOperation_BodyExpression()

Generated

setBodyExpression

void setBodyExpression(LanguageExpression value)

Sets the value of the 'Body Expression' containment reference.

Parameters:

value - the new value of the 'Body Expression' containment reference.

See Also:

getBodyExpression()

Generated

isIsInvalidating

boolean isIsInvalidating()

Returns the value of the 'Is Invalidating' attribute. The default value is "false".

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

Returns:

the value of the 'Is Invalidating' attribute.

See Also:

setIsInvalidating(boolean), PivotPackage.getOperation_IsInvalidating()

Generated

setIsInvalidating

void setIsInvalidating(boolean value)

Sets the value of the 'Is Invalidating' attribute.

Parameters:

value - the new value of the 'Is Invalidating' attribute.

See Also:

isIsInvalidating()

Generated

isIsTypeof

boolean isIsTypeof()

Returns the value of the 'Is Typeof' attribute. The default value is "false".

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

Returns:

the value of the 'Is Typeof' attribute.

See Also:

setIsTypeof(boolean), PivotPackage.getOperation_IsTypeof()

Generated

setIsTypeof

void setIsTypeof(boolean value)

Sets the value of the 'Is Typeof' attribute.

Parameters:

value - the new value of the 'Is Typeof' attribute.

See Also:

isIsTypeof()

Generated

isIsValidating

boolean isIsValidating()

Returns the value of the 'Is Validating' attribute. The default value is "false".

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

Returns:

the value of the 'Is Validating' attribute.

See Also:

setIsValidating(boolean), PivotPackage.getOperation_IsValidating()

Generated

setIsValidating

void setIsValidating(boolean value)

Sets the value of the 'Is Validating' attribute.

Parameters:

value - the new value of the 'Is Validating' attribute.

See Also:

isIsValidating()

Generated

getOwningClass

Class getOwningClass()

Returns the value of the 'Owning Class' container reference. It is bidirectional and its opposite is 'Owned Operations'. The Class that owns this operation, if any.

Specified by:

getOwningClass in interface Feature

Returns:

the value of the 'Owning Class' container reference.

See Also:

setOwningClass(org.eclipse.ocl.pivot.Class), PivotPackage.getOperation_OwningClass(), Class.getOwnedOperations()

Generated

setOwningClass

void setOwningClass(Class value)

Sets the value of the 'Owning Class' container reference.

Parameters:

value - the new value of the 'Owning Class' container reference.

See Also:

getOwningClass()

Generated

validateCompatibleReturn

boolean validateCompatibleReturn(org.eclipse.emf.common.util.DiagnosticChain diagnostics,
                                 java.util.Map<java.lang.Object,java.lang.Object> context)

Generated

validateLoadableImplementation

boolean validateLoadableImplementation(org.eclipse.emf.common.util.DiagnosticChain diagnostics,
                                       java.util.Map<java.lang.Object,java.lang.Object> context)

Generated

validateUniquePreconditionName

boolean validateUniquePreconditionName(org.eclipse.emf.common.util.DiagnosticChain diagnostics,
                                       java.util.Map<java.lang.Object,java.lang.Object> context)

Generated

validateUniquePostconditionName

boolean validateUniquePostconditionName(org.eclipse.emf.common.util.DiagnosticChain diagnostics,
                                        java.util.Map<java.lang.Object,java.lang.Object> context)

Generated

getIndex

int getIndex()

Return the index of this operation in the operation dispatch table.

getInheritance

@Nullable
CompleteInheritance getInheritance(@NonNull
                                              StandardLibrary standardLibrary)

Return the Inheritance dispatch table for the owning type, or null for am orphan property owned by an Annotation.

getOperationId

@NonNull
OperationId getOperationId()

getParametersId

@NonNull
ParametersId getParametersId()

Return the unique identity of the ordered list of parameters of this operation.

getParameterTypes

@NonNull
ParameterTypes getParameterTypes()

Return the ordered list of parameters of this operation.

getTypeParameters

@NonNull
TemplateParameters getTypeParameters()

Return the ordered list of type parameters of this operation.