com.e_c_group.bwptk
Interface CommandLineable

public interface CommandLineable

A CommandLineable object describes an operation that can be called from the command line.

Method Summary

boolean	execute(java.io.PrintStream out, BroadWorksServer bws, java.lang.String[] args) Executes this command.
java.lang.String	getCommandName()
java.lang.String	getDescription()
java.lang.String[]	getParameters()

Method Detail

getCommandName

java.lang.String getCommandName()

Returns:

The name of the command that will be executed from the command line. For example, "ServiceProviderAddTelephoneNumber".

getParameters

java.lang.String[] getParameters()

Returns:

An array of parameter names. These will be shown to the user in the example usage.

getDescription

java.lang.String getDescription()

Returns:

A full text description of what the comand does.

execute

boolean execute(java.io.PrintStream out,
                BroadWorksServer bws,
                java.lang.String[] args)
                throws BwptkException

Executes this command.

Parameters:

args - is an array of the parameters passed into this command. args[0] is the command name itself. args[1] is the first parameter.

Throws:

BwptkException