alfresco-community-repo/source/java/org/alfresco/service/cmr/discussion/DiscussionService.java

/*
 * Copyright (C) 2005-2011 Alfresco Software Limited.
 *
 * This file is part of Alfresco
 *
 * Alfresco is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Alfresco is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
 */
package org.alfresco.service.cmr.discussion;

import java.util.Date;

import org.alfresco.model.ForumModel;
import org.alfresco.query.PagingRequest;
import org.alfresco.query.PagingResults;
import org.alfresco.service.NotAuditable;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.util.Pair;

/**
 * The Discussions service.
 * 
 * @author Nick Burch
 * @since 4.0
 */
public interface DiscussionService 
{
   /**
    * Creates a new {@link 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 {@link #getPrimaryPost(TopicInfo)}
    *  primary post.
    *  
    * @return The newly created {@link PostInfo}
    */
   @NotAuditable
   PostInfo createPost(TopicInfo topic, String contents);
   
   /**
    * Creates a new {@link 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. 
    *  
    * @return The newly created {@link PostInfo}
    */
   @NotAuditable
   PostInfo createReply(PostInfo parentPost, String contents);
   
   /**
    * Creates a new {@link TopicInfo} in the given site
    */
   @NotAuditable
   TopicInfo createTopic(String siteShortName, String title);
   
   /**
    * Creates a new {@link TopicInfo} attached to the specified Node. 
    * The parent Node should normally either be a Site Container, or a 
    * {@link ForumModel#TYPE_FORUM}
    */
   @NotAuditable
   TopicInfo createTopic(NodeRef parentNodeRef, String title);
   
   /**
    * Updates an existing {@link PostInfo} in the repository.
    *  
    * @return The updated {@link PostInfo}
    */
   @NotAuditable
   PostInfo updatePost(PostInfo post);
   
   /**
    * Updates an existing {@link TopicInfo} in the repository.
    *  
    * @return The updated {@link TopicInfo}
    */
   @NotAuditable
   TopicInfo updateTopic(TopicInfo topic);
   
   /**
    * Deletes an existing {@link PostInfo} from the repository
    */
   @NotAuditable
   void deletePost(PostInfo post);
   
   /**
    * Deletes an existing {@link TopicInfo} from the repository
    */
   @NotAuditable
   void deleteTopic(TopicInfo topic);
   
   /**
    * For a given NodeRef corresponding to either a 
    *  {@link TopicInfo} or a {@link 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.
    */
   @NotAuditable
   Pair<TopicInfo,PostInfo> getForNodeRef(NodeRef nodeRef);
   
   /**
    * Retrieves an existing {@link PostInfo} from the repository
    */
   @NotAuditable
   PostInfo getPost(TopicInfo topic, String postName);

   /**
    * Retrieves the Primary (Root) Post in a topic, to which all
    *  replies belong.
    * Returns null if the topic currently has no posts
    */
   @NotAuditable
   PostInfo getPrimaryPost(TopicInfo topic);
   
   /**
    * 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.
    */
   @NotAuditable
   PostInfo getMostRecentPost(TopicInfo topic);
   
   /**
    * Retrieves an existing {@link TopicInfo} from the repository,
    *  which is within a site
    */
   @NotAuditable
   TopicInfo getTopic(String siteShortName, String linkName);
   
   /**
    * Retrieves an existing {@link TopicInfo} from the repository,
    *  which is attached to the specified Node.
    * The parent Node should normally either be a Site Container, or a 
    *  {@link ForumModel#TYPE_FORUM}
    */
   @NotAuditable
   TopicInfo getTopic(NodeRef parentNodeRef, String topicName);
   
   /**
    * Retrieves all topics in a site, sorted by either oldest
    *  or newest topics first.
    */
   @NotAuditable
   PagingResults<TopicInfo> listTopics(String siteShortName, boolean sortAscending, PagingRequest paging);

   /**
    * Retrieves all topics attached to the specified Node, sorted by
    *  either oldest or newest topics first.
    */
   @NotAuditable
   PagingResults<TopicInfo> listTopics(NodeRef nodeRef, boolean sortAscending, PagingRequest paging);
   
   /**
    * Retrieves all topics in a site, filtered by username, sorted by
    *  either oldest or newest topics first.
    */
   @NotAuditable
   PagingResults<TopicInfo> listTopics(String siteShortName, 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.
    */
   @NotAuditable
   PagingResults<TopicInfo> listTopics(NodeRef nodeRef, String username, boolean sortAscending, PagingRequest paging);
   
   /**
    * Retrieves all topics in a site, created in the given date range, sorted by
    *  either oldest or newest topics first.
    */
   @NotAuditable
   PagingResults<TopicInfo> listTopics(String siteShortName, 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.
    */
   @NotAuditable
   PagingResults<TopicInfo> listTopics(NodeRef nodeRef, Date from, Date to, boolean sortAscending, PagingRequest paging);
   
   /**
    * Searches for all topics in a site, filtered by username or tag, sorted by
    *  either oldest or newest topics first.
    */
   @NotAuditable
   PagingResults<TopicInfo> findTopics(String siteShortName, 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.
    */
   @NotAuditable
   PagingResults<TopicInfo> findTopics(NodeRef nodeRef, String username, String tag, boolean sortAscending, PagingRequest paging);
   
   /**
    * 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.
    */
   @NotAuditable
   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.
    * Primary posts are not included in this.
    */
   @NotAuditable
   PagingResults<Pair<TopicInfo,Integer>> listHotTopics(NodeRef nodeRef, Date since, PagingRequest paging);
   
   /**
    * Retrieves all posts in a topic, ordered by creation date
    */
   @NotAuditable
   PagingResults<PostInfo> listPosts(TopicInfo topic, PagingRequest paging);

   /**
    * Retrieves all replies on a Topic
    */
   @NotAuditable
   PostWithReplies listPostReplies(TopicInfo forum, int levels);

   /**
    * Retrieves all replies to a Post
    */
   @NotAuditable
   PostWithReplies listPostReplies(PostInfo primaryPost, int levels);
}