org.andromda.metafacades.uml

Interface FrontEndAction

All Superinterfaces:

FrontEndForward, ModelElementFacade, TransitionFacade

public interface FrontEndAction
extends FrontEndForward

Represents a "front-end" action. An action is some action that is taken when a front-end even occurs. 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 action having the given name, if no parameter is found, null is returned instead.
List<FrontEndForward>	getActionForwards() All action forwards for this foward.
List<FrontEndActionState>	getActionStates() All action states visited by this action.
FrontEndController	getController() The controller that will handle the execution of this front-end action.
List<FrontEndForward>	getDecisionTransitions() All the transitions coming out of decision points.
List<FrontEndControllerOperation>	getDeferredOperations() The controller operations to which this action defers, the order is preserved.
List<FrontEndParameter>	getFormFields() Form fields for this action.
StateVertexFacade	getInput() The StateVertex (FrontEndView or PseudostateFacade) on which this action can be triggered.
List<FrontEndParameter>	getParameters() All parameters sent by this "front-end" action.
List<FrontEndView>	getTargetViews() All views that can be possibly targetted by triggering this action.
List<FrontEndForward>	getTransitions() All the transitions that make up this action, this directly maps onto the forwards.
boolean	isFrontEndActionMetaType() Indicates the metafacade type (used for metafacade mappings).
boolean	isUseCaseStart() Indicates if this action represents the beginning of the front-end use case or not.

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

getActionMethodName, getActions, getDecisionTrigger, getForwardParameters, getFrontEndActivityGraph, getOperationCall, getUseCase, isContainedInFrontEndUseCase, isEnteringView, isExitingView, isFrontEndForwardMetaType

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

getEffect, getGuard, getSource, getTarget, getTrigger, isEnteringActionState, isEnteringDecisionPoint, isEnteringFinalState, isExitingActionState, isExitingDecisionPoint, isExitingInitialState, isTransitionFacadeMetaType, isTriggerPresent

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

isFrontEndActionMetaType

boolean isFrontEndActionMetaType()

Indicates the metafacade type (used for metafacade mappings).

Returns:

boolean always true

findParameter

ParameterFacade findParameter(String name)

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

Parameters:

name - String

Returns:

ParameterFacade

getActionForwards

List<FrontEndForward> getActionForwards()

All action forwards for this foward. Each action forward either calls a view or another use-case (which is essentially an action).

Returns:

List

getActionStates

List<FrontEndActionState> getActionStates()

All action states visited by this action.

Returns:

List

getController

FrontEndController getController()

The controller that will handle the execution of this front-end action. This controller is set as the context of the activity graph (and therefore also of the use-case).

Returns:

FrontEndController

getDecisionTransitions

List<FrontEndForward> getDecisionTransitions()

All the transitions coming out of decision points. These transitions should all carry guards.

Returns:

List

getDeferredOperations

List<FrontEndControllerOperation> getDeferredOperations()

The controller operations to which this action defers, the order is preserved.

Returns:

List

getFormFields

List<FrontEndParameter> getFormFields()

Form fields for this action. Form fields are those parameters that can be altered by the user on a corresponding view at runtime.

Returns:

List

getInput

StateVertexFacade getInput()

The StateVertex (FrontEndView or PseudostateFacade) on which this action can be triggered.

Returns:

StateVertexFacade

getParameters

List<FrontEndParameter> getParameters()

All parameters sent by this "front-end" action.

Returns:

List

getTargetViews

List<FrontEndView> getTargetViews()

All views that can be possibly targetted by triggering this action.

Returns:

List

getTransitions

List<FrontEndForward> getTransitions()

All the transitions that make up this action, this directly maps onto the forwards.

Returns:

List

isUseCaseStart

boolean isUseCaseStart()

Indicates if this action represents the beginning of the front-end use case or not.

Returns:

boolean