Package wt.workflow.forum

Interface ForumService

All Known Implementing Classes:
StandardForumService
@RemoteInterface 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: true

Extendable: false

  • Method Details

    • addForum

      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: true
      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

    • createForum

      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: true
      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

      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: true
      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

    • getForumsMap

      WTKeyedMap getForumsMap(WTCollection subjects) throws WTException
      This api accepts the collection of subjects and returns the Map with subject and the list of its associated discussion forums.

      Supported API: true
      Parameters:
      subjects -
      Returns:
      WTKeyedMap
      Throws:
      WTException