Collaboration API Documentation

com.filenet.bso.api.collaboration
Interface TopicPosting

All Superinterfaces:
CollaborationObject, PersistentBaseObject, Posting

public interface TopicPosting
extends Posting

Classes that implement the TopicPosting interface represent a topic in a discussion forum.


Field Summary
static java.lang.String ACTIVITYLEVEL_SYMNAME
          Value of "ActivityLevel"; Content Engine property.
static java.lang.String CLOSEDBY_SYMNAME
          Value of "CollaborationClosedBy"; Content Engine property.
static java.lang.String CLOSINGCOMMENT_SYMNAME
          Value of "ClosingComment"; Content Engine property.
static java.lang.String DATECLOSED_SYMNAME
          Value of "CollaborationDateClosed"; Content Engine property.
static java.lang.String LASTPOSTER_SYMNAME
          Value of "LastPoster"; Content Engine property.
static java.lang.String LASTPOSTINGDATE_SYMNAME
          Value of "LastPostingDate"; Content Engine property.
static java.lang.String[] PROPERTIES
           
static java.lang.String REPLIESCOUNT_SYMNAME
          Value of "RepliesCount"; Content Engine property.
static java.lang.String TOPICFOLDER_SYMNAME
          Value of "TopicFolder"; Content Engine property.
 
Fields inherited from interface com.filenet.bso.api.collaboration.Posting
COLLABORATION_TYPE_SYMNAME, FORUM_SYMNAME, MEMBERSHIPMANAGEDSECURITY_SYMNAME, MORETEXT_SYMNAME, PARENT_SYMNAME, POSTERID_SYMNAME, SECURITYOWNERID_SYMNAME, SUBJECT_SYMNAME, TEAMSPACE_SYMNAME, TEXTSUMMARY_SYMNAME
 
Method Summary
 void close(java.lang.String closingComment)
          Closes the TopicPosting, preventing further addition or removal of replies.
 int getActivityLevel()
          Returns the activity level for this TopicPosting object.
 java.util.Iterator getAllReplies()
          
 int getAllRepliesCount()
          Return the number of postings that are replies to this posting.
 java.lang.String getAllRepliesXML(java.lang.String[] propertyNames, OrderBy[] sortOrder)
          Returns an XML representation of all replies to this posting.
 SubjectInfo getClosedBy()
          Return identity of the user who closed the TopicPosting.
 java.lang.String getClosingComment()
          Return the closing comment for the TopicPosting.
 java.util.Date getDateClosed()
          Return the date that the TopicPosting was closed.
 SubjectInfo getLastPoster()
          Returns a SubjectInfo object for the teamspace member who added the last Posting to the topic.
 java.util.Date getLastPostingDate()
          Return the date/time of the last posting added to this discussion topic.
 void reopen()
          Reopens the TopicPosting object, allowing new replies to be created.
 
Methods inherited from interface com.filenet.bso.api.collaboration.Posting
forumIsClosed, getContent, getForum, getPosterID, getPosterInfo, getReplies, getRepliesXML, getSubject, getTeamspace, getTextSummary, hasMoreText, isClosed, replyTo, topicIsClosed
 
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

ACTIVITYLEVEL_SYMNAME

public static final java.lang.String ACTIVITYLEVEL_SYMNAME
Value of "ActivityLevel"; Content Engine property.

CLOSEDBY_SYMNAME

public static final java.lang.String CLOSEDBY_SYMNAME
Value of "CollaborationClosedBy"; 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 "CollaborationDateClosed"; Content Engine property.

LASTPOSTER_SYMNAME

public static final java.lang.String LASTPOSTER_SYMNAME
Value of "LastPoster"; Content Engine property.

LASTPOSTINGDATE_SYMNAME

public static final java.lang.String LASTPOSTINGDATE_SYMNAME
Value of "LastPostingDate"; Content Engine property.

REPLIESCOUNT_SYMNAME

public static final java.lang.String REPLIESCOUNT_SYMNAME
Value of "RepliesCount"; Content Engine property.

TOPICFOLDER_SYMNAME

public static final java.lang.String TOPICFOLDER_SYMNAME
Value of "TopicFolder"; Content Engine property.

PROPERTIES

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

getLastPoster

public SubjectInfo getLastPoster()
Returns a SubjectInfo object for the teamspace member who added the last Posting to the topic.

Returns:
A SubjectInfo object.

getLastPostingDate

public java.util.Date getLastPostingDate()
Return the date/time of the last posting added to this discussion topic.

Returns:
A Date object holding the date and time of the most recent posting to this discussion topic.

getActivityLevel

public int getActivityLevel()
Returns the activity level for this TopicPosting object.

Returns:
An int value that represents the relative activity level of this discussion topic. Lower numbers represent more activity.

getAllRepliesCount

public int getAllRepliesCount()
Return the number of postings that are replies to this posting.

Returns:
An int value representing the number of postings that are direct or indirect replies to this posting.

getAllReplies

public java.util.Iterator getAllReplies()

Return an iterator over a collection of Posting objects which represent all of the postings that are direct or indirect replies to this posting.

Returns:
A collection of Posting objects.

getAllRepliesXML

public java.lang.String getAllRepliesXML(java.lang.String[] propertyNames,
                                         OrderBy[] sortOrder)
Returns an XML representation of all replies to this posting.

Parameters:
propertyNames - A String array containing the property names to include in the XML, may be null.
sortOrder - An OrderBy array that contains the property name and sort order (ASCENDING_SORT or DESCENDING_SORT) for each property value selected to sort on. Optional; may be null.

Returns:
The XML representation of all direct or indirect replies to this posting.

getDateClosed

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

Returns:
A Date object holding the date the topic was closed. If null, the topic remains open.

getClosedBy

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

Returns:
A SubjectInfo object identifying the user who closed the topic.

getClosingComment

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

Returns:
A String object containing the closing comment for the topic.

close

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

Parameters:
closingComment - A String object specifying the reason for the closure (or any other information pertaining to the closure).

Throws:
DiscussionCloseException -  
NonTeamspaceMemberException -  

reopen

public void reopen()
            throws DiscussionCloseException,
                   NonTeamspaceMemberException
Reopens the TopicPosting object, allowing new replies to be created.

Throws:
DiscussionCloseException -  
NonTeamspaceMemberException -  

Collaboration API Documentation

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