StrutsAction (AndroMDA BPM4Struts Cartridge 3.5-SNAPSHOT API)

All Superinterfaces:

FrontEndForward, ModelElementFacade, StrutsForward, TransitionFacade

All Known Implementing Classes:

StrutsActionLogic, StrutsActionLogicImpl
```
public interface StrutsAction
extends StrutsForward
```
Represents a Struts action. Such an action typically is associated with a form bean. This action model element extends a transition, but the actual logic contained by the action envelops all action states called, until either a final state or JSP page is reached. Metafacade interface to be used by AndroMDA cartridges.

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getActionClassName()` A good Java class name for this action.
`List<StrutsExceptionHandler>`	`getActionExceptions()` Returns all exception handlers for this action.
`List<StrutsParameter>`	`getActionFormFields()` Returns all form fields for this action.
`List<StrutsForward>`	`getActionForwards()` Returns all action forwards for this action.
`String`	`getActionInput()` The action input corresponding to this action, as found in the struts deployment descriptor.
`String`	`getActionName()` The action name corresponding to this action, as found in the struts deployment descriptor.
`List<StrutsParameter>`	`getActionParameters()` Returns all parameters transported in this action.
`String`	`getActionPath()` Tthe action path corresponding to this action, as found in the struts deployment descriptor.
`String`	`getActionPathRoot()` The root of the action path, this is the same as the path for the use-case context for this action, that is, the use-case holding the activity graph in which this action is contained.
`String`	`getActionRoles()` The action roles corresponding to this action, as found in the struts deployment descriptor.
`String`	`getActionScope()` The scope in which the form bean will be placed (could be page, request, session or application).
`List<StrutsActionState>`	`getActionStates()` Returns all action states visited by this action.
`StrutsTrigger`	`getActionTrigger()` Returns the trigger that calls this action.
`String`	`getActionType()` The fully qualified name for the action class.
`StrutsController`	`getController()` Returns the controller that will handle the execution of this action.
`List<StrutsForward>`	`getDecisionTransitions()` Returns all the transitions coming out of decision points.
`List<StrutsControllerOperation>`	`getDeferredOperations()` The controller operations to which this action defers, the order is preserved.
`String`	`getDocumentationKey()` A key suited as a resource message key for the documentation for this action.
`String`	`getDocumentationValue()` The documentation for this action as a String that can be used as a resource message (with the backslashes at the end of the line).
`String`	`getFormBeanClassName()` Returns the class name of the form bean associated to this action.
`String`	`getFormBeanName()` The name of the form bean associated to this action.
`String`	`getFormBeanPackageName()` The package for the form bean.
`String`	`getFormBeanType()` The fully qualified name of the form bean associated to this action.
`String`	`getFormScope()` The scope to place the current "form" variable within when this action is executing.
`String`	`getFormValidationMethodName()` The Javascript function name of the validation method that will validate the action parameters.
`String`	`getFullActionPath()` The full path for this action.
`String`	`getFullFormBeanPath()` Returns the full path for the form bean associated to this action.
`String`	`getFullTilePath()` The name of a file that can be used as a JSP file name in case you want to have each action rendered onto a different tile.
`List<StrutsParameter>`	`getHiddenActionParameters()` All action parameters that represent 'hidden' widgets.
`String`	`getImageMessageKey()` The resource message key used to look to location of the image for this action.
`String`	`getImagePath()` If this action is an imageLink this property represents the path to the corresponding image.
`StrutsJsp`	`getInput()` The jsp on which this action can be triggered.
`List`	`getInterUseCaseParameters(StrutsFinalState finalState)` Those parameters that are directly entering a final state and have been submitted into the request, they will be able to survive a trip to the next use-case.
`String`	`getMessageKey()` TODO: Model Documentation for org.andromda.cartridges.bpm4struts.metafacades.StrutsAction.messageKey
`String`	`getOnlineHelpKey()` The key to lookup the online help documentation.
`String`	`getOnlineHelpValue()` The online help documentation.
`List<StrutsParameter>`	`getResettableActionParameters()` Gets all those parameters that should be reset after action execution.
`String`	`getStyleId()` The name of the CSS id in which this action will be contained.
`String`	`getTableLinkColumnName()` The name of the column targetted by this action.
`String`	`getTableLinkName()` The name of the table link specified for this action.
`StrutsParameter`	`getTableLinkParameter()` If the action is a table link then this property represents the table to which is being linked.
`List<StrutsParameter>`	`getTableNonColumnFormParameters()` This table action's parameters not mapped to any table column.
`List<StrutsJsp>`	`getTargetPages()` The set of pages that are a possible target of the triggering of this action.
`List<StrutsForward>`	`getTransitions()` All the transitions that make up this action, this directly maps onto the forwards.
`boolean`	`isCalendarRequired()` True if this action contains a parameter which requires a calendar popup.
`boolean`	`isDateFieldPresent()` True if this action contains a parameter of type Date.
`boolean`	`isFormPost()` Specifies whether or not this action is represented by the posting of a form.
`boolean`	`isFormScopeNone()` Indicates if the form scope is of type "none".
`boolean`	`isFormScopeRequest()` Indicates if the from scope is of type "request".
`boolean`	`isFormScopeSession()` Indicates if the form scope is of type "session".
`boolean`	`isHyperlink()` Specifies whether or not this action is represented by clicking on a hyperlink.
`boolean`	`isImageLink()` Specifies whether or not this action is represented by clicking on an image.
`boolean`	`isMultipartFormData()` True is this action is supposed to be rendered as enctype="multipart/form-data" on the page form.
`boolean`	`isRedirect()` Defines whether or not when this action's forward is executed, an HTTP redirect should occur.
`boolean`	`isResettable()` True if it should be possible to reset the form represented by this action.
`boolean`	`isStrutsActionMetaType()` Indicates the metafacade type (used for metafacade mappings).
`boolean`	`isTableAction()` Denotes this action works on all rows of the table from the table link relation.
`boolean`	`isTableLink()` True if a table link name has been specified and it properly targets a table page-variable from the input page.
`boolean`	`isTableRowAction()` Denotes this action works on a single row of the table from the table link relation.
`boolean`	`isUseCaseStart()` True if this action starts the use-case.
`boolean`	`isValidationRequired()` True if this action requires validation, false otherwise.

Methods inherited from interface org.andromda.cartridges.bpm4struts.metafacades.StrutsForward
getForwardName, getForwardPath, getGuardName, getStrutsActivityGraph, getSuccessMessages, getTargetNameKey, getWarningMessages, isEnteringPage, isExitingPage, isStrutsForwardMetaType, isSuccessMessagesPresent, isWarningMessagesPresent

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
  - isStrutsActionMetaType
```
boolean isStrutsActionMetaType()
```
    Indicates the metafacade type (used for metafacade mappings).
    
    Returns:
    boolean always true
  - getActionClassName
```
String getActionClassName()
```
    A good Java class name for this action. The name is constructed from the source page and the name of the trigger.
    
    Returns:
    String
  - getActionExceptions
```
List<StrutsExceptionHandler> getActionExceptions()
```
    Returns all exception handlers for this action.
    
    Returns:
    List
  - getActionFormFields
```
List<StrutsParameter> getActionFormFields()
```
    Returns all form fields for this action. Form fields are those parameters that can be altered by the user at runtime.
    
    Returns:
    List
  - getActionForwards
```
List<StrutsForward> getActionForwards()
```
    Returns all action forwards for this action. Each action forward either calls a JSP page or another use-case (which is essentially an action).
    
    Returns:
    List
  - getActionInput
```
String getActionInput()
```
    The action input corresponding to this action, as found in the struts deployment descriptor. The action input maps the action to the page on which it originated.
    
    Returns:
    String
  - getActionName
```
String getActionName()
```
    The action name corresponding to this action, as found in the struts deployment descriptor. The action name maps the action to a form bean.
    
    Returns:
    String
  - getActionParameters
```
List<StrutsParameter> getActionParameters()
```
    Returns all parameters transported in this action.
    
    Returns:
    List
  - getActionPath
```
String getActionPath()
```
    Tthe action path corresponding to this action, as found in the struts deployment descriptor. The action path specifies the URL to enter in order to call the action.
    
    Returns:
    String
  - getActionPathRoot
```
String getActionPathRoot()
```
    The root of the action path, this is the same as the path for the use-case context for this action, that is, the use-case holding the activity graph in which this action is contained.
    
    Returns:
    String
  - getActionRoles
```
String getActionRoles()
```
    The action roles corresponding to this action, as found in the struts deployment descriptor. The action roles specifiy the roles in which the user must be in order to be authorized to call the action. One of the roles must be satisfied.
    
    Returns:
    String
  - getActionScope
```
String getActionScope()
```
    The scope in which the form bean will be placed (could be page, request, session or application).
    
    Returns:
    String
  - getActionStates
```
List<StrutsActionState> getActionStates()
```
    Returns all action states visited by this action.
    
    Returns:
    List
  - getActionTrigger
```
StrutsTrigger getActionTrigger()
```
    Returns the trigger that calls this action. Typically this is a button or an hyperlink.
    
    Returns:
    StrutsTrigger
  - getActionType
```
String getActionType()
```
    The fully qualified name for the action class.
    
    Returns:
    String
  - getController
```
StrutsController getController()
```
    Returns the controller that will handle the execution of this action. This controller is set as the context of the activity graph (and therefore also of the use-case).
    
    Returns:
    StrutsController
  - getDecisionTransitions
```
List<StrutsForward> getDecisionTransitions()
```
    Returns all the transitions coming out of decision points. These transitions should all carry guards.
    
    Returns:
    List
  - getDeferredOperations
```
List<StrutsControllerOperation> getDeferredOperations()
```
    The controller operations to which this action defers, the order is preserved.
    
    Returns:
    List
  - getDocumentationKey
```
String getDocumentationKey()
```
    A key suited as a resource message key for the documentation for this action.
    
    Returns:
    String
  - getDocumentationValue
```
String getDocumentationValue()
```
    The documentation for this action as a String that can be used as a resource message (with the backslashes at the end of the line).
    
    Returns:
    String
  - getFormBeanClassName
```
String getFormBeanClassName()
```
    Returns the class name of the form bean associated to this action.
    
    Returns:
    String
  - getFormBeanName
```
String getFormBeanName()
```
    The name of the form bean associated to this action. The name is returned as it should appear in the Struts deployment descriptor.
    
    Returns:
    String
  - getFormBeanPackageName
```
String getFormBeanPackageName()
```
    The package for the form bean.
    
    Returns:
    String
  - getFormBeanType
```
String getFormBeanType()
```
    The fully qualified name of the form bean associated to this action.
    
    Returns:
    String
  - getFormScope
```
String getFormScope()
```
    The scope to place the current "form" variable within when this action is executing.
    
    Returns:
    String
  - getFormValidationMethodName
```
String getFormValidationMethodName()
```
    The Javascript function name of the validation method that will validate the action parameters.
    
    Returns:
    String
  - getFullActionPath
```
String getFullActionPath()
```
    The full path for this action. The full path also contains the package name rendered as directories.
    
    Returns:
    String
  - getFullFormBeanPath
```
String getFullFormBeanPath()
```
    Returns the full path for the form bean associated to this action.
    
    Returns:
    String
  - getFullTilePath
```
String getFullTilePath()
```
    The name of a file that can be used as a JSP file name in case you want to have each action rendered onto a different tile.
    
    Returns:
    String
  - getHiddenActionParameters
```
List<StrutsParameter> getHiddenActionParameters()
```
    All action parameters that represent 'hidden' widgets.
    
    Returns:
    List
  - getImageMessageKey
```
String getImageMessageKey()
```
    The resource message key used to look to location of the image for this action.
    
    Returns:
    String
  - getImagePath
```
String getImagePath()
```
    If this action is an imageLink this property represents the path to the corresponding image.
    
    Returns:
    String
  - getInput
```
StrutsJsp getInput()
```
    The jsp on which this action can be triggered.
    
    Returns:
    StrutsJsp
  - getInterUseCaseParameters
```
List getInterUseCaseParameters(StrutsFinalState finalState)
```
    Those parameters that are directly entering a final state and have been submitted into the request, they will be able to survive a trip to the next use-case. All returned elements are of type StrutsParameter.
    
    Parameters:
    finalState - StrutsFinalState
    
    Returns:
    List
  - getMessageKey
```
String getMessageKey()
```
    TODO: Model Documentation for org.andromda.cartridges.bpm4struts.metafacades.StrutsAction.messageKey
    
    Returns:
    String
  - getOnlineHelpKey
```
String getOnlineHelpKey()
```
    The key to lookup the online help documentation. This documentation is gathered from the documentation entered by the user, as well as analyzing the model.
    
    Returns:
    String
  - getOnlineHelpValue
```
String getOnlineHelpValue()
```
    The online help documentation. This documentation is gathered from the documentation entered by the user, as well as analyzing the model. The format is HTML without any style.
    
    Returns:
    String
  - getResettableActionParameters
```
List<StrutsParameter> getResettableActionParameters()
```
    Gets all those parameters that should be reset after action execution.
    
    Returns:
    List
  - getStyleId
```
String getStyleId()
```
    The name of the CSS id in which this action will be contained.
    
    Returns:
    String
  - 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
```
StrutsParameter getTableLinkParameter()
```
    If the action is a table link then this property represents the table to which is being linked.
    
    Returns:
    StrutsParameter
  - getTableNonColumnFormParameters
```
List<StrutsParameter> getTableNonColumnFormParameters()
```
    This table action's parameters not mapped to any table column. Only makes sense when this is a table form action.
    
    Returns:
    List
  - getTargetPages
```
List<StrutsJsp> getTargetPages()
```
    The set of pages that are a possible target of the triggering of this action.
    
    Returns:
    List
  - getTransitions
```
List<StrutsForward> getTransitions()
```
    All the transitions that make up this action, this directly maps onto the forwards.
    
    Returns:
    List
  - isCalendarRequired
```
boolean isCalendarRequired()
```
    True if this action contains a parameter which requires a calendar popup.
    
    Returns:
    boolean
  - isDateFieldPresent
```
boolean isDateFieldPresent()
```
    True if this action contains a parameter of type Date. The generated pages will contain special javascript code to handle them (popup window etc...).
    
    Returns:
    boolean
  - isFormPost
```
boolean isFormPost()
```
    Specifies whether or not this action is represented by the posting of a form.
    
    Returns:
    boolean
  - isFormScopeNone
```
boolean isFormScopeNone()
```
    Indicates if the form scope is of type "none".
    
    Returns:
    boolean
  - isFormScopeRequest
```
boolean isFormScopeRequest()
```
    Indicates if the from scope is of type "request".
    
    Returns:
    boolean
  - isFormScopeSession
```
boolean isFormScopeSession()
```
    Indicates if the form scope is of type "session".
    
    Returns:
    boolean
  - isHyperlink
```
boolean isHyperlink()
```
    Specifies whether or not this action is represented by clicking on a hyperlink.
    
    Returns:
    boolean
  - isImageLink
```
boolean isImageLink()
```
    Specifies whether or not this action is represented by clicking on an image.
    
    Returns:
    boolean
  - isMultipartFormData
```
boolean isMultipartFormData()
```
    True is this action is supposed to be rendered as enctype="multipart/form-data" on the page form.
    
    Returns:
    boolean
  - isRedirect
```
boolean isRedirect()
```
    Defines whether or not when this action's forward is executed, an HTTP redirect should occur. Default value is based on the value of the 'defaultActionRedirect' namespace.
    
    Returns:
    boolean
  - isResettable
```
boolean isResettable()
```
    True if it should be possible to reset the form represented by this action. False otherwise.
    
    Returns:
    boolean
  - isTableAction
```
boolean isTableAction()
```
    Denotes this action works on all rows of the table from the table link relation.
    
    Returns:
    boolean
  - isTableLink
```
boolean isTableLink()
```
    True if a table link name has been specified and it properly targets a table page-variable from the input page.
    
    Returns:
    boolean
  - isTableRowAction
```
boolean isTableRowAction()
```
    Denotes this action works on a single row of the table from the table link relation.
    
    Returns:
    boolean
  - isUseCaseStart
```
boolean isUseCaseStart()
```
    True if this action starts the use-case. False otherwise.
    
    Returns:
    boolean
  - isValidationRequired
```
boolean isValidationRequired()
```
    True if this action requires validation, false otherwise. An action requires validation if it represented by a form and one or more fields require validation.
    
    Returns:
    boolean

Interface StrutsAction

Method Summary

Methods inherited from interface org.andromda.cartridges.bpm4struts.metafacades.StrutsForward

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

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

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

Method Detail

isStrutsActionMetaType

getActionClassName

getActionExceptions

getActionFormFields

getActionForwards

getActionInput

getActionName

getActionParameters

getActionPath

getActionPathRoot

getActionRoles

getActionScope

getActionStates

getActionTrigger

getActionType

getController

getDecisionTransitions

getDeferredOperations

getDocumentationKey

getDocumentationValue

getFormBeanClassName

getFormBeanName

getFormBeanPackageName

getFormBeanType

getFormScope

getFormValidationMethodName

getFullActionPath

getFullFormBeanPath

getFullTilePath

getHiddenActionParameters

getImageMessageKey

getImagePath

getInput

getInterUseCaseParameters

getMessageKey

getOnlineHelpKey

getOnlineHelpValue

getResettableActionParameters

getStyleId

getTableLinkColumnName

getTableLinkName

getTableLinkParameter

getTableNonColumnFormParameters

getTargetPages

getTransitions

isCalendarRequired

isDateFieldPresent

isFormPost

isFormScopeNone

isFormScopeRequest

isFormScopeSession

isHyperlink

isImageLink

isMultipartFormData

isRedirect

isResettable

isTableAction

isTableLink

isTableRowAction

isUseCaseStart

isValidationRequired