Collaboration API Documentation

com.filenet.bso.api.collaboration
Interface Command

All Known Implementing Classes:
BaseCommand

public interface Command

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

DELETE_COMMAND_KEY

public static final 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".

POSTINGREPLY_COMMAND_KEY

public static final 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 Detail

execute

public java.lang.Object execute()
                         throws java.lang.Exception
Performs the operations specified by a command.

Throws:
java.lang.Exception - Thrown if an error occurs while processing the command.

setParameterData

public void setParameterData(java.lang.String key,
                             java.lang.Object parameterData)
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.

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)
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.

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)
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.

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.