WebWork
| java.lang.Object | |
| ↳ | webwork.action.ActionSupport |
 Known Direct Subclasses
|
|
Known Indirect Subclasses
|
This is a useful base class for WebWork Action implementations. It gives you access to a set of useful functionality, including result view mapping, error handling, and i18n.
It is also possible to use this class by way of delegation instead of subclassing. This is useful in the case that your action cannot use subclassing to add functionality|
[Expand]
Inherited Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From interface
webwork.action.Action
| |||||||||||
| Fields | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| command | |||||||||||
| errorMap | |||||||||||
| errorMessages | |||||||||||
| log | |||||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
This method is used to attach an error message to a particular form field.
| |||||||||||
Add an error message to this action
| |||||||||||
"default" command
| |||||||||||
Execute will first check the request for a result exception.
| |||||||||||
Get the list of error messages for this action
| |||||||||||
Get the field specific errors associated with this action.
| |||||||||||
Check whether there are any error messages
| |||||||||||
Check whether there are any errors associated with this action.
| |||||||||||
Get the locale for this action.
| |||||||||||
Get a text from the resource bundles associated with this action.
| |||||||||||
Get the resource bundle associated with this action.
| |||||||||||
Get the named bundle.
| |||||||||||
Get the user's timezone for date/time formatting in text tag.
| |||||||||||
Check whether there are any error messages.
| |||||||||||
Detect whether a particular command has been issued
| |||||||||||
Support implementation of CommandDriven interface.
| |||||||||||
| Protected Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Subclasses may override this method to provide validation of input data.
| |||||||||||
This is used to get the current action's class name
| |||||||||||
This method is called from addIllegalArgumentException and it should return an error message (that may be
localized).
| |||||||||||
Invokes an alternate execution path for the action.
| |||||||||||
Do validation.
| |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From class
java.lang.Object
| |||||||||||
|
From interface
webwork.action.Action
| |||||||||||
|
From interface
webwork.action.IllegalArgumentAware
| |||||||||||
This method is used to attach an error message to a particular form field.
| fieldName | name of field |
|---|---|
| errorMessage | the error message |
Execute will first check the request for a result exception. If one is found, then it will add its message as an error message and throw the ResultException. If there no exception is found, then it will invoke the "command" - invokeCommand(). If we are not invoking a command, it will call validate() and then doExecute().
| Exception |
|---|
Get the list of error messages for this action
Get the field specific errors associated with this action.
Check whether there are any error messages
Check whether there are any errors associated with this action.
Get the locale for this action.
Applications may customize how locale is chosen by subclassing ActionSupport and override this method.Get a text from the resource bundles associated with this action. The resource bundles are searched, starting with the one associated with this particular action, and testing all its superclasses' bundles. It will stop once a bundle is found that contains the given text. This gives a cascading style that allow global texts to be defined for an application base class.
| aTextName | name of text to be found |
|---|
Get the resource bundle associated with this action. This will be based on the actual subclass that is used.
Get the named bundle.
You can override the getLocale() method to change the behaviour of how to choose locale for the bundles that are returned. Typically you would use the LocaleAware interface to get the users configured locale, or use your own method to allow the user to select the locale and store it in the session (by using the SessionAware interface).| aBundleName | bundle name |
|---|
Get the user's timezone for date/time formatting in text tag.
Check whether there are any error messages. Just a nicer way of doing "getHasErrorMessages() || getHasErrors()".
Support implementation of CommandDriven interface. Let your action subclasses implement CommandDriven if they support this notion.
Subclasses may override this method to provide validation of input data. The execute() method should call validate() in the beginning of its code (which will delegate to this method), so as to check input data before doing the actual processing.
If any application errors arise these should be registered by calling addErrorMessage or addError . If the validation is dependent on whether a command has been issued, and what that command is, then the isCommand() method should be used.This method is called from addIllegalArgumentException and it should return an error message (that may be localized). The implementation here does this by calling the getText method but you may override it with your own implementation. The default messages are stored in the ActionSupport.properties file
Invokes an alternate execution path for the action. The name of the action is derived by prepending a "do" and capitalizing the first letter of the action.
| Exception |
|---|
Do validation. This method is called implicitly before executing doExecute(), but must be called explicitly from within command implementation methods. The actual validation should be done by overriding the doValidation() method. If any errors have been registered by doValidation() this method will throw ResultException() which should simply be passed through.
| ResultException |
|---|