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(String actionName, List<Object> args) Calls the action.
boolean	existsAction(String name) Returns true if an action named name 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.
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, getDisplayName, getName, setDescription, setDisplayName, 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 when such action is not registered.

Parameters:

actionName - name of registered action.

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

Returns:

result of executing action.

getRegisteredActionAdapterMap

Map<String,ActionAdapter> getRegisteredActionAdapterMap()

Returns registered processor adapter map.

Returns:

registered processor adapter map.

existsAction

boolean existsAction(String name)

Returns true if an action named name exists.

Parameters:

name - action name.

Returns:

true if an action named name exists.

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.