ParameterFacade (AndroMDA UML Common Metafacades 3.5-SNAPSHOT API)

All Superinterfaces:

ModelElementFacade

All Known Subinterfaces:

FrontEndParameter
```
public interface ParameterFacade
extends ModelElementFacade
```
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. Metafacade interface to be used by AndroMDA cartridges.

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getDefaultValue()` TODO: Model Documentation for org.andromda.metafacades.uml.ParameterFacade.defaultValue
`String`	`getEffect()` UML2: A representation of the literals of the enumeration 'Parameter Effect Kind': CREATE, READ, UPDATE, DELETE.
`EventFacade`	`getEvent()` If this parameter is located on an event, this will represent that event.
`String`	`getGetterName()` The name to use for accessors getting this parameter from a bean.
`String`	`getGetterSetterTypeName()` Fully Qualified TypeName, determined in part by multiplicity (for UML2).
`String`	`getGetterSetterTypeNameImpl()` Fully Qualified implementation class of TypeName, determined in part by multiplicity (for UML2).
`int`	`getLower()` the lower value for the multiplicity -only applicable for UML2
`OperationFacade`	`getOperation()` If this parameter is located on an operation, this will represent that operation.
`String`	`getSetterName()` The name to use for accessors getting this parameter in a bean.
`ClassifierFacade`	`getType()` A Classifier is a classification of instances - it describes a set of instances that have features in common.
`int`	`getUpper()` the upper value of the multiplicity (will be -1 for *) -only applicable for UML2
`boolean`	`isDefaultValuePresent()` Indicates if the default value is present.
`boolean`	`isException()` UML2: Returns the value of the 'Is Exception' attribute.
`boolean`	`isInoutParameter()` True if this parameter is an inout parameter.
`boolean`	`isInParameter()` True if this parameter is an 'in' parameter.
`boolean`	`isMany()` If upper>1 or upper==unlimited.
`boolean`	`isOrdered()` UML2 Only: Is parameter ordered within the Collection type.
`boolean`	`isOutParameter()` True if this parameter is an 'out' parameter.
`boolean`	`isParameterFacadeMetaType()` Indicates the metafacade type (used for metafacade mappings).
`boolean`	`isReadable()` True if this parameter is readable, aka an in-parameter, or this feature is unspecified.
`boolean`	`isRequired()` Whether or not this parameter is considered required (i.e must a non-empty value).
`boolean`	`isReturn()` Whether or not this parameter represents a return parameter.
`boolean`	`isUnique()` If Parameter type isMany (UML2), is the parameter unique within the Collection.
`boolean`	`isWritable()` True if this parameter is writable, aka an out-parameter, or this feature is unspecified.

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
  - isParameterFacadeMetaType
```
boolean isParameterFacadeMetaType()
```
    Indicates the metafacade type (used for metafacade mappings).
    
    Returns:
    boolean always true
  - getDefaultValue
```
String getDefaultValue()
```
    TODO: Model Documentation for org.andromda.metafacades.uml.ParameterFacade.defaultValue
    
    Returns:
    String
  - getEffect
```
String getEffect()
```
    UML2: A representation of the literals of the enumeration 'Parameter Effect Kind': CREATE, READ, UPDATE, DELETE. The datatype ParameterEffectKind is an enumeration that indicates the effect of a behavior on values passed in or out of its parameters.
    
    Returns:
    String
  - getEvent
```
EventFacade getEvent()
```
    If this parameter is located on an event, this will represent that event.
    
    Returns:
    EventFacade
  - getGetterName
```
String getGetterName()
```
    The name to use for accessors getting this parameter from a bean.
    
    Returns:
    String
  - getGetterSetterTypeName
```
String getGetterSetterTypeName()
```
    Fully Qualified TypeName, determined in part by multiplicity (for UML2). For UML14, same as getterName.
    
    Returns:
    String
  - getGetterSetterTypeNameImpl
```
String getGetterSetterTypeNameImpl()
```
    Fully Qualified implementation class of TypeName, determined in part by multiplicity (for UML2). If upper multiplicity =1, same as getterSetterTypeName.
    
    Returns:
    String
  - getLower
```
int getLower()
```
    the lower value for the multiplicity -only applicable for UML2
    
    Returns:
    int
  - getOperation
```
OperationFacade getOperation()
```
    If this parameter is located on an operation, this will represent that operation.
    
    Returns:
    OperationFacade
  - getSetterName
```
String getSetterName()
```
    The name to use for accessors getting this parameter in a bean.
    
    Returns:
    String
  - getType
```
ClassifierFacade getType()
```
    A Classifier is a classification of instances - it describes a set of instances that have features in common. Can specify a generalization hierarchy by referencing its general classifiers. It may be a Class, DataType, PrimitiveType, Association, Collaboration, UseCase, etc. Can specify a generalization hierarchy by referencing its general classifiers. Has the capability to own collaboration uses. These collaboration uses link a collaboration with the classifier to give a description of the workings of the classifier. Classifier is defined to be a kind of templateable element so that a classifier can be parameterized. It is also defined to be a kind of parameterable element so that a classifier can be a formal template parameter.
    
    Returns:
    ClassifierFacade
  - getUpper
```
int getUpper()
```
    the upper value of the multiplicity (will be -1 for *) -only applicable for UML2
    
    Returns:
    int
  - isDefaultValuePresent
```
boolean isDefaultValuePresent()
```
    Indicates if the default value is present.
    
    Returns:
    boolean
  - isException
```
boolean isException()
```
    UML2: Returns the value of the 'Is Exception' attribute. The default value is "false". Tells whether an output parameter may emit a value to the exclusion of the other outputs.
    
    Returns:
    boolean
  - isInParameter
```
boolean isInParameter()
```
    True if this parameter is an 'in' parameter.
    
    Returns:
    boolean
  - isInoutParameter
```
boolean isInoutParameter()
```
    True if this parameter is an inout parameter.
    
    Returns:
    boolean
  - isMany
```
boolean isMany()
```
    If upper>1 or upper==unlimited. Only applies to UML2. For UML14, always false.
    
    Returns:
    boolean
  - isOrdered
```
boolean isOrdered()
```
    UML2 Only: Is parameter ordered within the Collection type. Ordered+Unique determines the implementation Collection Type. For UML14, always false.
    
    Returns:
    boolean
  - isOutParameter
```
boolean isOutParameter()
```
    True if this parameter is an 'out' parameter.
    
    Returns:
    boolean
  - isReadable
```
boolean isReadable()
```
    True if this parameter is readable, aka an in-parameter, or this feature is unspecified.
    
    Returns:
    boolean
  - isRequired
```
boolean isRequired()
```
    Whether or not this parameter is considered required (i.e must a non-empty value).
    
    Returns:
    boolean
  - isReturn
```
boolean isReturn()
```
    Whether or not this parameter represents a return parameter.
    
    Returns:
    boolean
  - isUnique
```
boolean isUnique()
```
    If Parameter type isMany (UML2), is the parameter unique within the Collection. Unique+Sorted determines pareter implementation type. For UML14, always false.
    
    Returns:
    boolean
  - isWritable
```
boolean isWritable()
```
    True if this parameter is writable, aka an out-parameter, or this feature is unspecified.
    
    Returns:
    boolean

Interface ParameterFacade

Method Summary

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

Method Detail

isParameterFacadeMetaType

getDefaultValue

getEffect

getEvent

getGetterName

getGetterSetterTypeName

getGetterSetterTypeNameImpl

getLower

getOperation

getSetterName

getType

getUpper

isDefaultValuePresent

isException

isInParameter

isInoutParameter

isMany

isOrdered

isOutParameter

isReadable

isRequired

isReturn

isUnique

isWritable