com.jivesoftware.forum
Interface StatusLevelCalculator

public interface StatusLevelCalculator

Defines methods need to calculate status levels and leaders.

Method Summary

long[]	getLeaderIds(ForumCategory category, int startIndex, int numResults) Returns a long array of user ids of forum category leaders given a start index and desired number of results.
long[]	getLeaderIds(Forum forum, int startIndex, int numResults) Returns a long array of user ids of forum leaders
long[]	getLeaderIds(int startIndex, int numResults) Returns a long array of user ids of system leaders given a start index and desired number of results.
int	getPointLevel(User user) Returns the point level for a user system wide.
int	getPointLevel(User user, Forum forum) Returns the status level points for a user in regards to a specific forum
int	getPointLevel(User user, ForumCategory category) Returns the status level points for a user in regards to a specific category

Method Detail

getPointLevel

int getPointLevel(User user)

Returns the point level for a user system wide.

Parameters:

user - user to get status level points for

Returns:

how many status points the user has

getPointLevel

int getPointLevel(User user,
                  Forum forum)

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

Parameters:

user - user user to get status level points for

forum - forum to filter by

Returns:

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

getPointLevel

int getPointLevel(User user,
                  ForumCategory category)

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

Parameters:

user - user user to get status level points for

category - category to filter by

Returns:

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

getLeaderIds

long[] getLeaderIds(int startIndex,
                    int numResults)

Returns a long array of user ids of system 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:

startIndex - the start index for results.

numResults - the desired number of results to return.

Returns:

a long array of user the ids of system leaders.

getLeaderIds

long[] getLeaderIds(ForumCategory category,
                    int startIndex,
                    int numResults)

Returns a long array of user ids of forum category 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:

category - category 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 forum category leaders leaders.

getLeaderIds

long[] getLeaderIds(Forum forum,
                    int startIndex,
                    int numResults)

Returns a long array of user ids of forum leaders

Parameters:

forum - forum that the leaders belong to

startIndex - the start index for results.

numResults - the desired number of results to return.

Returns:

a long array of user ids of forum leaders