org.andromda.cartridges.jsf.metafacades

Interface JSFAction

All Superinterfaces:

FrontEndAction, FrontEndForward, ModelElementFacade, TransitionFacade

All Known Implementing Classes:

JSFActionLogic, JSFActionLogicImpl

public interface JSFAction
extends FrontEndAction

Represents an action taken during a "front-end" event execution on a JSF application. Metafacade interface to be used by AndroMDA cartridges.

Method Summary

Methods

Modifier and Type	Method and Description
String	getActionClassName() The name of the action class that executes this action.
String	getControllerAction() The name of the action on the controller that executions this action.
String	getDocumentationKey() A resource message key suited for the action''s documentation.
String	getDocumentationValue() The resource messsage value suited for the action''s documentation.
String	getFormBeanName() The name of the bean under which the form is stored.
String	getFormImplementationGetter() The signature of the accessor method that returns the form implementation instance.
String	getFormImplementationInterfaceList() A comma separated list of all the form interfaces which the form implementation implements.
String	getFormImplementationName() The name of the form implementation.
String	getFormKey() The key that stores the form in which information is passed from one action to another.
String	getFormScope() The scope of the JSF form (request, session,application,etc).
String	getFormSerialVersionUID() The calcuated serial version UID for this action's form.
String	getFromOutcome() The name that corresponds to the from-outcome in an navigational rule.
String	getFullyQualifiedActionClassName() The fully qualified name of the action class that execute this action.
String	getFullyQualifiedActionClassPath() The fully qualified path to the action class that execute this action.
String	getFullyQualifiedFormImplementationName() The fully qualified name of the form implementation.
String	getFullyQualifiedFormImplementationPath() The fully qualified path of the form implementation.
List<JSFParameter>	getHiddenParameters() All parameters that are of hidden input type.
String	getMessageKey() The default resource message key for this action.
String	getPath() The path to this action.
String	getPathRoot() The path's root.
Map	getSuccessMessages() Messages used to indicate successful execution.
String	getTableLinkColumnName() The name of the column targetted by this action.
String	getTableLinkName() The name of the table link specified for this action.
JSFParameter	getTableLinkParameter() If the action is a table link then this property represents the table to which is being linked.
String	getTriggerMethodName() The name of the method to be executed when this action is triggered.
String	getTriggerName() The name of the trigger that triggers that action.
String	getViewFragmentPath() The path to the view fragment corresponding to this action
Map	getWarningMessages() Any messages used to indicate a warning.
boolean	isFinalStateTarget() Indicates whether or not a final state is the target of this action.
boolean	isFormReset() Whether or not the entire form should be reset (all action parameters on the form).
boolean	isFormResetRequired() Indicates if at least one parameter on the form requires being reset.
boolean	isHyperlink() Indicates whether or not this action is represented by clicking on a hyperlink.
boolean	isJSFActionMetaType() Indicates the metafacade type (used for metafacade mappings).
boolean	isNeedsFileUpload() TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFAction.needsFileUpload
boolean	isPopup() Indicates if this action forwards to a popup (this is determed when the targetted view is a popup).
boolean	isResettable() Indicates whether or not the values passed along with this action can be reset or not.
boolean	isSuccessMessagesPresent() Indicates whether or not any success messags are present.
boolean	isTableAction() Indicates that this action works on all rows of the table from the table link relation.
boolean	isTableLink() Indicates if a table link name has been specified and it properly targets a table page-variable from the input page.
boolean	isValidationRequired() Indicates whether or not at least one parameter on this action requires validation.
boolean	isWarningMessagesPresent() Whether or not any warning messages are present.

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

findParameter, getActionForwards, getActionStates, getController, getDecisionTransitions, getDeferredOperations, getFormFields, getInput, getParameters, getTargetViews, getTransitions, isFrontEndActionMetaType, isUseCaseStart

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

isJSFActionMetaType

boolean isJSFActionMetaType()

Indicates the metafacade type (used for metafacade mappings).

Returns:

boolean always true

getActionClassName

String getActionClassName()

The name of the action class that executes this action.

Returns:

String

getControllerAction

String getControllerAction()

The name of the action on the controller that executions this action.

Returns:

String

getDocumentationKey

String getDocumentationKey()

A resource message key suited for the action''s documentation.

Returns:

String

getDocumentationValue

String getDocumentationValue()

The resource messsage value suited for the action''s documentation.

Returns:

String

getFormBeanName

String getFormBeanName()

The name of the bean under which the form is stored.

Returns:

String

getFormImplementationGetter

String getFormImplementationGetter()

The signature of the accessor method that returns the form implementation instance.

Returns:

String

getFormImplementationInterfaceList

String getFormImplementationInterfaceList()

A comma separated list of all the form interfaces which the form implementation implements.

Returns:

String

getFormImplementationName

String getFormImplementationName()

The name of the form implementation.

Returns:

String

getFormKey

String getFormKey()

The key that stores the form in which information is passed from one action to another.

Returns:

String

getFormScope

String getFormScope()

The scope of the JSF form (request, session,application,etc).

Returns:

String

getFormSerialVersionUID

String getFormSerialVersionUID()

The calcuated serial version UID for this action's form.

Returns:

String

getFromOutcome

String getFromOutcome()

The name that corresponds to the from-outcome in an navigational rule.

Returns:

String

getFullyQualifiedActionClassName

String getFullyQualifiedActionClassName()

The fully qualified name of the action class that execute this action.

Returns:

String

getFullyQualifiedActionClassPath

String getFullyQualifiedActionClassPath()

The fully qualified path to the action class that execute this action.

Returns:

String

getFullyQualifiedFormImplementationName

String getFullyQualifiedFormImplementationName()

The fully qualified name of the form implementation.

Returns:

String

getFullyQualifiedFormImplementationPath

String getFullyQualifiedFormImplementationPath()

The fully qualified path of the form implementation.

Returns:

String

getHiddenParameters

List<JSFParameter> getHiddenParameters()

All parameters that are of hidden input type.

Returns:

List

getMessageKey

String getMessageKey()

The default resource message key for this action.

Returns:

String

getPath

String getPath()

The path to this action.

Returns:

String

getPathRoot

String getPathRoot()

The path's root.

Returns:

String

getSuccessMessages

Map getSuccessMessages()

Messages used to indicate successful execution.

Returns:

Map

getTableLinkColumnName

String getTableLinkColumnName()

The name of the column targetted by this action.

Returns:

String

getTableLinkName

String getTableLinkName()

The name of the table link specified for this action.

Returns:

String

getTableLinkParameter

JSFParameter getTableLinkParameter()

If the action is a table link then this property represents the table to which is being linked.

Returns:

JSFParameter

getTriggerMethodName

String getTriggerMethodName()

The name of the method to be executed when this action is triggered.

Returns:

String

getTriggerName

String getTriggerName()

The name of the trigger that triggers that action.

Returns:

String

getViewFragmentPath

String getViewFragmentPath()

The path to the view fragment corresponding to this action

Returns:

String

getWarningMessages

Map getWarningMessages()

Any messages used to indicate a warning.

Returns:

Map

isFinalStateTarget

boolean isFinalStateTarget()

Indicates whether or not a final state is the target of this action.

Returns:

boolean

isFormReset

boolean isFormReset()

Whether or not the entire form should be reset (all action parameters on the form).

Returns:

boolean

isFormResetRequired

boolean isFormResetRequired()

Indicates if at least one parameter on the form requires being reset.

Returns:

boolean

isHyperlink

boolean isHyperlink()

Indicates whether or not this action is represented by clicking on a hyperlink.

Returns:

boolean

isNeedsFileUpload

boolean isNeedsFileUpload()

TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFAction.needsFileUpload

Returns:

boolean

isPopup

boolean isPopup()

Indicates if this action forwards to a popup (this is determed when the targetted view is a popup).

Returns:

boolean

isResettable

boolean isResettable()

Indicates whether or not the values passed along with this action can be reset or not.

Returns:

boolean

isSuccessMessagesPresent

boolean isSuccessMessagesPresent()

Indicates whether or not any success messags are present.

Returns:

boolean

isTableAction

boolean isTableAction()

Indicates that this action works on all rows of the table from the table link relation.

Returns:

boolean

isTableLink

boolean isTableLink()

Indicates if a table link name has been specified and it properly targets a table page-variable from the input page.

Returns:

boolean

isValidationRequired

boolean isValidationRequired()

Indicates whether or not at least one parameter on this action requires validation.

Returns:

boolean

isWarningMessagesPresent

boolean isWarningMessagesPresent()

Whether or not any warning messages are present.

Returns:

boolean