|
Collaboration API Documentation | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Classes that implement the Command
interface encapsulate actions that perform actions on a Teamspace.
Field Summary | |
static java.lang.String |
DELETE_COMMAND_KEY
Command key string used to retrieve command object used to delete child objects of a teamspace, value of "delete-child-objects". |
static java.lang.String |
POSTINGREPLY_COMMAND_KEY
Command key string used to retrieve command object used to create a reply to an existing posting, value of "posting-reply". |
Method Summary | |
java.lang.Object |
execute()
Performs the operations specified by a command. |
java.lang.Object |
getCommandParameter(java.lang.String key)
Returns parameter data that was passed into Command
via the setParameterData method. |
java.lang.Object |
getCommandParameterIfAny(java.lang.String key)
Returns parameter data, if any exists, that was passed into Command
via the setParameterData method. |
void |
setParameterData(java.lang.String key,
java.lang.Object parameterData)
Passes parameter data into Command . |
Field Detail |
public static final java.lang.String DELETE_COMMAND_KEY
public static final java.lang.String POSTINGREPLY_COMMAND_KEY
Method Detail |
public java.lang.Object execute() throws java.lang.Exception
java.lang.Exception
- Thrown if an error occurs while processing the command.public void setParameterData(java.lang.String key, java.lang.Object parameterData)
Command
.
Every implementation of Command
will have different
data requirements. Use this method to provide the data required by a
Command
object.
key
- A String
representing the key used to
retrieve command data.
parameterData
- A Java Object
representing command data.public java.lang.Object getCommandParameter(java.lang.String key)
Command
via the setParameterData
method.
If parameter data has not been set for the given key, an exception is thrown.
key
- A String
representing the key used to
retrieve command data.
Object
that represents passed-in parameter data.public java.lang.Object getCommandParameterIfAny(java.lang.String key)
Command
via the setParameterData
method.
If parameter data has not been set for the given key, this method returns
null
.
key
- A String
representing the key used to
retrieve command data.
Object
that represents passed-in parameter data.
|
Collaboration API Documentation | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |