Collaboration API Documentation

com.filenet.bso.api.collaboration.data
Class ForumInfo

java.lang.Object
  |
  +--com.filenet.bso.api.collaboration.data.FolderContainerInfo
        |
        +--com.filenet.bso.api.collaboration.data.ForumInfo
All Implemented Interfaces:
java.io.Serializable

public class ForumInfo
extends FolderContainerInfo

The ForumInfo class is a collection of data used to create a forum subcontainer for postings in a teamspace's discussion container. A teamspace forum subcontainer is created by generating a ForumInfo object from the CollaborationFactory and adding it to the teamspace's discussion container via its addSubContainer() method.

See Also:
CollaborationFactory, Serialized Form

Fields inherited from class com.filenet.bso.api.collaboration.data.FolderContainerInfo
folderName, linkObject, memberID
 
Constructor Summary
protected ForumInfo()
           
  ForumInfo(java.lang.String subject, java.lang.String description, java.lang.String ownerID)
          Constructs a new ForumInfo object with the specified parameters.
 
Method Summary
 java.lang.String getDescription()
          Returns the discussion forum description.
 java.lang.String getSubject()
          Returns the discussion forum subject.
 
Methods inherited from class com.filenet.bso.api.collaboration.data.FolderContainerInfo
getFolderName, getLinkObject, getOwnerID
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ForumInfo

protected ForumInfo()

ForumInfo

public ForumInfo(java.lang.String subject,
                 java.lang.String description,
                 java.lang.String ownerID)
Constructs a new ForumInfo object with the specified parameters.

Parameters:
subject - Forum title.

description - Forum description.

ownerID - The LDAP SID of the member that will be granted creator-owner rights for this object.
Method Detail

getSubject

public java.lang.String getSubject()
Returns the discussion forum subject.

Returns:
A String containing the subject of the discussion forum.

getDescription

public java.lang.String getDescription()
Returns the discussion forum description.

Returns:
A String containing the description of the discussion forum, or null if a description is not available.

Collaboration API Documentation

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