fr.liglab.adele.icasa.commands

Interface ICasaCommand

All Known Implementing Classes:

AbstractCommand

public interface ICasaCommand

An ICasaCommand defines the interface of service providing iCasa commands that can be executed with a set of arguments.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_NAMESPACE Default value for PROP_COMMAND_NAMESPACE
static String	PROP_DESCRIPTION
static String	PROP_NAME

Method Summary

Methods

Modifier and Type	Method and Description
Object	execute(InputStream in, PrintStream out, org.json.JSONObject param) Execute a block of code and then returns the result from execution.
String	getDescription() Get the command description.
String	getName() Get the name of the Script and command gogo.
Signature	getSignature(int size) Get signature by passing the number of arguments..
boolean	validate(org.json.JSONObject param, Signature signature) To validate the given parameters.

Field Detail

DEFAULT_NAMESPACE

static final String DEFAULT_NAMESPACE

Default value for PROP_COMMAND_NAMESPACE

See Also:

Constant Field Values

PROP_NAME

static final String PROP_NAME

See Also:

Constant Field Values

PROP_DESCRIPTION

static final String PROP_DESCRIPTION

See Also:

Constant Field Values

Method Detail

execute

Object execute(InputStream in,
             PrintStream out,
             org.json.JSONObject param)
               throws Exception

Execute a block of code and then returns the result from execution. This method should use in and out stream to print result instead of the direct use of System.in and System.out

Parameters:

in - : the input stream.

out - : the output stream.

param - a json object of parameters

Returns:

the result from the execution

Throws:

Exception - if anything goes wrong

validate

boolean validate(org.json.JSONObject param,
               Signature signature)
                 throws Exception

To validate the given parameters.

Parameters:

param - The parameters in JSON format

Returns:

true if parameters are valid, false if not.

Throws:

Exception

getDescription

String getDescription()

Get the command description.

Returns:

The description of the Script and command gogo.

getName

String getName()

Get the name of the Script and command gogo.

Returns:

The command name.

getSignature

Signature getSignature(int size)

Get signature by passing the number of arguments..

Returns: