org.andromda.metafacades.uml
Interface OperationFacade

All Superinterfaces:

ModelElementFacade

All Known Subinterfaces:

EntityQueryOperation, FrontEndControllerOperation, ServiceOperation

public interface OperationFacade

extends ModelElementFacade

Represents an modeled operation.

Metafacade interface to be used by AndroMDA cartridges.

Method Summary

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 seperated list of all argument names.
Collection	getArguments()
String	getArgumentTypeNames()
String	getCall()
String	getConcurrency() Returns the concurrency modifier for this operation (i.e.
String	getExceptionList() A comma seperated list containing all exceptions that this operation throws.
String	getExceptionList(String initialExceptions) Returns a comma seperated list of exceptions appended to the comma seperated list of fully qualified 'initialException' classes passed in to this method.
Collection	getExceptions() A collection of all exceptions thrown by this operation.
int	getLower() the lower value for the multiplicity
OperationFacade	getOverriddenOperation() The operation this operation overrides, null if this operation is not overriding.
ClassifierFacade	getOwner() Gets the owner of this operation
Collection	getParameters()
String	getPostconditionName() The name of the operation that handles postcondition constraints.
Collection	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	getPreconditions() The precondition constraints belonging to this operation.
String	getPreconditionSignature() The signature of the precondition operation.
ParameterFacade	getReturnParameter() (UML2 Only).
ClassifierFacade	getReturnType()
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.
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 *)
boolean	isAbstract()
boolean	isExceptionsPresent() True if the operation has (i.e.
boolean	isOperationFacadeMetaType() Indicates the metafacade type (used for metafacade mappings).
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()

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

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

Method Detail

isOperationFacadeMetaType

public boolean isOperationFacadeMetaType()

Indicates the metafacade type (used for metafacade mappings).

Returns:

always true

findParameter

public ParameterFacade findParameter(String name)

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

findTaggedValue

public 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 hiearchy.

getArgumentNames

public String getArgumentNames()

A comma seperated list of all argument names.

getArgumentTypeNames

public String getArgumentTypeNames()

getArguments

public Collection getArguments()

getCall

public String getCall()

getConcurrency

public 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).

getExceptionList

public String getExceptionList(String initialExceptions)

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

getExceptionList

public String getExceptionList()

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

getExceptions

public Collection getExceptions()

A collection of all exceptions thrown by this operation.

getLower

public int getLower()

the lower value for the multiplicity

-only applicable for UML2

getOverriddenOperation

public OperationFacade getOverriddenOperation()

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

getOwner

public ClassifierFacade getOwner()

Gets the owner of this operation

getParameters

public Collection getParameters()

getPostconditionName

public String getPostconditionName()

The name of the operation that handles postcondition constraints.

getPostconditions

public Collection getPostconditions()

The postcondition constraints belonging to this operation.

getPreconditionCall

public String getPreconditionCall()

The call to the precondition operation.

getPreconditionName

public String getPreconditionName()

The name of the operation that handles precondition constraints.

getPreconditionSignature

public String getPreconditionSignature()

The signature of the precondition operation.

getPreconditions

public Collection getPreconditions()

The precondition constraints belonging to this operation.

getReturnParameter

public ParameterFacade getReturnParameter()

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

getReturnType

public ClassifierFacade getReturnType()

getSignature

public 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.

getSignature

public String getSignature()

getSignature

public String getSignature(String argumentModifier)

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

getTypedArgumentList

public String getTypedArgumentList()

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

getTypedArgumentList

public 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.

getUpper

public int getUpper()

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

- only applicable for UML2

isAbstract

public boolean isAbstract()

isExceptionsPresent

public boolean isExceptionsPresent()

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

isOverriding

public 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.

isPostconditionsPresent

public boolean isPostconditionsPresent()

Whether any postcondition constraints are present on this operation.

isPreconditionsPresent

public boolean isPreconditionsPresent()

Whether any precondition constraints are present on this operation.

isQuery

public boolean isQuery()

Indicates whether or not this operation is a query operation.

isReturnTypePresent

public 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).

isStatic

public boolean isStatic()