org.pentaho.platform.api.action

Interface IActionInvoker

public interface IActionInvoker

The purpose of this interface is to provide functionality needed to invoke an IAction instance in a generic fashion.

Method Summary

Modifier and Type	Method and Description
IActionInvokeStatus	invokeAction(IAction action, String user, Map<String,Serializable> params) Invokes the IAction action.
boolean	isSupportedAction(IAction action) Predicate that tells whether an IActionInvoker can handle a given IAction

Method Detail

invokeAction

IActionInvokeStatus invokeAction(IAction action,
                                 String user,
                                 Map<String,Serializable> params)
                          throws Exception

Invokes the IAction action.

Parameters:

action - The IAction to be invoked

user - The user invoking the action

params - the Map or parameters needed to invoke the IAction

Returns:

the IActionInvokeStatus object containing information about the action invocation

Throws:

Exception - if the action cannot be run for some reason

isSupportedAction

boolean isSupportedAction(IAction action)

Predicate that tells whether an IActionInvoker can handle a given IAction

Parameters:

action - The IAction to be handled

Returns:

true if the IActionInvoker can handle a given IAction