mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-08-14 17:58:59 +00:00
3e1e1edbaa
125788 rmunteanu: Merged 5.1.N (5.1.2) to 5.2.N (5.2.1)
125606 rmunteanu: Merged 5.1.1 (5.1.1) to 5.1.N (5.1.2)
125515 slanglois: MNT-16155 Update source headers - add new Copyrights for Java and JSP source files + automatic check in the build
git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@127810 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
107 lines
4.4 KiB
Java
107 lines
4.4 KiB
Java
/*
|
|
* #%L
|
|
* Alfresco Remote API
|
|
* %%
|
|
* Copyright (C) 2005 - 2016 Alfresco Software Limited
|
|
* %%
|
|
* This file is part of the Alfresco software.
|
|
* If the software was purchased under a paid Alfresco license, the terms of
|
|
* the paid license agreement will prevail. Otherwise, the software is
|
|
* provided under the following open source license terms:
|
|
*
|
|
* 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/>.
|
|
* #L%
|
|
*/
|
|
package org.alfresco.rest.api.nodes;
|
|
|
|
import java.util.Collections;
|
|
import java.util.List;
|
|
|
|
import org.alfresco.rest.api.NodeRatings;
|
|
import org.alfresco.rest.api.model.NodeRating;
|
|
import org.alfresco.rest.framework.WebApiDescription;
|
|
import org.alfresco.rest.framework.WebApiParam;
|
|
import org.alfresco.rest.framework.WebApiParameters;
|
|
import org.alfresco.rest.framework.core.ResourceParameter;
|
|
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;
|
|
|
|
@RelationshipResource(name = "ratings", entityResource = NodesEntityResource.class, title = "Document or folder ratings")
|
|
public class NodeRatingsRelation implements RelationshipResourceAction.Read<NodeRating>, RelationshipResourceAction.ReadById<NodeRating>, RelationshipResourceAction.Delete,
|
|
RelationshipResourceAction.Create<NodeRating>, InitializingBean
|
|
{
|
|
private NodeRatings nodeRatings;
|
|
|
|
public void setNodeRatings(NodeRatings nodeRatings)
|
|
{
|
|
this.nodeRatings = nodeRatings;
|
|
}
|
|
|
|
@Override
|
|
public void afterPropertiesSet()
|
|
{
|
|
ParameterCheck.mandatory("nodeRatings", this.nodeRatings);
|
|
}
|
|
|
|
@Override
|
|
@WebApiDescription(title="A paged list of ratings for node 'nodeId'.")
|
|
@WebApiParam(name="nodeId", title="The unique id of the Node being addressed", description="A single node id")
|
|
public CollectionWithPagingInfo<NodeRating> readAll(String nodeId, Parameters parameters)
|
|
{
|
|
return nodeRatings.getNodeRatings(nodeId, parameters.getPaging());
|
|
}
|
|
|
|
/**
|
|
* Create a rating for the node with id 'nodeId'.
|
|
*
|
|
*/
|
|
@Override
|
|
@WebApiDescription(title="Rate a node for 'nodeId'.")
|
|
@WebApiParam(name="ratingEntity", title="A single rating", description="A single node rating, multiple ratings are not supported.",
|
|
kind=ResourceParameter.KIND.HTTP_BODY_OBJECT, allowMultiple=false)
|
|
public List<NodeRating> create(String nodeId, List<NodeRating> ratingEntity, Parameters parameters)
|
|
{
|
|
//There will always be 1 value because allowMultiple=false
|
|
NodeRating rating = ratingEntity.get(0);
|
|
String ratingSchemeId = rating.getScheme();
|
|
nodeRatings.addRating(nodeId, ratingSchemeId, rating.getMyRating());
|
|
return Collections.singletonList(nodeRatings.getNodeRating(nodeId, ratingSchemeId));
|
|
}
|
|
|
|
/**
|
|
* Returns the rating with id 'schemeName' for node with id 'nodeId'.
|
|
*
|
|
*/
|
|
@Override
|
|
@WebApiDescription(title="Get the rating with id 'ratingSchemeId' for node 'nodeId'.")
|
|
@WebApiParameters({
|
|
@WebApiParam(name="nodeId", title="The unique id of the Node being addressed", description="A single node id"),
|
|
@WebApiParam(name="ratingSchemeId", title="The rating scheme type", description="Possible values are likesRatingScheme.")})
|
|
public NodeRating readById(String nodeId, String ratingSchemeId, Parameters parameters)
|
|
{
|
|
return nodeRatings.getNodeRating(nodeId, ratingSchemeId);
|
|
}
|
|
|
|
@Override
|
|
@WebApiDescription(title="Deletes a node rating")
|
|
public void delete(String nodeId, String ratingSchemeId, Parameters parameters)
|
|
{
|
|
nodeRatings.removeRating(nodeId, ratingSchemeId);
|
|
}
|
|
|
|
} |