Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.database
Class RewardStatusLevelCalculator

java.lang.Object
  extended by com.jivesoftware.forum.database.RewardStatusLevelCalculator
All Implemented Interfaces:
StatusLevelCalculator

public class RewardStatusLevelCalculator
extends java.lang.Object
implements StatusLevelCalculator

Provides a status level calculator implementation that ties in with the rewards system.


Constructor Summary
RewardStatusLevelCalculator()
           
 
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
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RewardStatusLevelCalculator

public RewardStatusLevelCalculator()
Method Detail

getPointLevel

public int getPointLevel(User user)
Description copied from interface: StatusLevelCalculator
Returns the point level for a user system wide.

Specified by:
getPointLevel in interface StatusLevelCalculator
Parameters:
user - user to get status level points for
Returns:
how many status points the user has

getPointLevel

public int getPointLevel(User user,
                         Forum forum)
Description copied from interface: StatusLevelCalculator
Returns the status level points for a user in regards to a specific forum

Specified by:
getPointLevel in interface StatusLevelCalculator
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

public int getPointLevel(User user,
                         ForumCategory category)
Description copied from interface: StatusLevelCalculator
Returns the status level points for a user in regards to a specific category

Specified by:
getPointLevel in interface StatusLevelCalculator
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

public long[] getLeaderIds(int startIndex,
                           int numResults)
Description copied from interface: StatusLevelCalculator
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.

Specified by:
getLeaderIds in interface StatusLevelCalculator
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

public long[] getLeaderIds(ForumCategory category,
                           int startIndex,
                           int numResults)
Description copied from interface: StatusLevelCalculator
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.

Specified by:
getLeaderIds in interface StatusLevelCalculator
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

public long[] getLeaderIds(Forum forum,
                           int startIndex,
                           int numResults)
Description copied from interface: StatusLevelCalculator
Returns a long array of user ids of forum leaders

Specified by:
getLeaderIds in interface StatusLevelCalculator
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

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.