|
Collaboration API Documentation | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A class that implements the Forum
interface provides a folder-based container
that manages a single discussion forum and the postings about the forum.
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 |
public static final java.lang.String CLOSEDBY_SYMNAME
public static final java.lang.String CLOSINGCOMMENT_SYMNAME
public static final java.lang.String DATECLOSED_SYMNAME
public static final java.lang.String DESCRIPTION_SYMNAME
public static final java.lang.String MEMBERSHIPMANAGEDSECURITY_SYMNAME
public static final java.lang.String POSTERID_SYMNAME
public static final java.lang.String SECURITYOWNERID_SYMNAME
public static final java.lang.String SUBJECT_SYMNAME
public static final java.lang.String TEAMSPACE_SYMNAME
public static final java.lang.String TOPICS_SYMNAME
public static final java.lang.String COLLABORATION_TYPE_SYMNAME
public static final java.lang.String[] PROPERTIES
Method Detail |
public java.lang.String getPosterID()
Forum
object.
String
containing a member id.public SubjectInfo getPosterInfo()
SubjectInfo
for the teamspace member who created the Forum
object.
SubjectInfo
object containing information about the member.public java.lang.String getSubject()
Forum
object.
String
object which holds the subject of the Forum
object.public void setSubject(java.lang.String subject) throws DiscussionCloseException, NonTeamspaceMemberException
Forum
object.
subject
- A String
object which holds the subject of the Forum
object.public java.lang.String getDescription()
Forum
object.
String
object which holds a description of the Forum
object.public void setDescription(java.lang.String description) throws DiscussionCloseException, NonTeamspaceMemberException
Forum
object.
description
- A String
object which holds a description of the Forum
object.public java.util.Date getDateClosed()
Forum
was closed.
Date
object which holds the date the forum was closed, or null if the forum is not closed.public SubjectInfo getClosedBy()
Forum
object.
SubjectInfo
object which identifies the user who closed the forum.public java.lang.String getClosingComment()
Forum
object.
String
object which holds closing comment for the Forum
object.public boolean isClosed()
true
if the Forum
is closed.
boolean
value specifying whether or not the forum is closed.public void close(java.lang.String closingComment) throws DiscussionCloseException, NonTeamspaceMemberException
Forum
, preventing further addition or removal of topics and replies.
closingComment
- A String
object which specifies why the forum was closed or other information
about the closing of the forum.public void reopen() throws DiscussionCloseException, NonTeamspaceMemberException
Forum
to allow new topics and replies to be created.
public void bulkUpdate(java.util.Map data) throws DiscussionCloseException, ValidationException
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)
data
- Data to update meeting properties.public Teamspace getTeamspace()
|
Collaboration API Documentation | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |