com.sapportals.wcm.repository.service.discussion

Interface Summary
Interface	Description
IDiscussion	The class `IDiscussion` handles everything to do with a single discussion.
IDiscussionEvent	The interface `IDiscussionEvent` defines constants for all events that the discussion service uses when it creates or deletes different types of discussion objects.
IDiscussionItem	An `IDiscussionItem` is a contribution of a user to a discussion.
IDiscussionItemList	A list of `IDiscussionItem` objects.
IDiscussionItemListIterator	An iterator for `IDiscussionItemList` that allows the programmer to traverse the list in either direction, modify the list during iteration, and obtain the iterator's current position in the list.
IDiscussionManager	The `IDiscussionManager` defines the central methods of the discussion repository service.

Class Summary
Class	Description
DiscussionEvent	The interface `DiscussionEvent` defines constants for all events that the discussion service uses when it creates or deletes different types of discussion objects.
DiscussionItemType	Discussion item type constants.
SingleDiscPersistenceData

Exception Summary
Exception	Description
DiscussionResourceTypeException	Indicates that setting or getting a resource type of a discussion resource was not successful.
DiscussionSingleTopicExistsException	Indicates that creation of a single topic, while running the discussion service without topic level, was not successful, because this single topic exists yet.

Package com.sapportals.wcm.repository.service.discussion Description

The Discussion Thread Repository Service is responsible for creating, deleting and keeping track of discussions.

Package Specification

Purpose

The Discussion Service provides a persistence layer for a threaded discussion.
A discussion is always bound to a specific resource. The Discussion Repository Service implements the IDiscussionManager interface. The following diagram shows the relations between the discussion interfaces:

Configuration

A Discussion Repository Service instance can be configured with the parameters shown in the table. The parameters can be set with the help
of the user interface of the Content Management configuraton framework.
For more information see the documentation Administering Content Management.

Parameters	Required	Description
`rootpath`	yes	collection where all discussions of this service are stored, e.g. /collaboration/discussion
`class`	yes	The Java class of the repository manager: com.sapportals.wcm.repository.service.discussion.wcm.DiscussionManager
`onlyFolderEnabled`	no	Defines whether discussions can only be created for folders or any resource, possible values are "true" and "false". If the parameter is missing in the configuration file the follwoing setting is assumed: "onlyFolderEnabled = false"

The following is a sample configuration entry:

repository.service.discussion.class                 = com.sapportals.wcm.repository.service.discussion.wcm.DiscussionManager
repository.service.discussion.rootpath              = /collaboration/discussions
repository.service.discussion.onlyFolderEnabled     = true

Implementation notes

Authorization

Users having read permission on a resource will have write permissions in a discussion.

User "anonymous" has only read permission in the discussion service.

Issues

The repository / collection where discussions are stored via the discussion service should be kept separately from the corresponding resource for which the discussion is created.

Package com.sapportals.wcm.repository.service.discussion