org.xwiki.action

Interface Action

All Superinterfaces:

Comparable<Action>

All Known Implementing Classes:

AbstractAction

@Role
@Unstable
public interface Action
extends Comparable<Action>

Executes a given Resource.

Since:

6.0M1

Version:

$Id: 199a78e5fe834782b657e22e06f836310bf1f55d $

Method Summary

Methods

Modifier and Type	Method and Description
void	execute(Resource resource, ActionChain chain) Executes the Action on the passed Resource.
int	getPriority() The priority of execution relative to the other Actions.
List<ActionId>	getSupportedActionIds()

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getPriority

int getPriority()

The priority of execution relative to the other Actions. The lowest values have the highest priorities and execute first. For example a Action with a priority of 100 will execute before one with a priority of 500.

Returns:

the execution priority

getSupportedActionIds

List<ActionId> getSupportedActionIds()

Returns:

the list of Action Ids supported by this Action

execute

void execute(Resource resource,
           ActionChain chain)
             throws ActionException

Executes the Action on the passed Resource.

Parameters:

resource - the Resource on which to execute the Action

chain - the Action execution chain, needed to tell the next Action in the chain to execute (similar to the Filter Chain in the Servlet API)

Throws:

ActionException - if an error happens during the Action execution