wt.workflow.forum
Interface ForumService

All Known Implementing Classes:

ForumServiceFwd, StandardForumService

public interface ForumService

This class represents the client accessible API to the forum. Among others, it has methods to create and modify Forums and ForumTemplates.

Supported API: false

Extendable: false

Method Summary

void	addForum(DiscussionForum forum, SubjectOfForum subject, boolean primary) Creates and ForumSubject association between the given forum and the subject.
DiscussionForum	createForum(CollaborationTemplate template, String forumName, SubjectOfForum subject) Deprecated.
DiscussionForum	createForum(CollaborationTemplate template, String forumName, SubjectOfForum subject, WTContainerRef containerRef) Creates and persists a Forum based on the strucutre defined in the given template and associates the given subject with this new forum.
DiscussionForum	createForum(String templateName, String forumName, SubjectOfForum subject) Deprecated.
DiscussionForum	createForum(String templateName, String forumName, SubjectOfForum subject, WTContainerRef containerRef) Creates and persists a Forum based on the strucutre defined in the given template and associates the given subject with this new forum.
Forum	findForum(Discussion discussion) Supported API: false
Project2	findForumProject(Forum forum) Supported API: false
HashMap	getChildDiscussions(Discussion discussion, boolean attachments) Returns all objects that have the container as their parent object.
DiscussionForumTemplate	getDefaultTemplate() Deprecated. in 7.0
DiscussionForumTemplate	getDefaultTemplate(WTContainerRef containerRef) Retrieves the ForumTemplate given the name of the template.
Enumeration	getForums(WTObject subject) Retrieves all the forums that the given SubjectOfForum is associated with.
Enumeration	getForums(WTObject subject, boolean otherSideOnly) Retrieves all the forums that the given SubjectOfForum is associated with and if otherSideOnly is false, all the links that represent these associations .
Enumeration	getPostings(Discussion parent) Retrieves all the postings that are part of the given Discussion.
DiscussionForumTemplate	getTemplate(String name) Retrieves the ForumTemplate given the name of the template.
DiscussionForumTemplate	getTemplate(String name, WTContainerRef containerRef) Retrieves the ForumTemplate given the name of the template.
Enumeration	getTopics(Discussion parent) Retrieves all the topics that are part of the given discussion.
DiscussionForum	saveForum(SubjectOfForum subject, DiscussionForum forum) Persists the forum if it isnt already there, else updates the existing one.
DiscussionPosting	savePosting(DiscussionPosting posting) Persist the posting if it doesnt already exist and update the existing one otherwise.
CollaborationTemplate	saveTemplate(CollaborationTemplate template) Persist the posting if it doesnt already exist and update the existing one otherwise.
DiscussionTopic	saveTopic(DiscussionTopic topic) Persist the topic if it doesnt already exist and update the existing one otherwise.

Method Detail

addForum

public void addForum(DiscussionForum forum,
                     SubjectOfForum subject,
                     boolean primary)
              throws WTException,
                     NotAuthorizedException

Creates and ForumSubject association between the given forum and the subject. primary indicates whether or not the given subject was the first to use this forum.

Supported API: false

Parameters:

forum - forum playing DISCUSSION_ROLE for the association.

subject - Business object playing SUBJECT_ROLE of the association.

primary - boolean indicating whether or not subject is the primary subject of the forum.

Throws:

WTException

NotAuthorizedException

saveTopic

public DiscussionTopic saveTopic(DiscussionTopic topic)
                          throws WTException,
                                 NotAuthorizedException

Persist the topic if it doesnt already exist and update the existing one otherwise. Use this method instead of directly calling store, save or insert methods on the PersistenceManager or PersistenceManagerSvr. This method generates the NEW_DISCUSSION event if the the topic is new.

Supported API: false

Parameters:

topic -

Returns:

DiscussionTopic

Throws:

WTException

NotAuthorizedException

getTopics

public Enumeration getTopics(Discussion parent)
                      throws WTException

Retrieves all the topics that are part of the given discussion. The discussion can only be either a Forum or a DiscussionTopic.

Supported API: false

Parameters:

parent - Discussion whose topics to retrieve.

Returns:

Enumeration

Throws:

WTException

saveTemplate

public CollaborationTemplate saveTemplate(CollaborationTemplate template)
                                   throws WTException

Persist the posting if it doesnt already exist and update the existing one otherwise.

Supported API: false

Parameters:

template -

Returns:

CollaborationTemplate

Throws:

WTException

savePosting

public DiscussionPosting savePosting(DiscussionPosting posting)
                              throws WTException

Persist the posting if it doesnt already exist and update the existing one otherwise. Use this method instead of directly calling store, save or insert methods on the PersistenceManager or PersistenceManagerSvr. This method generates the NEW_DISCUSSION event if the the posting is new.

Supported API: false

Parameters:

posting -

Returns:

DiscussionPosting

Throws:

WTException

getForums

public Enumeration getForums(WTObject subject)
                      throws WTException

Retrieves all the forums that the given SubjectOfForum is associated with.

Supported API: false

Parameters:

subject - The subject whose forums are to be retrieved.

Returns:

Enumeration

Throws:

WTException

saveForum

public DiscussionForum saveForum(SubjectOfForum subject,
                                 DiscussionForum forum)
                          throws WTException

Persists the forum if it isnt already there, else updates the existing one.

Supported API: false

Parameters:

subject -

forum -

Returns:

DiscussionForum

Throws:

WTException

createForum

public DiscussionForum createForum(String templateName,
                                   String forumName,
                                   SubjectOfForum subject)
                            throws WTException

Deprecated.

Creates and persists a Forum based on the strucutre defined in the given template and associates the given subject with this new forum. The subject becomes the primary subject of all discussions in this forum. This method can be used to programmatically create an instance of a given Forum based on a certain template and associated with a business object. For eg. everytime a new WTPart is created, this method with a constant ForumTemplate name and the new WTPart can be called so every instance of a WTPart comes with a Forum with some default structure.

Supported API: false

Parameters:

templateName - The name of the template whose structure this forum should be based on.

forumName - The name of the forum.

subject - The business object that is to form the subject of discussions in this forum.

Returns:

DiscussionForum

Throws:

WTException

getPostings

public Enumeration getPostings(Discussion parent)
                        throws WTException

Retrieves all the postings that are part of the given Discussion.

Supported API: false

Parameters:

parent - The discussion whose postings to retrieve.

Returns:

Enumeration

Throws:

WTException

createForum

public DiscussionForum createForum(CollaborationTemplate template,
                                   String forumName,
                                   SubjectOfForum subject)
                            throws WTException

Deprecated.

Creates and persists a Forum based on the strucutre defined in the given template and associates the given subject with this new forum. The subject becomes the primary subject of this forum.

Supported API: false

Parameters:

template - The template containing the the structure to be used.

forumName - Name of the forum.

subject - The business object that is the primary subject of discussions in this forum.

Returns:

DiscussionForum

Throws:

WTException

getTemplate

public DiscussionForumTemplate getTemplate(String name,
                                           WTContainerRef containerRef)
                                    throws WTException

Retrieves the ForumTemplate given the name of the template.

Supported API: false

Parameters:

name -

containerRef -

Returns:

DiscussionForumTemplate

Throws:

WTException

getForums

public Enumeration getForums(WTObject subject,
                             boolean otherSideOnly)
                      throws WTException

Retrieves all the forums that the given SubjectOfForum is associated with and if otherSideOnly is false, all the links that represent these associations .

Supported API: false

Parameters:

subject - The subject whose forums are to be retrieved.

otherSideOnly - retrieve only the forums or the links as well.

Returns:

Enumeration

Throws:

WTException

getDefaultTemplate

public DiscussionForumTemplate getDefaultTemplate()
                                           throws WTException

Deprecated. in 7.0

Retrieves the ForumTemplate given the name of the template.

Supported API: false

Returns:

DiscussionForumTemplate

Throws:

WTException

findForum

public Forum findForum(Discussion discussion)
                throws WTException

Supported API: false

Parameters:

discussion -

Returns:

Forum

Throws:

WTException

findForumProject

public Project2 findForumProject(Forum forum)
                          throws WTException

Supported API: false

Parameters:

forum -

Returns:

Project2

Throws:

WTException

getChildDiscussions

public HashMap getChildDiscussions(Discussion discussion,
                                   boolean attachments)
                            throws WTException

Returns all objects that have the container as their parent object.

Supported API: false

Parameters:

discussion -

attachments -

Returns:

HashMap

Throws:

WTException

getTemplate

public DiscussionForumTemplate getTemplate(String name)
                                    throws WTException

Retrieves the ForumTemplate given the name of the template.

Supported API: false

Parameters:

name -

Returns:

DiscussionForumTemplate

Throws:

WTException

createForum

public DiscussionForum createForum(String templateName,
                                   String forumName,
                                   SubjectOfForum subject,
                                   WTContainerRef containerRef)
                            throws WTException

Creates and persists a Forum based on the strucutre defined in the given template and associates the given subject with this new forum. The subject becomes the primary subject of all discussions in this forum. This method can be used to programmatically create an instance of a given Forum based on a certain template and associated with a business object. For eg. everytime a new WTPart is created, this method with a constant ForumTemplate name and the new WTPart can be called so every instance of a WTPart comes with a Forum with some default structure.

Supported API: false

Parameters:

templateName - The name of the template whose structure this forum should be based on.

forumName - The name of the forum.

subject - The business object that is to form the subject of discussions in this forum.

containerRef -

Returns:

DiscussionForum

Throws:

WTException

createForum

public DiscussionForum createForum(CollaborationTemplate template,
                                   String forumName,
                                   SubjectOfForum subject,
                                   WTContainerRef containerRef)
                            throws WTException

Creates and persists a Forum based on the strucutre defined in the given template and associates the given subject with this new forum. The subject becomes the primary subject of this forum.

Supported API: false

Parameters:

template - The template containing the the structure to be used.

forumName - Name of the forum.

subject - The business object that is the primary subject of discussions in this forum.

containerRef -

Returns:

DiscussionForum

Throws:

WTException

getDefaultTemplate

public DiscussionForumTemplate getDefaultTemplate(WTContainerRef containerRef)
                                           throws WTException

Retrieves the ForumTemplate given the name of the template.

Supported API: false

Parameters:

containerRef -

Returns:

DiscussionForumTemplate

Throws:

WTException