info.magnolia.ui.api.action

Interface ActionExecutor

All Known Implementing Classes:

AbstractActionExecutor, ActionExecutor.Noop, DialogActionExecutor, FormToolActionExecutor, MediaEditorActionExecutor, PulseDetailActionExecutor, PulseListActionExecutor, SubAppActionExecutor, UserActionExecutor, UserActionExecutor

public interface ActionExecutor

Responsible for executing actions, doing lookups of action definitions based on action names and evaluating if an action is available. Creates a new instance of the action for each execution and allows the action to receive its action definition object and all parameters given through injection as it is created.

See Also:

Action, ActionDefinition

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ActionExecutor.Noop Action executor implementation that does nothing.

Method Summary

Modifier and Type	Method and Description
void	execute(String actionName, Object... args) Creates a new instance of the action for the supplied name and executes it.
ActionDefinition	getActionDefinition(String actionName) Performs a lookup for an action definition by name.

Method Detail

execute

void execute(String actionName,
             Object... args)
      throws ActionExecutionException

Creates a new instance of the action for the supplied name and executes it. The arguments passed here along with the action definition are made available to the action instance using injection.

Throws:

ActionExecutionException - if the action encounters a problem during execution or if no action definition matches the name

getActionDefinition

ActionDefinition getActionDefinition(String actionName)

Performs a lookup for an action definition by name.

Returns:

the action definition for the supplied action name or null if not found