Collaboration API Documentation

com.filenet.bso.api.collaboration
Interface Forum

All Superinterfaces:
CollaborationObject, Container, FolderContainer, PersistentBaseObject

public interface Forum
extends FolderContainer

A class that implements the Forum interface provides a folder-based container that manages a single discussion forum and the postings about the forum.

See Also:
Posting

Field Summary
static java.lang.String CLOSEDBY_SYMNAME
          Value of "ColaborationClosedBy"; Content Engine property.
static java.lang.String CLOSINGCOMMENT_SYMNAME
          Value of "ClosingComment"; Content Engine property.
static java.lang.String COLLABORATION_TYPE_SYMNAME
          Value of "CollaborationType"; Content Engine property.
static java.lang.String DATECLOSED_SYMNAME
          Value of "ColaborationDateClosed"; Content Engine property.
static java.lang.String DESCRIPTION_SYMNAME
          Value of "CollaborationDescription"; Content Engine property.
static java.lang.String MEMBERSHIPMANAGEDSECURITY_SYMNAME
          Value of "MembershipManagedSecurity"; Content Engine property.
static java.lang.String POSTERID_SYMNAME
          Value of "MemberID"; Content Engine property.
static java.lang.String[] PROPERTIES
           
static java.lang.String SECURITYOWNERID_SYMNAME
          Value of "SecurityOwnerID"; Content Engine property.
static java.lang.String SUBJECT_SYMNAME
          Value of "Subject"; Content Engine property.
static java.lang.String TEAMSPACE_SYMNAME
          Value of "Teamspace"; Content Engine property.
static java.lang.String TOPICS_SYMNAME
          Value of "Topics"; Content Engine property.
 
Fields inherited from interface com.filenet.bso.api.collaboration.Container
ADD_CONTAINEES_CAPABILITY, ADD_SUBCONTAINERS_CAPABILITY, ASCENDING_SORT, DEACTIVATE_CAPABILITY, DESCENDING_SORT, FIND_BY_ID_CAPABILITY, FIND_BY_NAME_CAPABILITY, HAS_CONTAINEES_CAPABILITY, HAS_SUBCONTAINERS_CAPABILITY, REMOVE_CONTAINEES_CAPABILITY, REMOVE_SUBCONTAINERS_CAPABILITY
 
Method Summary
 void bulkUpdate(java.util.Map data)
          Perform a bulk update of properties.
 void close(java.lang.String closingComment)
          Closes the Forum, preventing further addition or removal of topics and replies.
 SubjectInfo getClosedBy()
          Return identity of the user who closed the Forum object.
 java.lang.String getClosingComment()
          Return the closing comment for the Forum object.
 java.util.Date getDateClosed()
          Return the date that the Forum was closed.
 java.lang.String getDescription()
          Return a description of the Forum object.
 java.lang.String getPosterID()
          Returns the id of the teamspace member who created the Forum object.
 SubjectInfo getPosterInfo()
          Returns the SubjectInfo for the teamspace member who created the Forum object.
 java.lang.String getSubject()
          Return the subject of the Forum object.
 Teamspace getTeamspace()
          Return the teamspace that this forum is in.
 boolean isClosed()
          Return true if the Forum is closed.
 void reopen()
          Reopens the Forum to allow new topics and replies to be created.
 void setDescription(java.lang.String description)
          Sets the description of the Forum object.
 void setSubject(java.lang.String subject)
          Sets the subject of the Forum object.
 
Methods inherited from interface com.filenet.bso.api.collaboration.FolderContainer
addSubContainer, findSubContainerByID, getEligibleMembers, getSubContainers, getSubContainersXML, removeSubContainer
 
Methods inherited from interface com.filenet.bso.api.collaboration.Container
addContainee, findContaineeByID, findContaineeByName, getContainees, getContaineesXML, getDefinitionID, getName, removeContainee, supports
 
Methods inherited from interface com.filenet.bso.api.collaboration.CollaborationObject
getSymbolicName, getType
 
Methods inherited from interface com.filenet.bso.api.collaboration.PersistentBaseObject
getBaseObject, getID, getObjectStore, getProperties, isMembershipManagedSecurity, isOwner, refresh, setProperties
 

Field Detail

CLOSEDBY_SYMNAME

public static final java.lang.String CLOSEDBY_SYMNAME
Value of "ColaborationClosedBy"; Content Engine property.

CLOSINGCOMMENT_SYMNAME

public static final java.lang.String CLOSINGCOMMENT_SYMNAME
Value of "ClosingComment"; Content Engine property.

DATECLOSED_SYMNAME

public static final java.lang.String DATECLOSED_SYMNAME
Value of "ColaborationDateClosed"; Content Engine property.

DESCRIPTION_SYMNAME

public static final java.lang.String DESCRIPTION_SYMNAME
Value of "CollaborationDescription"; Content Engine property.

MEMBERSHIPMANAGEDSECURITY_SYMNAME

public static final java.lang.String MEMBERSHIPMANAGEDSECURITY_SYMNAME
Value of "MembershipManagedSecurity"; Content Engine property.

POSTERID_SYMNAME

public static final java.lang.String POSTERID_SYMNAME
Value of "MemberID"; Content Engine property.

SECURITYOWNERID_SYMNAME

public static final java.lang.String SECURITYOWNERID_SYMNAME
Value of "SecurityOwnerID"; Content Engine property.

SUBJECT_SYMNAME

public static final java.lang.String SUBJECT_SYMNAME
Value of "Subject"; Content Engine property.

TEAMSPACE_SYMNAME

public static final java.lang.String TEAMSPACE_SYMNAME
Value of "Teamspace"; Content Engine property.

TOPICS_SYMNAME

public static final java.lang.String TOPICS_SYMNAME
Value of "Topics"; Content Engine property.

COLLABORATION_TYPE_SYMNAME

public static final java.lang.String COLLABORATION_TYPE_SYMNAME
Value of "CollaborationType"; Content Engine property.

PROPERTIES

public static final java.lang.String[] PROPERTIES
Method Detail

getPosterID

public java.lang.String getPosterID()
Returns the id of the teamspace member who created the Forum object.

Returns:
A String containing a member id.

getPosterInfo

public SubjectInfo getPosterInfo()
Returns the SubjectInfo for the teamspace member who created the Forum object.

Returns:
A SubjectInfo object containing information about the member.

getSubject

public java.lang.String getSubject()
Return the subject of the Forum object.

Returns:
A String object which holds the subject of the Forum object.

setSubject

public void setSubject(java.lang.String subject)
                throws DiscussionCloseException,
                       NonTeamspaceMemberException
Sets the subject of the Forum object.

Parameters:
subject - A String object which holds the subject of the Forum object.

getDescription

public java.lang.String getDescription()
Return a description of the Forum object.

Returns:
A String object which holds a description of the Forum object.

setDescription

public void setDescription(java.lang.String description)
                    throws DiscussionCloseException,
                           NonTeamspaceMemberException
Sets the description of the Forum object.

Parameters:
description - A String object which holds a description of the Forum object.

getDateClosed

public java.util.Date getDateClosed()
Return the date that the Forum was closed.

Returns:
A Date object which holds the date the forum was closed, or null if the forum is not closed.

getClosedBy

public SubjectInfo getClosedBy()
Return identity of the user who closed the Forum object.

Returns:
A SubjectInfo object which identifies the user who closed the forum.

getClosingComment

public java.lang.String getClosingComment()
Return the closing comment for the Forum object.

Returns:
A String object which holds closing comment for the Forum object.

isClosed

public boolean isClosed()
Return true if the Forum is closed.

Returns:
A boolean value specifying whether or not the forum is closed.

close

public void close(java.lang.String closingComment)
           throws DiscussionCloseException,
                  NonTeamspaceMemberException
Closes the Forum, preventing further addition or removal of topics and replies.

Parameters:
closingComment - A String object which specifies why the forum was closed or other information about the closing of the forum.

reopen

public void reopen()
            throws DiscussionCloseException,
                   NonTeamspaceMemberException
Reopens the Forum to allow new topics and replies to be created.


bulkUpdate

public void bulkUpdate(java.util.Map data)
                throws DiscussionCloseException,
                       ValidationException
Perform a bulk update of properties. The Map parameter contains the new property values keyed by property name. The properties that are legal to be updated via this method include (by property name, type):

DESCRIPTION_SYMNAME (String)

SUBJECT_SYMNAME (String)

Parameters:
data - Data to update meeting properties.

getTeamspace

public Teamspace getTeamspace()
Return the teamspace that this forum is in.
Returns:
the teamspace

Collaboration API Documentation

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