com.jivesoftware.community
Interface StatusLevelCalculator

public interface StatusLevelCalculator

Defines methods need to calculate status levels and leaders.

Method Summary

java.util.Map<java.lang.Long,java.lang.Long>	getAllPointLevels(User user) Returns the status level points for a user for all communities the user has points in
long[]	getLeaderIds(Community community, int startIndex, int numResults) Returns a long array of user ids of community leaders given a start index and desired number of results.
long	getPointLevel(User user, Community community) Returns the status level points for a user in regards to a specific community

Method Detail

getPointLevel

long getPointLevel(User user,
                   Community community)

Returns the status level points for a user in regards to a specific community

Parameters:

user - user user to get status level points for

community - community to filter by

Returns:

how many status level points a user has for the particular community

getAllPointLevels

java.util.Map<java.lang.Long,java.lang.Long> getAllPointLevels(User user)

Returns the status level points for a user for all communities the user has points in

Parameters:

user - user user to get status level points for

Returns:

a map of communityID -> points for all communities the user has points in

getLeaderIds

long[] getLeaderIds(Community community,
                    int startIndex,
                    int numResults)

Returns a long array of user ids of community leaders given a start index and desired number of results. Note that the array returned may be smaller than numResults if no more results are available.

Parameters:

community - community that the leaders lead

startIndex - the start index for results.

numResults - the desired number of results to return.

Returns:

a long array of user ids of community leaders leaders.