public class QueryDescriptor extends AnnotatedObjectDescriptor
Modifier and Type | Method and Description |
---|---|
boolean |
accept(IQueryContext context)
Can the query be satisfied by the current context, possibly with other user supplied arguments?
|
ArgumentSet |
createNewArgumentSet(IQueryContext context)
Create ArgumentSet.
|
String |
explain(IQueryContext context)
Explain any parameters which cannot be filled in from the provided context.
|
ArgumentDescriptor |
getArgumentByName(String name) |
String |
getCategory()
The menu category provided by
Category . |
Class<? extends IQuery> |
getCommandType()
The type of the query object, to be instantiated and the arguments injected when the query is run.
|
List<QueryDescriptor> |
getMenuEntries() |
String |
getShortDescription()
A short description of the query - about 80 characters, truncated from the full help
at a sentence boundary.
|
boolean |
isShallow()
Whether to not prompt the user for further arguments.
|
String |
toString() |
addParameter, getArguments, getHelp, getHelpLocale, getHelpUrl, getIcon, getIdentifier, getName, getUsage, isHelpAvailable, setUsage
public String getCategory()
Category
.public Class<? extends IQuery> getCommandType()
Class.newInstance()
public ArgumentSet createNewArgumentSet(IQueryContext context) throws SnapshotException
SnapshotException
public String getShortDescription()
public boolean accept(IQueryContext context)
context
- public String explain(IQueryContext context)
context
- public ArgumentDescriptor getArgumentByName(String name)
public List<QueryDescriptor> getMenuEntries()
public boolean isShallow()