org.andromda.cartridges.jsf.metafacades
Interface JSFAction

All Superinterfaces:

org.andromda.metafacades.uml.FrontEndAction, org.andromda.metafacades.uml.FrontEndForward, org.andromda.metafacades.uml.ModelElementFacade, org.andromda.metafacades.uml.TransitionFacade

All Known Implementing Classes:

JSFActionLogic, JSFActionLogicImpl

public interface JSFAction
extends org.andromda.metafacades.uml.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

java.lang.String	getActionClassName() The name of the action class that executes this action.
java.lang.String	getControllerAction() The name of the action on the controller that executions this action.
java.lang.String	getDocumentationKey() A resource message key suited for the action''s documentation.
java.lang.String	getDocumentationValue() The resource messsage value suited for the action''s documentation.
java.lang.String	getFormBeanName() The name of the bean under which the form is stored.
java.lang.String	getFormImplementationGetter() The signature of the accessor method that returns the form implementation instance.
java.lang.String	getFormImplementationInterfaceList() A comma seperated list of all the form interfaces which the form implementation implements.
java.lang.String	getFormImplementationName() The name of the form implementation.
java.lang.String	getFormKey() The key that stores the form in which information is passed from one action to another.
java.lang.String	getFormScope() The scope of the JSF form (request, session,application,etc).
java.lang.String	getFormSerialVersionUID() The calcuated serial version UID for this action's form.
java.lang.String	getFromOutcome() The name that corresponds to the from-outcome in an navigational rule.
java.lang.String	getFullyQualifiedActionClassName() The fully qualified name of the action class that execute this action.
java.lang.String	getFullyQualifiedActionClassPath() The fully qualified path to the action class that execute this action.
java.lang.String	getFullyQualifiedFormImplementationName() The fully qualified name of the form implementation.
java.lang.String	getFullyQualifiedFormImplementationPath() The fully qualified path of the form implementation.
java.util.List	getHiddenParameters() All parameters that are of hidden input type.
java.lang.String	getMessageKey() The default resource message key for this action.
java.lang.String	getPath() The path to this action.
java.lang.String	getPathRoot() The path's root.
java.util.Map	getSuccessMessages() Messages used to indicate successful execution.
java.lang.String	getTableLinkColumnName() The name of the column targetted by this action.
java.lang.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.
java.lang.String	getTriggerName() The name of the trigger that triggers that action.
java.lang.String	getViewFragmentPath() The path to the view fragment corresponding to this action
java.util.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	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, 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

isJSFActionMetaType

boolean isJSFActionMetaType()

Indicates the metafacade type (used for metafacade mappings).

Returns:

always true

getActionClassName

java.lang.String getActionClassName()

The name of the action class that executes this action.

getControllerAction

java.lang.String getControllerAction()

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

getDocumentationKey

java.lang.String getDocumentationKey()

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

getDocumentationValue

java.lang.String getDocumentationValue()

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

getFormBeanName

java.lang.String getFormBeanName()

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

getFormImplementationGetter

java.lang.String getFormImplementationGetter()

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

getFormImplementationInterfaceList

java.lang.String getFormImplementationInterfaceList()

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

getFormImplementationName

java.lang.String getFormImplementationName()

The name of the form implementation.

getFormKey

java.lang.String getFormKey()

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

getFormScope

java.lang.String getFormScope()

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

getFormSerialVersionUID

java.lang.String getFormSerialVersionUID()

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

getFromOutcome

java.lang.String getFromOutcome()

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

getFullyQualifiedActionClassName

java.lang.String getFullyQualifiedActionClassName()

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

getFullyQualifiedActionClassPath

java.lang.String getFullyQualifiedActionClassPath()

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

getFullyQualifiedFormImplementationName

java.lang.String getFullyQualifiedFormImplementationName()

The fully qualified name of the form implementation.

getFullyQualifiedFormImplementationPath

java.lang.String getFullyQualifiedFormImplementationPath()

The fully qualified path of the form implementation.

getHiddenParameters

java.util.List getHiddenParameters()

All parameters that are of hidden input type.

getMessageKey

java.lang.String getMessageKey()

The default resource message key for this action.

getPath

java.lang.String getPath()

The path to this action.

getPathRoot

java.lang.String getPathRoot()

The path's root.

getSuccessMessages

java.util.Map getSuccessMessages()

Messages used to indicate successful execution.

getTableLinkColumnName

java.lang.String getTableLinkColumnName()

The name of the column targetted by this action.

getTableLinkName

java.lang.String getTableLinkName()

The name of the table link specified for this action.

getTableLinkParameter

JSFParameter getTableLinkParameter()

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

getTriggerName

java.lang.String getTriggerName()

The name of the trigger that triggers that action.

getViewFragmentPath

java.lang.String getViewFragmentPath()

The path to the view fragment corresponding to this action

getWarningMessages

java.util.Map getWarningMessages()

Any messages used to indicate a warning.

isFinalStateTarget

boolean isFinalStateTarget()

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

isFormReset

boolean isFormReset()

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

isFormResetRequired

boolean isFormResetRequired()

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

isHyperlink

boolean isHyperlink()

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

isPopup

boolean isPopup()

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

isResettable

boolean isResettable()

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

isSuccessMessagesPresent

boolean isSuccessMessagesPresent()

Indicates whether or not any success messags are present.

isTableAction

boolean isTableAction()

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

isTableLink

boolean isTableLink()

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

isValidationRequired

boolean isValidationRequired()

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

isWarningMessagesPresent

boolean isWarningMessagesPresent()

Whether or not any warning messages are present.