org.exoplatform.wcm.connector.collaboration

Class VoteConnector

java.lang.Object

org.exoplatform.wcm.connector.BaseConnector

org.exoplatform.wcm.connector.collaboration.VoteConnector

All Implemented Interfaces:

org.exoplatform.services.rest.resource.ResourceContainer

public class VoteConnector
extends BaseConnector
implements org.exoplatform.services.rest.resource.ResourceContainer

Returns and sets a vote value of a given node in the sent parameter. {{{{portalname}}}}: The name of portal. {{{{restcontextname}}}}: The context name of the REST web application which is deployed to the "{{{{portalname}}}}" portal.

eXo level API

Provisional

eXo anchor for generated doc on REST API

VoteConnector

Field Summary

Fields inherited from class org.exoplatform.wcm.connector.BaseConnector

fileHandler, fileUploadHandler, folderHandler, IF_MODIFIED_SINCE_DATE_FORMAT, LAST_MODIFIED_PROPERTY, linkManager, livePortalManagerService, repositoryService, votingService, webSchemaConfigService

Constructor Summary

Constructors

Constructor and Description
VoteConnector() Instantiates a new vote connector.

Method Summary

Modifier and Type	Method and Description
protected String	getContentStorageType() Gets the content storage type.
protected javax.jcr.Node	getRootContentStorage(javax.jcr.Node parentNode) Gets the root content storage.
javax.ws.rs.core.Response	getStarVote(String repositoryName, String workspaceName, String jcrPath) Returns a vote value for a given content.
javax.ws.rs.core.Response	getVote(String repositoryName, String workspaceName, String jcrPath) Returns a vote value for a given content.
javax.ws.rs.core.Response	postStarVote(String jcrPath, String vote) Sets a vote value for a given content.
javax.ws.rs.core.Response	postVote(String repositoryName, String workspaceName, String jcrPath, String vote, String lang) Sets a vote value for a given content.

Methods inherited from class org.exoplatform.wcm.connector.BaseConnector

buildXMLResponseCommon, buildXMLResponseForContentStorage, buildXMLResponseForPortal, buildXMLResponseForRoot, buildXMLResponseOnExpand, getContent, getContent, getCorrectContentStorage, getCurrentPortalNode, getResponse, getWebContent

Methods inherited from class java.lang.Object

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

Constructor Detail

VoteConnector

public VoteConnector()

Instantiates a new vote connector.

Method Detail

postStarVote

public javax.ws.rs.core.Response postStarVote(String jcrPath,
                                              String vote)
                                       throws Exception

Sets a vote value for a given content.

Parameters:

jcrPath - The path of the content.

vote - The vote value.

Returns:

http The code.

Throws:

Exception - The exception

eXo anchor for generated doc on REST API

VoteConnector.postStarVote

getStarVote

public javax.ws.rs.core.Response getStarVote(String repositoryName,
                                             String workspaceName,
                                             String jcrPath)
                                      throws Exception

Returns a vote value for a given content.

Parameters:

repositoryName - The repository name.

workspaceName - The workspace name.

jcrPath - The path of the content.

Returns:

http The code.

Throws:

Exception - The exception

eXo anchor for generated doc on REST API

VoteConnector.getStarVote

postVote

public javax.ws.rs.core.Response postVote(String repositoryName,
                                          String workspaceName,
                                          String jcrPath,
                                          String vote,
                                          String lang)
                                   throws Exception

Sets a vote value for a given content.

Parameters:

repositoryName - The repository name.

workspaceName - The workspace name.

jcrPath - The path of the content.

vote - The vote value.

lang - The language of the content.

Returns:

http The code.

Throws:

Exception - The exception

eXo anchor for generated doc on REST API

VoteConnector.postVote

getVote

public javax.ws.rs.core.Response getVote(String repositoryName,
                                         String workspaceName,
                                         String jcrPath)
                                  throws Exception

Returns a vote value for a given content.

Parameters:

repositoryName - The repository name.

workspaceName - The workspace name.

jcrPath - The path of the content.

Returns:

http The code

Throws:

Exception - The exception

eXo anchor for generated doc on REST API

VoteConnector.getVote

getRootContentStorage

protected javax.jcr.Node getRootContentStorage(javax.jcr.Node parentNode)
                                        throws Exception

Description copied from class: BaseConnector

Gets the root content storage.

Specified by:

getRootContentStorage in class BaseConnector

Parameters:

parentNode - the node

Returns:

the root content storage

Throws:

Exception - the exception

getContentStorageType

protected String getContentStorageType()
                                throws Exception

Description copied from class: BaseConnector

Gets the content storage type.

Specified by:

getContentStorageType in class BaseConnector

Returns:

the content storage type

Throws:

Exception - the exception