|
Collaboration API Documentation | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.filenet.bso.api.collaboration.commands.BaseCommand
Fields inherited from interface com.filenet.bso.api.collaboration.Command |
DELETE_COMMAND_KEY, POSTINGREPLY_COMMAND_KEY |
Constructor Summary | |
BaseCommand()
|
Method Summary | |
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 . |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.filenet.bso.api.collaboration.Command |
execute |
Constructor Detail |
public BaseCommand()
Method Detail |
public void setParameterData(java.lang.String key, java.lang.Object parameterData)
Command
Command
.
Every implementation of Command
will have different
data requirements. Use this method to provide the data required by a
Command
object.
setParameterData
in interface Command
com.filenet.bso.api.collaboration.Command
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
Command
via the setParameterData
method.
If parameter data has not been set for the given key, an exception is thrown.
getCommandParameter
in interface Command
com.filenet.bso.api.collaboration.Command
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
Command
via the setParameterData
method.
If parameter data has not been set for the given key, this method returns
null
.
getCommandParameterIfAny
in interface Command
com.filenet.bso.api.collaboration.Command
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 |