public abstract class Action
extends java.lang.Object
Constructor and Description |
---|
Action()
The Constructor
|
Modifier and Type | Method and Description |
---|---|
abstract FormStatus |
cancel()
This operation cancels the Action, if possible.
|
abstract FormStatus |
execute(java.util.Dictionary<java.lang.String,java.lang.String> dictionary)
This operation executes the Action based on the information provided in
the dictionary.
|
Form |
getForm()
This operation retrieves a Form from the Action that is used to request
additional, unexpected information from the user such as a login username
and password.
|
FormStatus |
getStatus()
This operation returns the current status of the Action.
|
FormStatus |
submitForm(Form form)
This operation submits a Form to the Action that contains additional,
unexpected information from the user such as a login username and
password.
|
public Form getForm()
This operation retrieves a Form from the Action that is used to request additional, unexpected information from the user such as a login username and password.
The second Form created by the Action for retrieving, for example, a username and password.
public FormStatus submitForm(Form form)
This operation submits a Form to the Action that contains additional, unexpected information from the user such as a login username and password. This Form was originally created by the Action and posted by the calling Item.
form
- The second Form created by the Action for retrieving, for example, a username and password.
The ItemStatus value that specifies whether or not the secondary Form was accepted by the Action. By default it is FormStatus.Processing for any non-null Form and FormStatus.InfoError otherwise.
public abstract FormStatus execute(java.util.Dictionary<java.lang.String,java.lang.String> dictionary)
This operation executes the Action based on the information provided in the dictionary. Subclasses must implement this operation and should publish the exact keys and values that they require to perform their function in their documentation.
dictionary
- A dictionary that contains key-value pairs used by the action to perform its function.
The status of the Action.
public abstract FormStatus cancel()
This operation cancels the Action, if possible.
The ItemStatus value that specifies whether or not the Action was canceled successfully.
public FormStatus getStatus()
This operation returns the current status of the Action.
The status