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

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	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	getTableColumnNames() All the columns for this parameter if it represents a table variable.
Collection	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, getEvent, getGetterName, getLower, getOperation, getSetterName, getType, getUpper, isDefaultValuePresent, isInoutParameter, isInParameter, isOutParameter, isParameterFacadeMetaType, isReadable, isRequired, isReturn, isWritable

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

isFrontEndParameterMetaType

public boolean isFrontEndParameterMetaType()

Indicates the metafacade type (used for metafacade mappings).

Returns:

always true

getAction

public FrontEndAction getAction()

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

getControllerOperation

public FrontEndControllerOperation getControllerOperation()

Gets the controller operation to which this parameter belongs.

getTableAttributeNames

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

getTableColumnNames

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

getTableColumns

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

getView

public FrontEndView getView()

Represents the view in which this parameter will be used.

isActionParameter

public boolean isActionParameter()

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

isContainedInFrontEndUseCase

public boolean isContainedInFrontEndUseCase()

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

isControllerOperationArgument

public boolean isControllerOperationArgument()

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

isTable

public boolean isTable()

Indicates whether or not this parameter represents a table.