|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PluggableAction
Interface for pluggable actions.
Pluggable actions can be plugged into
views (forms) to implement business logic inside/behind them. When a
button/link with a pluggable action configured is triggered (by the user),
the view will generate an instance of the specified PluggableAction class,
initialize it with the configuration and context and call processAction on
it.
Pluggable actions may be chained (ev. with different followers
depending on whether the previuous action succeeded, failed). Every pluggable
action may modify the given actionData such that the following action will
get the modified data rather than the original data.
Field Summary | |
---|---|
static java.lang.String |
CONFIGURATION_ERROR
constant for the error message (in case of a configuration error) |
static java.lang.String |
INCONSISTENT_ERROR
constant for the error message (in case of a configuration error). |
Method Summary | |
---|---|
void |
destroy()
Called by the view when the pluggable action is no longer used. |
void |
init(PluggableActionContext context)
Initialize the pluggable action |
boolean |
processAction(PluggableActionRequest request,
PluggableActionResponse response)
Process the implemented pluggable action. |
Field Detail |
---|
static final java.lang.String INCONSISTENT_ERROR
static final java.lang.String CONFIGURATION_ERROR
Method Detail |
---|
void init(PluggableActionContext context) throws PluggableActionException
context
- context of the pluggable action
PluggableActionException
- when the action cannot be initialized
and shall not be processedboolean processAction(PluggableActionRequest request, PluggableActionResponse response) throws PluggableActionException
request
- data used to process the data. the data may be coming from
the origination view or may be modified by previous pluggable
actions
PluggableActionException
- when the processing failed due to an
unexpected errorvoid destroy()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |