|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 |
---|
ICommand getCommand(java.lang.String commandUri) throws CommandNotFoundException, CommandCreateException, CommandException
ICommand
object by name
commandUri
- the URI to the command
ICommand
object associated with this name
CommandNotFoundException
- if there was an error locating the command object
CommandCreateException
- if there was an error creating/instatiating the command object
CommandException
ICommandAPI getCommandAPI(java.lang.String category)
ICommandAPI
associated with the commands at a given category.
category
- the command API category.
java.lang.Object executeCommand(ICommand command) throws CommandException
command
- the populated command bean
CommandException
java.rmi.RemoteException
- if a network error occursICommandDescriptor getCommandDescriptor(java.lang.String commandUri) throws CommandNotFoundException, CommandException
ICommandDescriptor
object for a given command.
commandUri
- the uri of the command
CommandNotFoundException
CommandException
java.util.Collection getCommands(java.lang.String category) throws CommandException
category
- the category
ICommand
objects under the given category
CommandException
java.util.Collection getCategories(java.lang.String category) throws CommandException
category
- the parent category, or null for the root category
CommandException
java.util.Collection listCommands() throws CommandException
CommandException
boolean isLocalInvocation()
java.util.Map searchCommandDescriptors(java.lang.String category, java.util.Map queries, boolean isAndQuery) throws CommandException
category
- the name of the category to search in, or null for all categoriesqueries
- a map of queries, matching attribute name to attribute valueisAndQuery
- true to match all criteria, false to match just one
String
command name to ICommandDescriptor
object matching the query
CommandException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |