Package org.alfresco.repo.discussion

Class DiscussionServiceImpl

java.lang.Object

org.alfresco.repo.discussion.DiscussionServiceImpl

All Implemented Interfaces:

DiscussionService

public class DiscussionServiceImpl
extends Object
implements DiscussionService

Since:

4.0

Author:

Nick Burch (based on existing webscript controllers in the REST API)

Field Summary

Fields

Modifier and Type	Field	Description
protected static String	CANNED_QUERY_GET_CHILDREN
protected static String	CANNED_QUERY_GET_CHILDREN_TARGETS
protected static String	CANNED_QUERY_GET_TOPICS_WITH_POSTS
static String	DISCUSSION_COMPONENT
protected static int	MAX_REPLIES_FETCH_SIZE

Constructor Summary

Constructors

Constructor	Description
DiscussionServiceImpl()

Method Summary

Modifier and Type	Method	Description
PostInfo	createPost(TopicInfo topic, String contents)	Creates a new PostInfo in the given topic, with the specified contents.
PostInfo	createReply(PostInfo parentPost, String contents)	Creates a new PostInfo which is a reply to the specified other post, with the given contents.
TopicInfo	createTopic(String siteShortName, String title)	Creates a new TopicInfo in the given site
TopicInfo	createTopic(NodeRef parentNodeRef, String title)	Creates a new TopicInfo attached to the specified Node.
void	deletePost(PostInfo post)	Deletes an existing PostInfo from the repository
void	deleteTopic(TopicInfo topic)	Deletes an existing TopicInfo from the repository
PagingResults<TopicInfo>	findTopics(String siteShortName, String username, String tag, boolean sortAscending, PagingRequest paging)	Searches for all topics in a site, filtered by username or tag, sorted by either oldest or newest topics first.
PagingResults<TopicInfo>	findTopics(NodeRef nodeRef, String username, String tag, boolean sortAscending, PagingRequest paging)	Searches for all topics attached to the specified Node, filtered by username or tag, sorted by either oldest or newest topics first.
Pair<TopicInfo,PostInfo>	getForNodeRef(NodeRef nodeRef)	For a given NodeRef corresponding to either a TopicInfo or a PostInfo, returns the objects wrapping the Node.
PostInfo	getMostRecentPost(TopicInfo topic)	Retrieves the newest (most recent) Post in a topic, be that the Primary Post or a Reply.
PostInfo	getPost(TopicInfo topic, String postName)	Retrieves an existing PostInfo from the repository
PostInfo	getPrimaryPost(TopicInfo topic)	Retrieves the Primary (Root) Post in a topic, to which all replies belong.
protected NodeRef	getSiteDiscussionsContainer(String siteShortName, boolean create)	Fetches the Discussions Container on a site, creating as required if requested.
TopicInfo	getTopic(String siteShortName, String topicName)	Retrieves an existing TopicInfo from the repository, which is within a site
TopicInfo	getTopic(NodeRef parentNodeRef, String topicName)	Retrieves an existing TopicInfo from the repository, which is attached to the specified Node.
PagingResults<Pair<TopicInfo,Integer>>	listHotTopics(String siteShortName, Date since, PagingRequest paging)	Finds topics which have had replies since the specified date, and returns them along with the count of replies since then.
PagingResults<Pair<TopicInfo,Integer>>	listHotTopics(NodeRef nodeRef, Date since, PagingRequest paging)	Finds topics which have had replies since the specified date, and returns them along with the count of replies since then.
PostWithReplies	listPostReplies(PostInfo primaryPost, int levels)	Retrieves all replies to a Post
PostWithReplies	listPostReplies(TopicInfo topic, int levels)	Retrieves all replies on a Topic
PagingResults<PostInfo>	listPosts(TopicInfo topic, PagingRequest paging)	Retrieves all posts in a topic, ordered by creation date
PagingResults<TopicInfo>	listTopics(String siteShortName, boolean sortAscending, PagingRequest paging)	Retrieves all topics in a site, sorted by either oldest or newest topics first.
PagingResults<TopicInfo>	listTopics(String siteShortName, String username, boolean sortAscending, PagingRequest paging)	Retrieves all topics in a site, filtered by username, sorted by either oldest or newest topics first.
PagingResults<TopicInfo>	listTopics(String siteShortName, Date from, Date to, boolean sortAscending, PagingRequest paging)	Retrieves all topics in a site, created in the given date range, sorted by either oldest or newest topics first.
PagingResults<TopicInfo>	listTopics(NodeRef nodeRef, boolean sortAscending, PagingRequest paging)	Retrieves all topics attached to the specified Node, sorted by either oldest or newest topics first.
PagingResults<TopicInfo>	listTopics(NodeRef nodeRef, String username, boolean sortAscending, PagingRequest paging)	Retrieves all topics attached to the specified Node, filtered by username, sorted by either oldest or newest topics first.
PagingResults<TopicInfo>	listTopics(NodeRef nodeRef, Date from, Date to, boolean sortAscending, PagingRequest paging)	Retrieves all topics attached to the specified Node, created in the given date range, sorted by either oldest or newest topics first.
void	setCannedQueryRegistry(NamedObjectRegistry<CannedQueryFactory<? extends Object>> cannedQueryRegistry)	Set the registry of canned queries
void	setContentService(ContentService contentService)
void	setNamespaceService(NamespaceService namespaceService)
void	setNodeDAO(NodeDAO nodeDAO)
void	setNodeService(NodeService nodeService)
void	setSearchService(SearchService searchService)
void	setSiteService(SiteService siteService)
void	setTaggingService(TaggingService taggingService)
void	setTenantService(TenantService tenantService)	Set the TenantService
void	setTransactionService(TransactionService transactionService)
PostInfo	updatePost(PostInfo post)	Updates an existing PostInfo in the repository.
TopicInfo	updateTopic(TopicInfo topic)	Updates an existing TopicInfo in the repository.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DISCUSSION_COMPONENT

public static final String DISCUSSION_COMPONENT

See Also:

Constant Field Values

CANNED_QUERY_GET_CHILDREN

protected static final String CANNED_QUERY_GET_CHILDREN

See Also:

Constant Field Values

CANNED_QUERY_GET_CHILDREN_TARGETS

protected static final String CANNED_QUERY_GET_CHILDREN_TARGETS

See Also:

Constant Field Values

CANNED_QUERY_GET_TOPICS_WITH_POSTS

protected static final String CANNED_QUERY_GET_TOPICS_WITH_POSTS

See Also:

Constant Field Values

MAX_REPLIES_FETCH_SIZE

protected static final int MAX_REPLIES_FETCH_SIZE

See Also:

Constant Field Values

Constructor Detail

DiscussionServiceImpl

public DiscussionServiceImpl()

Method Detail

setNodeDAO

public void setNodeDAO(NodeDAO nodeDAO)

setNodeService

public void setNodeService(NodeService nodeService)

setSiteService

public void setSiteService(SiteService siteService)

setSearchService

public void setSearchService(SearchService searchService)

setContentService

public void setContentService(ContentService contentService)

setTaggingService

public void setTaggingService(TaggingService taggingService)

setNamespaceService

public void setNamespaceService(NamespaceService namespaceService)

setTransactionService

public void setTransactionService(TransactionService transactionService)

setCannedQueryRegistry

public void setCannedQueryRegistry(NamedObjectRegistry<CannedQueryFactory<? extends Object>> cannedQueryRegistry)

Set the registry of canned queries

setTenantService

public void setTenantService(TenantService tenantService)

Set the TenantService

getSiteDiscussionsContainer

protected NodeRef getSiteDiscussionsContainer(String siteShortName,
                                              boolean create)

Fetches the Discussions Container on a site, creating as required if requested.

getTopic

public TopicInfo getTopic(String siteShortName,
                          String topicName)

Description copied from interface: DiscussionService

Retrieves an existing TopicInfo from the repository, which is within a site

Specified by:

getTopic in interface DiscussionService

getTopic

public TopicInfo getTopic(NodeRef parentNodeRef,
                          String topicName)

Description copied from interface: DiscussionService

Retrieves an existing TopicInfo from the repository, which is attached to the specified Node. The parent Node should normally either be a Site Container, or a ForumModel.TYPE_FORUM

Specified by:

getTopic in interface DiscussionService

getPost

public PostInfo getPost(TopicInfo topic,
                        String postName)

Description copied from interface: DiscussionService

Retrieves an existing PostInfo from the repository

Specified by:

getPost in interface DiscussionService

createTopic

public TopicInfo createTopic(String siteShortName,
                             String title)

Description copied from interface: DiscussionService

Creates a new TopicInfo in the given site

Specified by:

createTopic in interface DiscussionService

createTopic

public TopicInfo createTopic(NodeRef parentNodeRef,
                             String title)

Description copied from interface: DiscussionService

Creates a new TopicInfo attached to the specified Node. The parent Node should normally either be a Site Container, or a ForumModel.TYPE_FORUM

Specified by:

createTopic in interface DiscussionService

createPost

public PostInfo createPost(TopicInfo topic,
                           String contents)

Description copied from interface: DiscussionService

Creates a new PostInfo in the given topic, with the specified contents. Normally only one post is created this way on a topic, and the remainder of the posts are created as replies to the DiscussionService.getPrimaryPost(TopicInfo) primary post.

Specified by:

createPost in interface DiscussionService

Returns:

The newly created PostInfo

createReply

public PostInfo createReply(PostInfo parentPost,
                            String contents)

Description copied from interface: DiscussionService

Creates a new PostInfo which is a reply to the specified other post, with the given contents. The link between the parent post and the reply is created as part of this.

Specified by:

createReply in interface DiscussionService

Returns:

The newly created PostInfo

updateTopic

public TopicInfo updateTopic(TopicInfo topic)

Description copied from interface: DiscussionService

Updates an existing TopicInfo in the repository.

Specified by:

updateTopic in interface DiscussionService

Returns:

The updated TopicInfo

updatePost

public PostInfo updatePost(PostInfo post)

Description copied from interface: DiscussionService

Updates an existing PostInfo in the repository.

Specified by:

updatePost in interface DiscussionService

Returns:

The updated PostInfo

deleteTopic

public void deleteTopic(TopicInfo topic)

Description copied from interface: DiscussionService

Deletes an existing TopicInfo from the repository

Specified by:

deleteTopic in interface DiscussionService

deletePost

public void deletePost(PostInfo post)

Description copied from interface: DiscussionService

Deletes an existing PostInfo from the repository

Specified by:

deletePost in interface DiscussionService

getForNodeRef

public Pair<TopicInfo,PostInfo> getForNodeRef(NodeRef nodeRef)

Description copied from interface: DiscussionService

For a given NodeRef corresponding to either a TopicInfo or a PostInfo, returns the objects wrapping the Node. For a Topic, the 2nd half of the pair is null. For a Post, both halves of the pair are set. For anything else, the response is null.

Specified by:

getForNodeRef in interface DiscussionService

getPrimaryPost

public PostInfo getPrimaryPost(TopicInfo topic)

Description copied from interface: DiscussionService

Retrieves the Primary (Root) Post in a topic, to which all replies belong. Returns null if the topic currently has no posts

Specified by:

getPrimaryPost in interface DiscussionService

getMostRecentPost

public PostInfo getMostRecentPost(TopicInfo topic)

Description copied from interface: DiscussionService

Retrieves the newest (most recent) Post in a topic, be that the Primary Post or a Reply. This is typically used when identifying if a topic has had new posts added to it since the user last saw it. Note that this works on Created Date, and not Modified/Updated, so edits to an existing post will not change this.

Specified by:

getMostRecentPost in interface DiscussionService

listTopics

public PagingResults<TopicInfo> listTopics(String siteShortName,
                                           boolean sortAscending,
                                           PagingRequest paging)

Description copied from interface: DiscussionService

Retrieves all topics in a site, sorted by either oldest or newest topics first.

Specified by:

listTopics in interface DiscussionService

listTopics

public PagingResults<TopicInfo> listTopics(NodeRef nodeRef,
                                           boolean sortAscending,
                                           PagingRequest paging)

Description copied from interface: DiscussionService

Retrieves all topics attached to the specified Node, sorted by either oldest or newest topics first.

Specified by:

listTopics in interface DiscussionService

listTopics

public PagingResults<TopicInfo> listTopics(String siteShortName,
                                           String username,
                                           boolean sortAscending,
                                           PagingRequest paging)

Description copied from interface: DiscussionService

Retrieves all topics in a site, filtered by username, sorted by either oldest or newest topics first.

Specified by:

listTopics in interface DiscussionService

listTopics

public PagingResults<TopicInfo> listTopics(NodeRef nodeRef,
                                           String username,
                                           boolean sortAscending,
                                           PagingRequest paging)

Description copied from interface: DiscussionService

Retrieves all topics attached to the specified Node, filtered by username, sorted by either oldest or newest topics first.

Specified by:

listTopics in interface DiscussionService

listTopics

public PagingResults<TopicInfo> listTopics(String siteShortName,
                                           Date from,
                                           Date to,
                                           boolean sortAscending,
                                           PagingRequest paging)

Description copied from interface: DiscussionService

Retrieves all topics in a site, created in the given date range, sorted by either oldest or newest topics first.

Specified by:

listTopics in interface DiscussionService

listTopics

public PagingResults<TopicInfo> listTopics(NodeRef nodeRef,
                                           Date from,
                                           Date to,
                                           boolean sortAscending,
                                           PagingRequest paging)

Description copied from interface: DiscussionService

Retrieves all topics attached to the specified Node, created in the given date range, sorted by either oldest or newest topics first.

Specified by:

listTopics in interface DiscussionService

listHotTopics

public PagingResults<Pair<TopicInfo,Integer>> listHotTopics(String siteShortName,
                                                                  Date since,
                                                                  PagingRequest paging)

Description copied from interface: DiscussionService

Finds topics which have had replies since the specified date, and returns them along with the count of replies since then. Primary posts are not included in this.

Specified by:

listHotTopics in interface DiscussionService

listHotTopics

public PagingResults<Pair<TopicInfo,Integer>> listHotTopics(NodeRef nodeRef,
                                                                  Date since,
                                                                  PagingRequest paging)

Description copied from interface: DiscussionService

Finds topics which have had replies since the specified date, and returns them along with the count of replies since then. Primary posts are not included in this.

Specified by:

listHotTopics in interface DiscussionService

findTopics

public PagingResults<TopicInfo> findTopics(String siteShortName,
                                           String username,
                                           String tag,
                                           boolean sortAscending,
                                           PagingRequest paging)

Description copied from interface: DiscussionService

Searches for all topics in a site, filtered by username or tag, sorted by either oldest or newest topics first.

Specified by:

findTopics in interface DiscussionService

findTopics

public PagingResults<TopicInfo> findTopics(NodeRef nodeRef,
                                           String username,
                                           String tag,
                                           boolean sortAscending,
                                           PagingRequest paging)

Description copied from interface: DiscussionService

Searches for all topics attached to the specified Node, filtered by username or tag, sorted by either oldest or newest topics first.

Specified by:

findTopics in interface DiscussionService

listPosts

public PagingResults<PostInfo> listPosts(TopicInfo topic,
                                         PagingRequest paging)

Description copied from interface: DiscussionService

Retrieves all posts in a topic, ordered by creation date

Specified by:

listPosts in interface DiscussionService

listPostReplies

public PostWithReplies listPostReplies(TopicInfo topic,
                                       int levels)

Description copied from interface: DiscussionService

Retrieves all replies on a Topic

Specified by:

listPostReplies in interface DiscussionService

listPostReplies

public PostWithReplies listPostReplies(PostInfo primaryPost,
                                       int levels)

Description copied from interface: DiscussionService

Retrieves all replies to a Post

Specified by:

listPostReplies in interface DiscussionService