Collaboration API Documentation

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

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

public class ReplyPostingCommand
extends BaseCommand

This command class creates a reply to an existing posting object.

Sample code: Teamspace ts = CollaborationFactory.getTeamspace(store, tsid, USERNAME, null); Command cmd = CollaborationFactory.getCommand(Command.POSTINGREPLY_COMMAND_KEY); cmd.setParameterData(ReplyPostingCommand.TEAMSPACE_PARAMETER_KEY, ts); cmd.setParameterData(ReplyPostingCommand.POSTING_ID_PARAMETER_KEY, postingID); cmd.setParameterData(ReplyPostingCommand.CONTENT_PARAMETER_KEY, "This is my reply to your posting"); cmd.setParameterData(ReplyPostingCommand.MEMBER_ID_PARAMETER_KEY, "userid"); Object obj = cmd.execute(); if(obj instanceof Map) { // exceptions thrown during command execution } else { // cast return object to Posting }


Field Summary
static java.lang.String CONTENT_PARAMETER_KEY
          Key string used to store and retrieve parameter data in command object.
static java.lang.String MEMBER_ID_PARAMETER_KEY
          Key string used to store and retrieve parameter data in command object.
static java.lang.String PERMISSIONS_PARAMETER_KEY
          Key string used to store and retrieve parameter data in command object.
static java.lang.String POSTING_ID_PARAMETER_KEY
          Key string used to store and retrieve parameter data in command object.
static java.lang.String SUBJECT_PARAMETER_KEY
          Key string used to store and retrieve parameter data in command object.
static java.lang.String TEAMSPACE_PARAMETER_KEY
          Key string used to store and retrieve parameter data in command object.
 
Fields inherited from interface com.filenet.bso.api.collaboration.Command
DELETE_COMMAND_KEY, POSTINGREPLY_COMMAND_KEY
 
Constructor Summary
ReplyPostingCommand()
           
 
Method Summary
 java.lang.Object execute()
          Performs the operations specified by a command.
 
Methods inherited from class com.filenet.bso.api.collaboration.commands.BaseCommand
getCommandParameter, getCommandParameterIfAny, setParameterData
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

TEAMSPACE_PARAMETER_KEY

public static final java.lang.String TEAMSPACE_PARAMETER_KEY
Key string used to store and retrieve parameter data in command object. This key used for teamspace object, value of "teamspace", required.

POSTING_ID_PARAMETER_KEY

public static final java.lang.String POSTING_ID_PARAMETER_KEY
Key string used to store and retrieve parameter data in command object. This key used for String object holding GUID of a posting object being replied too, required.

MEMBER_ID_PARAMETER_KEY

public static final java.lang.String MEMBER_ID_PARAMETER_KEY
Key string used to store and retrieve parameter data in command object. This key used for String object holding member id of user creating reply, required.

CONTENT_PARAMETER_KEY

public static final java.lang.String CONTENT_PARAMETER_KEY
Key string used to store and retrieve parameter data in command object. This key used for String object holding actual content of posting, required.

SUBJECT_PARAMETER_KEY

public static final java.lang.String SUBJECT_PARAMETER_KEY
Key string used to store and retrieve parameter data in command object. This key used for String object holding subject of posting, required.

PERMISSIONS_PARAMETER_KEY

public static final java.lang.String PERMISSIONS_PARAMETER_KEY
Key string used to store and retrieve parameter data in command object. This key used for Permissions object holding custom permissions to apply to posting, optional.
Constructor Detail

ReplyPostingCommand

public ReplyPostingCommand()
Method Detail

execute

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

Returns:
A Map object that holds GUID:ExceptionString pair, null if no exception thrown.

Collaboration API Documentation

Copyright © 2002 - 2004 FileNet Corporation. All rights reserved.