com.stellent.cis.client.command
Interface ICommandDescriptor
- All Superinterfaces:
- java.io.Serializable
public interface ICommandDescriptor
- extends java.io.Serializable
Bean that holds some metadata information about a given command. This can used to render a UI for the command
objects or a detailed report about each command.
getFields
java.util.Collection getFields()
- Returns:
- a the list of fields for this command
getDescription
java.lang.String getDescription()
- Returns:
- a description of this command
isMultipartRequired
boolean isMultipartRequired()
- Returns:
- true if this command requires multipart/form-data input from a form post (i.e. if one of the fields is of type "inputstream")
isCustomCommand
boolean isCustomCommand()
- Returns:
- whether or not this command is custom (user extended) or not.
getCommandParameters
java.util.Map getCommandParameters()
- Returns:
- a mapping of parameters used to initialize this command
setCommandParameters
void setCommandParameters(java.util.Map parameters)
- Set the command parameters
- Parameters:
parameters
- the parameters used to initialize this command
getMethods
java.util.Collection getMethods()
- Returns:
- a collection of
ICommandMethod
methods available on this command via the command API
getMethods
java.util.Collection getMethods(java.lang.String api)
- Parameters:
api
- the name of the api
- Returns:
- a collection of methods corresponding to the given API type
getMethod
ICommandMethod getMethod(int methodID)
- Parameters:
methodID
- the method ID
- Returns:
- the corresponding method or null if no method by the given ID is found
getFieldsForMethod
java.util.Collection getFieldsForMethod(java.lang.String methodName,
java.lang.String api)
- Parameters:
methodName
- the method nameapi
- the name of the API, from ICommandFacade
- Returns:
- a collection of all fields for all methods matching the name (i.e. if the method is overloaded, gets all
fields for all overloaded methods) and the api type. For just a single method without the overloaded
fields call
getFieldsForMethod(int)
- Since:
- 7.5
getFieldsForMethod
java.util.Collection getFieldsForMethod(int methodID)
- Parameters:
methodID
- the method ID ICommandMethod.getID()
- Returns:
- a collection of all fields for the method matching the given ID and the api type
- Since:
- 7.5