org.openksavi.sponge.action

Interface ActionMeta

All Superinterfaces:

Descriptive, HasFeatures, HasVersion, ProcessorMeta

public interface ActionMeta
extends ProcessorMeta

An action metadata.

Method Summary

Modifier and Type	Method and Description
void	addArgs(List<DataType> args) Adds the (optional) argument type.
DataType	getArg(String name) Returns the argument type.
List<DataType>	getArgs() Returns the argument types or null in not specified.
DataType	getResult() Returns the result type or null in not specified.
boolean	hasArg(String name) Tells if an argument named name exists.
boolean	isActivatable() Tells if this action is activatable.
boolean	isCallable() Tells if this action is callable.
void	setActivatable(boolean activatable) Sets the activatable flag.
void	setArgs(List<DataType> args) Sets the (optional) argument types.
void	setCallable(boolean callable) Sets the callable flag.
void	setResult(DataType result) Sets the (optional) result type.

Methods inherited from interface org.openksavi.sponge.ProcessorMeta

getCategory, setCategory

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

getDescription, getLabel, getName, setDescription, setLabel, setName

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

getVersion, setVersion

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

getFeatures, setFeatures

Method Detail

getArgs

List<DataType> getArgs()

Returns the argument types or null in not specified.

Returns:

the argument types.

setArgs

void setArgs(List<DataType> args)

Sets the (optional) argument types.

Parameters:

args - the argument types.

addArgs

void addArgs(List<DataType> args)

Adds the (optional) argument type.

Parameters:

args - the argument type.

getArg

DataType getArg(String name)

Returns the argument type. Throws exception if not found. Supports sub-arguments specified using the dot notation.

Parameters:

name - the argument name.

Returns:

the argument type.

hasArg

boolean hasArg(String name)

Tells if an argument named name exists.

Returns:

true if an argument named name exists.

getResult

DataType getResult()

Returns the result type or null in not specified.

Returns:

the result type.

setResult

void setResult(DataType result)

Sets the (optional) result type.

Parameters:

result - the result type.

isCallable

boolean isCallable()

Tells if this action is callable. A callable action must have an onCall method defined. Defaults to true.

Returns:

true if this action is callable.

setCallable

void setCallable(boolean callable)

Sets the callable flag.

Parameters:

callable - the callable flag.

isActivatable

boolean isActivatable()

Tells if this action is activatable. If true, the action should have the onIsActive callback method implemented. Defaults to false.

Returns:

true if this action is activatable.

setActivatable

void setActivatable(boolean activatable)

Sets the activatable flag.

Parameters:

activatable - the activatable flag.