org.andromda.metafacades.uml

Interface FrontEndParameter

All Superinterfaces:

ModelElementFacade, ParameterFacade

public interface FrontEndParameter
extends ParameterFacade

A front-end parameter is a parameter passed between front-end action states. Metafacade interface to be used by AndroMDA cartridges.

Method Summary

Methods

Modifier and Type	Method and Description
FrontEndAction	getAction() The action to which this parameter belongs (if it belongs to an action), otherwise it returns null.
FrontEndControllerOperation	getControllerOperation() Gets the controller operation to which this parameter belongs.
Collection<String>	getTableAttributeNames() A collection of all possible attribute names of a table (this will only work when your table is modeled as an array..not a collection).
Collection<String>	getTableColumnNames() All the columns for this parameter if it represents a table variable.
Collection<String>	getTableColumns() A list of all attributes which make up the table columns of this table (this only contains attributes when the table is represented by an array).
FrontEndView	getView() Represents the view in which this parameter will be used.
boolean	isActionParameter() Indicates whether or not this is an action parameter or not.
boolean	isContainedInFrontEndUseCase() Indicates if this parameter is contained in a "front-end" use case.
boolean	isControllerOperationArgument() Indicates whether or not this parameter is an argument of a controller operation.
boolean	isFrontEndParameterMetaType() Indicates the metafacade type (used for metafacade mappings).
boolean	isTable() Indicates whether or not this parameter represents a table.

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

getDefaultValue, getEffect, getEvent, getGetterName, getGetterSetterTypeName, getGetterSetterTypeNameImpl, getLower, getOperation, getSetterName, getType, getUpper, isDefaultValuePresent, isException, isInoutParameter, isInParameter, isMany, isOrdered, isOutParameter, isParameterFacadeMetaType, isReadable, isRequired, isReturn, isUnique, isWritable

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

isFrontEndParameterMetaType

boolean isFrontEndParameterMetaType()

Indicates the metafacade type (used for metafacade mappings).

Returns:

boolean always true

getAction

FrontEndAction getAction()

The action to which this parameter belongs (if it belongs to an action), otherwise it returns null.

Returns:

FrontEndAction

getControllerOperation

FrontEndControllerOperation getControllerOperation()

Gets the controller operation to which this parameter belongs.

Returns:

FrontEndControllerOperation

getTableAttributeNames

Collection<String> getTableAttributeNames()

A collection of all possible attribute names of a table (this will only work when your table is modeled as an array..not a collection).

Returns:

Collection

getTableColumnNames

Collection<String> getTableColumnNames()

All the columns for this parameter if it represents a table variable. If a column is linked by an event (action) a FrontEndParameter instance is included in the return value, otherwise a plain String representing the column name.

Returns:

Collection

getTableColumns

Collection<String> getTableColumns()

A list of all attributes which make up the table columns of this table (this only contains attributes when the table is represented by an array).

Returns:

Collection

getView

FrontEndView getView()

Represents the view in which this parameter will be used.

Returns:

FrontEndView

isActionParameter

boolean isActionParameter()

Indicates whether or not this is an action parameter or not.

Returns:

boolean

isContainedInFrontEndUseCase

boolean isContainedInFrontEndUseCase()

Indicates if this parameter is contained in a "front-end" use case.

Returns:

boolean

isControllerOperationArgument

boolean isControllerOperationArgument()

Indicates whether or not this parameter is an argument of a controller operation.

Returns:

boolean

isTable

boolean isTable()

Indicates whether or not this parameter represents a table.

Returns:

boolean