org.openksavi.sponge.action

Interface Action

All Superinterfaces:

ActionOperations, Descriptive, Processor<ActionAdapter>, ProcessorOperations

public interface Action
extends Processor<ActionAdapter>, ActionOperations

Action. Every action should implement at least one onCall method that performs an operation and returns a result. For example: Object onCall(Number value, String text).

Method Summary

Modifier and Type	Method and Description
void	onProvideArgs(Set<String> names, Map<String,Object> current, Map<String,ArgValue<?>> provided) A callback method that returns the provided argument values along with argument value sets (i.e.

Methods inherited from interface org.openksavi.sponge.Processor

getAdapter, getLogger, onConfigure, onInit

Methods inherited from interface org.openksavi.sponge.action.ActionOperations

getArgsMeta, getResultMeta, setArgsMeta, setResultMeta

Methods inherited from interface org.openksavi.sponge.ProcessorOperations

getFeatures, getKnowledgeBase, setFeatures

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

getDescription, getDisplayName, getName, setDescription, setDisplayName, setName

Method Detail

onProvideArgs

void onProvideArgs(Set<String> names,
                   Map<String,Object> current,
                   Map<String,ArgValue<?>> provided)

A callback method that returns the provided argument values along with argument value sets (i.e. possible values of an argument).

Parameters:

names - the not null set of argument names that are to be provided.

current - the not null map of argument names and their current values passed from a client code. The map is required to contain values of those arguments that the arguments specified in the names depend on.

provided - the initially empty map of argument names and values (value sets) that is to be set up in this callback method.