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.
java.util.List<UserScore>	getTopScores(ResourceResolver resolver, Resource componentResource, Resource scoreRuleResource, int offset, int size, java.util.List<SearchSortField> sortFields) Get the top scores for a scoring rule at a location
long	getTotalNumberOfScores(ResourceResolver resolver, Resource componentResource, Resource scoreRuleResource) Get to number of scores for a scoring rule at a location
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(@Nonnull
              ResourceResolver resourceResolver,
              @Nonnull
              java.lang.String userId,
              @Nonnull
              Resource componentResource,
              @Nonnull
              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

getTopScores

java.util.List<UserScore> getTopScores(@Nonnull
                                       ResourceResolver resolver,
                                       @Nonnull
                                       Resource componentResource,
                                       @Nonnull
                                       Resource scoreRuleResource,
                                       int offset,
                                       int size,
                                       java.util.List<SearchSortField> sortFields)
                                throws RepositoryException

Get the top scores for a scoring rule at a location

Parameters:

resolver - - resolver used to search and read resources

componentResource - - the resource where the scoring rule is

scoreRuleResource - - resource of scoring rule

offset - - offset of list

size - - number of items to return

sortFields - - set to null or empty List for the default of sorting by scores and then by userid in descending order

Returns:

a list of UserScore objects in the order specified

Throws:

RepositoryException - thrown if unable to retrieve scores

getTotalNumberOfScores

long getTotalNumberOfScores(@Nonnull
                            ResourceResolver resolver,
                            Resource componentResource,
                            Resource scoreRuleResource)
                     throws RepositoryException

Get to number of scores for a scoring rule at a location

Parameters:

resolver - - resolver used to search and read resources

componentResource - - the resource where the scoring rule is

scoreRuleResource - - resource of scoring rule

Returns:

the number of scores

Throws:

RepositoryException - thrown if unable to retrieve scores

saveScore

void saveScore(@Nonnull
               ResourceResolver resourceResolver,
               @Nonnull
               java.lang.String userId,
               @Nonnull
               Resource componentResource,
               @Nonnull
               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 - thrown if unable to save the score

PersistenceException - thrown if unable to save the score

getScoreResourcePath

@CheckForNull
java.lang.String getScoreResourcePath(@Nonnull
                                                    ResourceResolver resourceResolver,
                                                    java.lang.String userId,
                                                    @Nonnull
                                                    Resource componentResource,
                                                    @Nonnull
                                                    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