com.adobe.cq.social.scoring.api

Interface ScoringService

public interface ScoringService

Scoring service exposes operations like getPoints needed by components.

Method Summary

Modifier and Type	Method and Description
long	getScore(ResourceResolver resourceResolver, java.lang.String userId, Resource componentResource, Resource scoreRuleResource) Retrieves score specified by scoreName for user.
java.lang.String	getScoreResourcePath(ResourceResolver resourceResolver, java.lang.String userId, Resource componentResource, Resource scoreRuleResource) Returns the path of a score resource.
void	saveScore(ResourceResolver resourceResolver, java.lang.String userId, Resource componentResource, Resource scoreRuleResource, long scoreValue) Saves score specified by scoreName for user.

Method Detail

getScore

long getScore(ResourceResolver resourceResolver,
              java.lang.String userId,
              Resource componentResource,
              Resource scoreRuleResource)
       throws RepositoryException

Retrieves score specified by scoreName for user.

Parameters:

resourceResolver - - resolver used to read the resources

userId - - the user's userid

componentResource - - the resource where the scoring rule was applied

scoreRuleResource - - resource of score to be retrieved

Returns:

score of the user

Throws:

RepositoryException - thrown if unable to retrieve the score

saveScore

void saveScore(ResourceResolver resourceResolver,
               java.lang.String userId,
               Resource componentResource,
               Resource scoreRuleResource,
               long scoreValue)
        throws RepositoryException,
               PersistenceException

Saves score specified by scoreName for user.

Parameters:

resourceResolver - - resolver of the user whose score needs to be retrieved

userId - - the user's userid

componentResource - - the resource where the scoring rule was applied

scoreRuleResource - - name of score to be retrieved

scoreValue - - score value, in the form of an increment, to save

Throws:

RepositoryException, - PersistenceException thrown if unable to save the score

RepositoryException

PersistenceException

getScoreResourcePath

java.lang.String getScoreResourcePath(ResourceResolver resourceResolver,
                                      java.lang.String userId,
                                      Resource componentResource,
                                      Resource scoreRuleResource)
                               throws RepositoryException

Returns the path of a score resource.

Parameters:

resourceResolver - - resolver of the user whose score needs to be retrieved

userId - - the user's userid

componentResource - - the resource where the scoring rule was applied

scoreRuleResource - - name of score to be retrieved

Returns:

the path of score resource

Throws:

RepositoryException - if unable to calculate the score path