Collaboration API Documentation

com.filenet.bso.api.collaboration
Interface Posting

All Superinterfaces:
CollaborationObject, PersistentBaseObject
All Known Subinterfaces:
ReplyPosting, TopicPosting

public interface Posting
extends CollaborationObject, PersistentBaseObject

Classes that implement the Posting interface represent a posting in a discussion forum.


Field Summary
static java.lang.String COLLABORATION_TYPE_SYMNAME
          Value of "CollaborationType"; Content Engine property.
static java.lang.String FORUM_SYMNAME
          Value of "Forum"; Content Engine property that indicates the containing forum.
static java.lang.String MEMBERSHIPMANAGEDSECURITY_SYMNAME
          Value of "MembershipManagedSecurity"; Content Engine property.
static java.lang.String MORETEXT_SYMNAME
          Value of "MoreText"; Content Engine property.
static java.lang.String PARENT_SYMNAME
          Value of "CollaborationParent"; Content Engine property that indicates the containing topic.
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 "DocumentTitle"; Content Engine property.
static java.lang.String TEAMSPACE_SYMNAME
          Value of "Teamspace"; Content Engine property.
static java.lang.String TEXTSUMMARY_SYMNAME
          Value of "TextSummary"; Content Engine property.
 
Method Summary
 boolean forumIsClosed()
          Indicates whether the forum containing this Posting is closed.
 java.lang.String getContent()
          Returns the content of the Posting object.
 Forum getForum()
          Returns the Forum that contains this Posting.
 java.lang.String getPosterID()
          Returns a String containing the ID of the teamspace member who created the Posting object.
 SubjectInfo getPosterInfo()
          Returns a SubjectInfo object for the teamspace member who created the Posting object.
 java.util.Iterator getReplies()
          
 java.lang.String getRepliesXML(java.lang.String[] propertyNames, OrderBy[] sortOrder)
          Returns an XML representation of replies to the Posting object.
 java.lang.String getSubject()
          Return the subject of the Posting object.
 Teamspace getTeamspace()
          Returns the target Teamspace object.
 java.lang.String getTextSummary()
          Returns the text summary of the content of the Posting object.
 boolean hasMoreText()
          Indicates whether the content of the Posting object is larger than TextSummary.
 boolean isClosed()
          Indicates whether the discussion containing this Posting is closed.
 ReplyPosting replyTo(java.lang.String memberID, java.lang.String subject, java.lang.String content, com.filenet.wcm.api.Permissions perms)
          Reply to the Posting object.
 boolean topicIsClosed()
          Indicates whether the topic containing this Posting is closed.
 
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

FORUM_SYMNAME

public static final java.lang.String FORUM_SYMNAME
Value of "Forum"; Content Engine property that indicates the containing forum.

MEMBERSHIPMANAGEDSECURITY_SYMNAME

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

MORETEXT_SYMNAME

public static final java.lang.String MORETEXT_SYMNAME
Value of "MoreText"; Content Engine property.

PARENT_SYMNAME

public static final java.lang.String PARENT_SYMNAME
Value of "CollaborationParent"; Content Engine property that indicates the containing topic.

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.

COLLABORATION_TYPE_SYMNAME

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

SUBJECT_SYMNAME

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

TEAMSPACE_SYMNAME

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

TEXTSUMMARY_SYMNAME

public static final java.lang.String TEXTSUMMARY_SYMNAME
Value of "TextSummary"; Content Engine property.

PROPERTIES

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

getPosterID

public java.lang.String getPosterID()
Returns a String containing the ID of the teamspace member who created the Posting object.

Returns:
A String object.

getPosterInfo

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

Returns:
A SubjectInfo object.

getForum

public Forum getForum()
Returns the Forum that contains this Posting.

Returns:
A Forum object.

getSubject

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

Returns:
A String object which holds the subject of the discussion topic.

getTextSummary

public java.lang.String getTextSummary()
Returns the text summary of the content of the Posting object.

Returns:
A String object which contains the text summary of the posting content.

hasMoreText

public boolean hasMoreText()
Indicates whether the content of the Posting object is larger than TextSummary.

Returns:
A boolean value: FALSE if TextSummary contains entire content of Posting.

forumIsClosed

public boolean forumIsClosed()
Indicates whether the forum containing this Posting is closed.

Returns:
A boolean value: TRUE if the posting's forum is closed.

topicIsClosed

public boolean topicIsClosed()
Indicates whether the topic containing this Posting is closed.

Returns:
A boolean value: TRUE if the posting's topic is closed.

isClosed

public boolean isClosed()
Indicates whether the discussion containing this Posting is closed.

Returns:
A boolean value: TRUE if either the forum or the topic for this posting is closed.

getContent

public java.lang.String getContent()
Returns the content of the Posting object.

Returns:
A String object which contains the posting content.

getReplies

public java.util.Iterator getReplies()

Return an iterator over a collection of Posting objects which represent the postings that are replies to the Posting object.

Returns:
A collection of Posting objects.

getRepliesXML

public java.lang.String getRepliesXML(java.lang.String[] propertyNames,
                                      OrderBy[] sortOrder)
Returns an XML representation of replies to the Posting object.

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 replies to this posting.

replyTo

public ReplyPosting replyTo(java.lang.String memberID,
                            java.lang.String subject,
                            java.lang.String content,
                            com.filenet.wcm.api.Permissions perms)
                     throws DiscussionCloseException,
                            NonTeamspaceMemberException
Reply to the Posting object.

Parameters:
memberID - The ID of the member creating the reply.

content - The content of the reply.

perms - Permissions to apply to the underlying Content Engine object.

Returns:
The new reply posting object.

Throws:
DiscussionCloseException -

NonTeamspaceMemberException -  

getTeamspace

public Teamspace getTeamspace()
Returns the target Teamspace object.

Returns:
A Teamspace object.

Collaboration API Documentation

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