public interface

Action

implements Serializable
webwork.action.Action
Known Indirect Subclasses

Class Overview

All Actions must minimally implement this interface. It provides the execute method, which is done by actions to perform whatever their purpose is.

See Also

Summary

Constants
String ERROR The action execution was a failure.
String INPUT The action execution require more input in order to succeed.
String LOGIN The action could not execute, since the user most was not logged in.
String NONE The action execution was successful but do not show a view.
String SUCCESS The action execution was successful.
Public Methods
String execute()
This method is where the logic of the action is executed.

Constants

public static final String ERROR

The action execution was a failure. Show an error view, possibly asking the user to retry entering data.

Constant Value: "error"

public static final String INPUT

The action execution require more input in order to succeed. This result is typically used if a form handling action has been executed so as to provide defaults for a form. The form associated with the handler should be shown to the end user.

This result is also used if the given input parameters are invalid, meaning the user should try providing input again.
Constant Value: "input"

public static final String LOGIN

The action could not execute, since the user most was not logged in. The login view should be shown.

Constant Value: "login"

public static final String NONE

The action execution was successful but do not show a view. This is useful for actions that are handling the view in another fashion like redirect.

Constant Value: "none"

public static final String SUCCESS

The action execution was successful. Show result view to the end user.

Constant Value: "success"

Public Methods

public String execute ()

This method is where the logic of the action is executed. Parameters are passed by calling set-methods, or by implementing the ParameterAware interface.

Returns
  • a string representing the logical result of the execution. See constants in this interface for a list of standard result values.
Throws
Exception thrown if a system level exception occurs. Application level exceptions should be handled by returning an error value, such as Action.ERROR.