org.andromda.metafacades.uml

Interface OperationFacade

All Superinterfaces:

ModelElementFacade

All Known Subinterfaces:

EntityQueryOperation, FrontEndControllerOperation, ServiceOperation

public interface OperationFacade
extends ModelElementFacade

A behavioral feature of a classifier that specifies the name, type, parameters, and constraints for invoking an associated behavior. May invoke both the execution of method behaviors as well as other behavioral responses. Metafacade interface to be used by AndroMDA cartridges.

Method Summary

Methods

Modifier and Type	Method and Description
ParameterFacade	findParameter(String name) Finds the parameter on this operation having the given name, if no parameter is found, null is returned instead.
Object	findTaggedValue(String name, boolean follow) Searches the given feature for the specified tag.
String	getArgumentNames() A comma separated list of all argument names.
Collection<ParameterFacade>	getArguments() Specification of an argument used to pass information into or out of an invocation of a behavioral feature.
String	getArgumentTypeNames() A comma separated list of all types of each argument, in order.
String	getCall() Constructs the operation call with the operation name
String	getConcurrency() Returns the concurrency modifier for this operation (i.e.
String	getExceptionList() A comma separated list containing all exceptions that this operation throws.
String	getExceptionList(String initialExceptions) Returns a comma separated list of exceptions appended to the comma separated list of fully qualified 'initialException' classes passed in to this method.
Collection<ModelElementFacade>	getExceptions() A collection of all exceptions thrown by this operation.
String	getGetterSetterReturnTypeName() Return Type with multiplicity taken into account.
int	getLower() the lower value for the multiplicity -only applicable for UML2
String	getMethodBody() Returns the operation method body determined from UML sequence diagrams or other UML sources.
OperationFacade	getOverriddenOperation() The operation this operation overrides, null if this operation is not overriding.
ClassifierFacade	getOwner() Gets the owner of this operation
Collection<ParameterFacade>	getParameters() Return all parameters for the operation, including the return parameter.
String	getPostconditionName() The name of the operation that handles postcondition constraints.
Collection<ConstraintFacade>	getPostconditions() The postcondition constraints belonging to this operation.
String	getPreconditionCall() The call to the precondition operation.
String	getPreconditionName() The name of the operation that handles precondition constraints.
Collection<ConstraintFacade>	getPreconditions() The precondition constraints belonging to this operation.
String	getPreconditionSignature() The signature of the precondition operation.
ParameterFacade	getReturnParameter() (UML2 Only).
ClassifierFacade	getReturnType() The operation return type parameter.
String	getSignature() Return the operation signature, including public/protested abstract returnType name plus argument type and name
String	getSignature(boolean withArgumentNames) Returns the signature of the operation and optionally appends the argument names (if withArgumentNames is true), otherwise returns the signature with just the types alone in the signature.
String	getSignature(String argumentModifier) Returns the signature of the operation and optionally appends the given 'argumentModifier' to each argument.
String	getTypedArgumentList() A comma-separated parameter list (type and name of each parameter) of an operation.
String	getTypedArgumentList(String modifier) A comma-separated parameter list (type and name of each parameter) of an operation with an optional modifier (i.e final) before each parameter.
int	getUpper() the upper value for the multiplicity (will be -1 for *) - only applicable for UML2
boolean	isAbstract() True is the operation is abstract.
boolean	isExceptionsPresent() True if the operation has (i.e.
boolean	isLeaf() IsLeaf property in the operation.
boolean	isMany() UML2 only.
boolean	isOperationFacadeMetaType() Indicates the metafacade type (used for metafacade mappings).
boolean	isOrdered() UML2 only: If isMany (Collection type returned), is the type unique within the collection.
boolean	isOverriding() True if this operation overrides an operation defined in an ancestor class.
boolean	isPostconditionsPresent() Whether any postcondition constraints are present on this operation.
boolean	isPreconditionsPresent() Whether any precondition constraints are present on this operation.
boolean	isQuery() Indicates whether or not this operation is a query operation.
boolean	isReturnTypePresent() True/false depending on whether or not the operation has a return type or not (i.e.
boolean	isStatic() True is the operation is static (only a single instance can be instantiated).
boolean	isUnique() UML2 only: for Collection return type, is the type unique within the collection.

Methods inherited from interface org.andromda.metafacades.uml.ModelElementFacade

copyTaggedValues, findTaggedValue, findTaggedValues, getBindedFullyQualifiedName, getConstraints, getConstraints, getDocumentation, getDocumentation, getDocumentation, getFullyQualifiedName, getFullyQualifiedName, getFullyQualifiedNamePath, getId, getKeywords, getLabel, getLanguageMappings, getModel, getName, getPackage, getPackageName, getPackageName, getPackagePath, getQualifiedName, getRootPackage, getSourceDependencies, getStateMachineContext, getStereotypeNames, getStereotypes, getTaggedValues, getTargetDependencies, getTemplateParameter, getTemplateParameters, getValidationName, getValidationOwner, getVisibility, hasExactStereotype, hasKeyword, hasStereotype, initialize, isBindingDependenciesPresent, isConstraintsPresent, isDocumentationPresent, isModelElementFacadeMetaType, isReservedWord, isTemplateParametersPresent, isValidIdentifierName, translateConstraint, translateConstraints, translateConstraints, validateInvariants

Method Detail

isOperationFacadeMetaType

boolean isOperationFacadeMetaType()

Indicates the metafacade type (used for metafacade mappings).

Returns:

boolean always true

findParameter

ParameterFacade findParameter(String name)

Finds the parameter on this operation having the given name, if no parameter is found, null is returned instead.

Parameters:

name - String

Returns:

ParameterFacade

findTaggedValue

Object findTaggedValue(String name,
                     boolean follow)

Searches the given feature for the specified tag. If the follow boolean is set to true then the search will continue from the class operation to the class itself and then up the class hierarchy.

Parameters:

name - String

follow - boolean

Returns:

Object

getArgumentNames

String getArgumentNames()

A comma separated list of all argument names.

Returns:

String

getArgumentTypeNames

String getArgumentTypeNames()

A comma separated list of all types of each argument, in order.

Returns:

String

getArguments

Collection<ParameterFacade> getArguments()

Specification of an argument used to pass information into or out of an invocation of a behavioral feature. Parameters are allowed to be treated as connectable elements. Parameters have support for streaming, exceptions, and parameter sets.

Returns:

Collection

getCall

String getCall()

Constructs the operation call with the operation name

Returns:

String

getConcurrency

String getConcurrency()

Returns the concurrency modifier for this operation (i.e. concurrent, guarded or sequential) of the model element, will attempt a lookup for these values in the language mappings (if any).

Returns:

String

getExceptionList

String getExceptionList()

A comma separated list containing all exceptions that this operation throws. Exceptions are determined through dependencies that have the target element stereotyped as <>.

Returns:

String

getExceptionList

String getExceptionList(String initialExceptions)

Returns a comma separated list of exceptions appended to the comma separated list of fully qualified 'initialException' classes passed in to this method.

Parameters:

initialExceptions - String

Returns:

String

getExceptions

Collection<ModelElementFacade> getExceptions()

A collection of all exceptions thrown by this operation.

Returns:

Collection

getGetterSetterReturnTypeName

String getGetterSetterReturnTypeName()

Return Type with multiplicity taken into account. UML14 does not allow multiplicity *.

Returns:

String

getLower

int getLower()

the lower value for the multiplicity -only applicable for UML2

Returns:

int

getMethodBody

String getMethodBody()

Returns the operation method body determined from UML sequence diagrams or other UML sources.

Returns:

String

getOverriddenOperation

OperationFacade getOverriddenOperation()

The operation this operation overrides, null if this operation is not overriding.

Returns:

OperationFacade

getOwner

ClassifierFacade getOwner()

Gets the owner of this operation

Returns:

ClassifierFacade

getParameters

Collection<ParameterFacade> getParameters()

Return all parameters for the operation, including the return parameter.

Returns:

Collection

getPostconditionName

String getPostconditionName()

The name of the operation that handles postcondition constraints.

Returns:

String

getPostconditions

Collection<ConstraintFacade> getPostconditions()

The postcondition constraints belonging to this operation.

Returns:

Collection

getPreconditionCall

String getPreconditionCall()

The call to the precondition operation.

Returns:

String

getPreconditionName

String getPreconditionName()

The name of the operation that handles precondition constraints.

Returns:

String

getPreconditionSignature

String getPreconditionSignature()

The signature of the precondition operation.

Returns:

String

getPreconditions

Collection<ConstraintFacade> getPreconditions()

The precondition constraints belonging to this operation.

Returns:

Collection

getReturnParameter

ParameterFacade getReturnParameter()

(UML2 Only). Get the actual return parameter (which may have stereotypes etc).

Returns:

ParameterFacade

getReturnType

ClassifierFacade getReturnType()

The operation return type parameter.

Returns:

ClassifierFacade

getSignature

String getSignature()

Return the operation signature, including public/protested abstract returnType name plus argument type and name

Returns:

String

getSignature

String getSignature(boolean withArgumentNames)

Returns the signature of the operation and optionally appends the argument names (if withArgumentNames is true), otherwise returns the signature with just the types alone in the signature.

Parameters:

withArgumentNames - boolean

Returns:

String

getSignature

String getSignature(String argumentModifier)

Returns the signature of the operation and optionally appends the given 'argumentModifier' to each argument.

Parameters:

argumentModifier - String

Returns:

String

getTypedArgumentList

String getTypedArgumentList()

A comma-separated parameter list (type and name of each parameter) of an operation.

Returns:

String

getTypedArgumentList

String getTypedArgumentList(String modifier)

A comma-separated parameter list (type and name of each parameter) of an operation with an optional modifier (i.e final) before each parameter.

Parameters:

modifier - String

Returns:

String

getUpper

int getUpper()

the upper value for the multiplicity (will be -1 for *) - only applicable for UML2

Returns:

int

isAbstract

boolean isAbstract()

True is the operation is abstract.

Returns:

boolean

isExceptionsPresent

boolean isExceptionsPresent()

True if the operation has (i.e. throws any exceptions) false otherwise.

Returns:

boolean

isLeaf

boolean isLeaf()

IsLeaf property in the operation. If true, operation is final, cannot be extended or implemented by a descendant. Default=false.

Returns:

boolean

isMany

boolean isMany()

UML2 only. If the return type parameter multiplicity>1 OR the operation multiplicity>1. Default=false.

Returns:

boolean

isOrdered

boolean isOrdered()

UML2 only: If isMany (Collection type returned), is the type unique within the collection. Unique+Ordered determines CollectionType implementation of return result. Default=false.

Returns:

boolean

isOverriding

boolean isOverriding()

True if this operation overrides an operation defined in an ancestor class. An operation overrides when the names of the operations as well as the types of the arguments are equal. The return type may be different and is, as well as any exceptions, ignored.

Returns:

boolean

isPostconditionsPresent

boolean isPostconditionsPresent()

Whether any postcondition constraints are present on this operation.

Returns:

boolean

isPreconditionsPresent

boolean isPreconditionsPresent()

Whether any precondition constraints are present on this operation.

Returns:

boolean

isQuery

boolean isQuery()

Indicates whether or not this operation is a query operation.

Returns:

boolean

isReturnTypePresent

boolean isReturnTypePresent()

True/false depending on whether or not the operation has a return type or not (i.e. a return type of something other than void).

Returns:

boolean

isStatic

boolean isStatic()

True is the operation is static (only a single instance can be instantiated).

Returns:

boolean

isUnique

boolean isUnique()

UML2 only: for Collection return type, is the type unique within the collection. Unique+Ordered determines the returned CollectionType. Default=false.

Returns:

boolean