com.stellent.cis.client.command
Interface ICommandFacade

public interface ICommandFacade

Entry point into the command interface. Allows for interaction with the command layer, including command retrieval, registration, and execution. Commands are referenced by name, where a name can be any string. A name consisting of the dot character (".") will be treated in a hierarchy, where the first segment is the top-level category, and the next segment is the second-level category, etc. Commands can either be retrieved by their full command name or by browsing all available commands.

Method Summary

java.lang.Object	executeCommand(ICommand command) Execute the command.
java.util.Collection	getCategories(java.lang.String category) Get a list of the sub-categories under the given category.
ICommand	getCommand(java.lang.String commandUri) Locate an ICommand object by name
ICommandAPI	getCommandAPI(java.lang.String category) Retrieve the ICommandAPI associated with the commands at a given category.
ICommandDescriptor	getCommandDescriptor(java.lang.String commandUri) Locate the ICommandDescriptor object for a given command.
java.util.Collection	getCommands(java.lang.String category) Get a list of all the commands under a given category that have the supplied API type
boolean	isLocalInvocation()
java.util.Collection	listCommands() List all of the available command names
java.util.Map	searchCommandDescriptors(java.lang.String category, java.util.Map queries, boolean isAndQuery) Search for commands descriptors matching the given query string

Method Detail

getCommand

ICommand getCommand(java.lang.String commandUri)
                    throws CommandNotFoundException,
                           CommandCreateException,
                           CommandException

Locate an ICommand object by name

Parameters:

commandUri - the URI to the command

Returns:

the ICommand object associated with this name

Throws:

CommandNotFoundException - if there was an error locating the command object

CommandCreateException - if there was an error creating/instatiating the command object

CommandException

getCommandAPI

ICommandAPI getCommandAPI(java.lang.String category)

Retrieve the ICommandAPI associated with the commands at a given category.

Parameters:

category - the command API category.

Returns:

the command API instance or null if not found

executeCommand

java.lang.Object executeCommand(ICommand command)
                                throws CommandException

Execute the command. Locates the appropiate ICommandFacade object and passes the command to that object for execution.

Parameters:

command - the populated command bean

Returns:

the command return value

Throws:

CommandException

java.rmi.RemoteException - if a network error occurs

getCommandDescriptor

ICommandDescriptor getCommandDescriptor(java.lang.String commandUri)
                                        throws CommandNotFoundException,
                                               CommandException

Locate the ICommandDescriptor object for a given command.

Parameters:

commandUri - the uri of the command

Returns:

the descriptor object which describes the command

Throws:

CommandNotFoundException

CommandException

getCommands

java.util.Collection getCommands(java.lang.String category)
                                 throws CommandException

Get a list of all the commands under a given category that have the supplied API type

Parameters:

category - the category

Returns:

a list of ICommand objects under the given category

Throws:

CommandException

getCategories

java.util.Collection getCategories(java.lang.String category)
                                   throws CommandException

Get a list of the sub-categories under the given category.

Parameters:

category - the parent category, or null for the root category

Returns:

a list of String category names

Throws:

CommandException

listCommands

java.util.Collection listCommands()
                                  throws CommandException

List all of the available command names

Returns:

a collection of the full command names available

Throws:

CommandException

isLocalInvocation

boolean isLocalInvocation()

Returns:

true if the CommandFacade implementation is executing commands locally (i.e. in the same JVM instance)

searchCommandDescriptors

java.util.Map searchCommandDescriptors(java.lang.String category,
                                       java.util.Map queries,
                                       boolean isAndQuery)
                                       throws CommandException

Search for commands descriptors matching the given query string

Parameters:

category - the name of the category to search in, or null for all categories

queries - a map of queries, matching attribute name to attribute value

isAndQuery - true to match all criteria, false to match just one

Returns:

a Map of String command name to ICommandDescriptor object matching the query

Throws:

CommandException