org.exoplatform.services.cms.voting

Interface VotingService

All Known Implementing Classes:

VotingServiceImpl

public interface VotingService

Created by The eXo Platform SAS Author : Pham Xuan Hoa hoa.pham@exoplatform.com Jan 17, 2007

Method Summary

Modifier and Type	Method and Description
long	getVoteTotal(javax.jcr.Node node) Gets total voting for all kind languages of this document is specified by node
double	getVoteValueOfUser(javax.jcr.Node node, String userName, String language) returns user's vote value on the given node
boolean	isVoted(javax.jcr.Node node, String userName, String language) Check if user had already voted on the given node or not
void	vote(javax.jcr.Node document, double rate, String userName, String language) Voting the document is specified by the node by giving the rate, username, and language params Any language belongs to this document can be voted.

Method Detail

vote

void vote(javax.jcr.Node document,
          double rate,
          String userName,
          String language)
   throws Exception

Voting the document is specified by the node by giving the rate, username, and language params Any language belongs to this document can be voted. This method uses variables to store values which are voted from user for all kind languages of this document

Parameters:

document - The node document for voting

rate - The number rate for voting

userName - The username of current user is voting. Can not be null

language - The language of this document for voting Can not be null

Throws:

Exception

See Also:

Node

getVoteTotal

long getVoteTotal(javax.jcr.Node node)
           throws Exception

Gets total voting for all kind languages of this document is specified by node

Parameters:

node - The node document is specified to get total voting

Returns:

Throws:

Exception

See Also:

Node

isVoted

boolean isVoted(javax.jcr.Node node,
                String userName,
                String language)
         throws Exception

Check if user had already voted on the given node or not

Parameters:

node - the node that will be voted

userName - the name of user had voted

language - language of to-be-voted node

Returns:

Throws:

Exception

getVoteValueOfUser

double getVoteValueOfUser(javax.jcr.Node node,
                          String userName,
                          String language)
                   throws Exception

returns user's vote value on the given node

Parameters:

node - the node that will be voted

userName - the name of user had voted

language - language of to-be-voted node

Returns:

Throws:

Exception