org.openksavi.sponge.engine

Interface ActionManager

All Superinterfaces:

Descriptive, EngineModule, HasEngine, Manageable

public interface ActionManager
extends EngineModule

Action Manager.

Method Summary

Modifier and Type	Method and Description
void	addAction(ActionAdapter actionAdapter) Adds a new action adapter.
Object	callAction(ActionAdapter actionAdapter, List<Object> args) Calls the action.
Object	callAction(ActionAdapter actionAdapter, Map<String,?> args) Calls the action with named arguments.
Object	callAction(String actionName, List<Object> args) Calls the action.
Object	callAction(String actionName, Map<String,?> args) Calls the action with named arguments.
ValueHolder<Object>	callActionIfExists(String actionName, List<Object> args) Calls the action if it exists.
ValueHolder<Object>	callActionIfExists(String actionName, Map<String,?> args) Calls the action with named arguments if it exists.
ActionAdapter	getActionAdapter(String actionName) Returns an action adapter or null if action named actionName doesn't exist.
List<ActionAdapter>	getActionAdapters(String knowledgeBaseRegexp, String actionNameRegexp) Returns action adapters matching the knowledge base name and the action name regular expressions.
Map<String,ActionAdapter>	getRegisteredActionAdapterMap() Returns registered processor adapter map.
boolean	hasAction(String name) Returns true if an action named name is registered.
void	removeAction(String actionName) Removes the action adapter.

Methods inherited from interface org.openksavi.sponge.util.Manageable

isFailed, isNew, isRunning, isStarting, isStopping, isTerminated, shutdown, startup

Methods inherited from interface org.openksavi.sponge.util.Descriptive

getDescription, getLabel, getName, setDescription, setLabel, setName

Methods inherited from interface org.openksavi.sponge.util.HasEngine

getEngine, setEngine

Method Detail

addAction

void addAction(ActionAdapter actionAdapter)

Adds a new action adapter.

Parameters:

actionAdapter - a new action adapter.

removeAction

void removeAction(String actionName)

Removes the action adapter.

Parameters:

actionName - the name of the action adapter.

callAction

Object callAction(String actionName,
                  List<Object> args)

Calls the action. Throws ProcessorNotFoundException if the action is not registered.

Parameters:

actionName - the name of the registered action.

args - the arguments for the action call. This parameter may be null and in that case no arguments will be passed to the action.

Returns:

the result of executing the action.

callAction

Object callAction(ActionAdapter actionAdapter,
                  List<Object> args)

Calls the action. Throws ProcessorNotFoundException if the action is not registered.

Parameters:

actionAdapter - the action adapter.

args - the arguments for the action call. This parameter may be null and in that case no arguments will be passed to the action.

Returns:

the result of executing the action.

callAction

Object callAction(String actionName,
                  Map<String,?> args)

Calls the action with named arguments. Throws ProcessorNotFoundException if the action is not registered.

Parameters:

actionName - the name of the registered action.

args - the arguments for the action call. This parameter may be null and in that case no arguments will be passed to the action.

Returns:

the result of executing the action.

callAction

Object callAction(ActionAdapter actionAdapter,
                  Map<String,?> args)

Calls the action with named arguments. Throws ProcessorNotFoundException if the action is not registered.

Parameters:

actionAdapter - the action adapter.

args - the arguments for the action call. This parameter may be null and in that case no arguments will be passed to the action.

Returns:

the result of executing the action.

callActionIfExists

ValueHolder<Object> callActionIfExists(String actionName,
                                       List<Object> args)

Calls the action if it exists.

Parameters:

actionName - the name of the registered action.

args - the arguments for the action call. This parameter may be null and in that case no arguments will be passed to the action.

Returns:

the action result wrapped in a value holder or null if the action is not registered.

callActionIfExists

ValueHolder<Object> callActionIfExists(String actionName,
                                       Map<String,?> args)

Calls the action with named arguments if it exists.

Parameters:

actionName - the name of the registered action.

args - the arguments for the action call. This parameter may be null and in that case no arguments will be passed to the action.

Returns:

the action result wrapped in a value holder or null if the action is not registered.

getRegisteredActionAdapterMap

Map<String,ActionAdapter> getRegisteredActionAdapterMap()

Returns registered processor adapter map.

Returns:

registered processor adapter map.

hasAction

boolean hasAction(String name)

Returns true if an action named name is registered.

Parameters:

name - action name.

Returns:

true if an action named name is registered.

getActionAdapter

ActionAdapter getActionAdapter(String actionName)

Returns an action adapter or null if action named actionName doesn't exist.

Parameters:

actionName - action name.

Returns:

an action adapter.

getActionAdapters

List<ActionAdapter> getActionAdapters(String knowledgeBaseRegexp,
                                      String actionNameRegexp)

Returns action adapters matching the knowledge base name and the action name regular expressions. A null value of the regular expression means that it will match any name.

Parameters:

knowledgeBaseRegexp - knowledge base name regular expression.

actionNameRegexp - action name regular expression.

Returns:

action adapters.