Files
alfresco-community-repo/source/java/org/alfresco/rest/api/nodes/NodeCommentsRelation.java
Raluca Munteanu 9a889c69ea Merged 5.1.N (5.1.2) to 5.2.N (5.2.1)
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
2016-04-26 12:48:49 +00:00

92 lines
3.4 KiB
Java

package org.alfresco.rest.api.nodes;
import java.util.ArrayList;
import java.util.List;
import org.alfresco.rest.api.Comments;
import org.alfresco.rest.api.model.Comment;
import org.alfresco.rest.framework.WebApiDescription;
import org.alfresco.rest.framework.WebApiParam;
import org.alfresco.rest.framework.WebApiParameters;
import org.alfresco.rest.framework.resource.RelationshipResource;
import org.alfresco.rest.framework.resource.actions.interfaces.RelationshipResourceAction;
import org.alfresco.rest.framework.resource.parameters.CollectionWithPagingInfo;
import org.alfresco.rest.framework.resource.parameters.Parameters;
import org.alfresco.util.ParameterCheck;
import org.springframework.beans.factory.InitializingBean;
/**
*
* @author Gethin James
* @author Steve Glover
*/
@RelationshipResource(name = "comments", entityResource = NodesEntityResource.class, title = "Document or folder comments")
public class NodeCommentsRelation implements RelationshipResourceAction.Read<Comment>, RelationshipResourceAction.Create<Comment>, RelationshipResourceAction.Update<Comment>,
RelationshipResourceAction.Delete, InitializingBean
{
private Comments comments;
public void setComments(Comments comments)
{
this.comments = comments;
}
@Override
public void afterPropertiesSet()
{
ParameterCheck.mandatory("comments", this.comments);
}
/**
* Create a comment for the node given by nodeId.
*
* THOR-1153: "F314: Add a comment to a folder or document"
*
*/
@Override
@WebApiDescription(title="Creates comments for the node 'nodeId'.")
public List<Comment> create(String nodeId, List<Comment> entity, Parameters parameters)
{
List<Comment> result = new ArrayList<Comment>(entity.size());
for (Comment comment : entity)
{
result.add(comments.createComment(nodeId, comment));
}
return result;
}
/**
*
* Returns a paged list of comments for the document/folder identified by nodeId, sorted chronologically with the newest first.
*
* THOR-1152: “F313: For a folder or document, get the list of associated comments”
*
* If nodeId does not exist, EntityNotFoundException (status 404).
* If nodeId does not represent a document or folder, InvalidArgumentException (status 400).
*/
@Override
@WebApiDescription(title = "Returns a paged list of comments for the document/folder identified by nodeId, sorted chronologically with the newest first.")
public CollectionWithPagingInfo<Comment> readAll(String nodeId, Parameters parameters)
{
return comments.getComments(nodeId, parameters.getPaging());
}
@Override
@WebApiDescription(title = "Updates the comment with the given id.")
public Comment update(String nodeId, Comment entity, Parameters parameters)
{
return comments.updateComment(nodeId, entity);
}
@Override
@WebApiDescription(title = "Delete the comment with the given commentNodeId.")
@WebApiParameters({
@WebApiParam(name="nodeId", title="The unique id of the parent Node being addressed", description="A single node id"),
@WebApiParam(name="commentNodeId", title="The unique id of the comment Node being addressed", description="A single node id")})
public void delete(String nodeId, String commentNodeId, Parameters parameters)
{
comments.deleteComment(nodeId, commentNodeId);
}
}