mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-10-08 14:51:49 +00:00
8674e2bfc8
125603 rmunteanu: Merged 5.1.1 (5.1.1) to 5.1.N (5.1.2)
125484 slanglois: MNT-16155 Update source headers - remove old Copyrights from Java and JSP dource files
git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/BRANCHES/DEV/5.2.N/root@125781 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
72 lines
2.5 KiB
Java
72 lines
2.5 KiB
Java
package org.alfresco.repo.forum;
|
|
|
|
import org.alfresco.error.AlfrescoRuntimeException;
|
|
import org.alfresco.model.ForumModel;
|
|
import org.alfresco.query.PagingRequest;
|
|
import org.alfresco.query.PagingResults;
|
|
import org.alfresco.service.cmr.repository.NodeRef;
|
|
|
|
/**
|
|
* A service for handling comments.
|
|
*
|
|
* @author Neil Mc Erlean
|
|
* @since 4.0
|
|
*/
|
|
public interface CommentService
|
|
{
|
|
/**
|
|
* Thi method retrieves the ancestor in the repository containment hierarchy having the
|
|
* {@link ForumModel#ASPECT_DISCUSSABLE fm:discussable} aspect.
|
|
*
|
|
* @param descendantNodeRef The nodeRef which descends from the f:discussable node.
|
|
* @return the fm:discussable ancestor if there is one, else <tt>null</tt>
|
|
* @throws AlfrescoRuntimeException if the specified expectedNodeType is not correct.
|
|
*/
|
|
NodeRef getDiscussableAncestor(NodeRef descendantNodeRef);
|
|
|
|
/**
|
|
* This method retrieves the {@link ForumModel#TYPE_TOPIC fm:topic} NodeRef which holds the Share comments for
|
|
* the specified {@link ForumModel#ASPECT_DISCUSSABLE fm:discussable} node.
|
|
*
|
|
* @param discussableNode the node whose Share comments are sought.
|
|
* @return the fm:topic NodeRef, if one exists, else <tt>null</tt>.
|
|
*/
|
|
NodeRef getShareCommentsTopic(NodeRef discussableNode);
|
|
|
|
/**
|
|
* Creates a comment for the discussableNode
|
|
*
|
|
* @param discussableNode the node in Share which is being commented on .
|
|
* @param title - title of the comment
|
|
* @param comment - body of the comment
|
|
* @param suppressRollups - should it suppressRollups
|
|
* @return NodeRef - the created node reference
|
|
*/
|
|
NodeRef createComment(NodeRef discussableNode, String title, String comment, boolean suppressRollups);
|
|
|
|
/**
|
|
* Updates the comment
|
|
*
|
|
* @param commentNodeRef the comment node.
|
|
* @param title - title of the comment
|
|
* @param comment - body of the comment
|
|
*/
|
|
void updateComment(NodeRef commentNodeRef, String title, String comment);
|
|
|
|
/**
|
|
* Returns a paged list of comments.
|
|
*
|
|
* @param discussableNode the node which is being commented on .
|
|
* @param paging paging.
|
|
* @return a list of comment nodes
|
|
*/
|
|
PagingResults<NodeRef> listComments(NodeRef discussableNode, PagingRequest paging);
|
|
|
|
/**
|
|
* Deletes the comment for the discussableNode
|
|
*
|
|
* @param commentNodeRef the node in Share which is being commented on.
|
|
*/
|
|
void deleteComment(NodeRef commentNodeRef);
|
|
}
|