Collaboration API Documentation

com.filenet.bso.api.collaboration.commands
Class BaseCommand

java.lang.Object
  |
  +--com.filenet.bso.api.collaboration.commands.BaseCommand
All Implemented Interfaces:
Command
Direct Known Subclasses:
DeleteCommand, ReplyPostingCommand

public abstract class BaseCommand
extends java.lang.Object
implements Command


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

BaseCommand

public BaseCommand()
Method Detail

setParameterData

public void setParameterData(java.lang.String key,
                             java.lang.Object parameterData)
Description copied from interface: Command
Passes parameter data into Command.

Every implementation of Command will have different data requirements. Use this method to provide the data required by a Command object.

Specified by:
setParameterData in interface Command
Following copied from interface: com.filenet.bso.api.collaboration.Command
Parameters:
key - A String representing the key used to retrieve command data.

parameterData - A Java Object representing command data.

getCommandParameter

public java.lang.Object getCommandParameter(java.lang.String key)
Description copied from interface: Command
Returns parameter data that was passed into Command via the setParameterData method. If parameter data has not been set for the given key, an exception is thrown.

Specified by:
getCommandParameter in interface Command
Following copied from interface: com.filenet.bso.api.collaboration.Command
Parameters:
key - A String representing the key used to retrieve command data.

Returns:
A Java Object that represents passed-in parameter data.

getCommandParameterIfAny

public java.lang.Object getCommandParameterIfAny(java.lang.String key)
Description copied from interface: Command
Returns parameter data, if any exists, that was passed into Command via the setParameterData method. If parameter data has not been set for the given key, this method returns null.

Specified by:
getCommandParameterIfAny in interface Command
Following copied from interface: com.filenet.bso.api.collaboration.Command
Parameters:
key - A String representing the key used to retrieve command data.

Returns:
A Java Object that represents passed-in parameter data.

Collaboration API Documentation

Copyright ?2002 - 2005 FileNet Corporation. All rights reserved.