|
Jive Forums API (5.5.20.2-oracle) Developer Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface RewardManager
Manages the reward points that users can trade back and forth when answerings questions. The author of each thread can transfer a variable number of points to any thread they create. Subsequently, they can award those points to whoever they feel makes the best responses in that thread. System administrators also have the ability to reward any number of points to any user.
This manager provides methods to transfer points to threads from users, and to reward the best posts in a thread with points. It also provies the ability to check the number of points that individual threads, messages, and users have.
Method Summary | |
---|---|
void |
addBankPoints(int numPoints)
Allows administrators to add or substract an arbitrary number of reward points from all user's point banks. |
void |
addBankPoints(User user,
int numPoints)
Allows administrators to add or substract an arbitrary number of reward points from a user's point bank. |
int |
getBankPoints(User user)
Returns the current number of reward points a user has. |
int |
getInitialBankPoints()
Returns the number of bank points a user will start with. |
int |
getMaxBankPoints()
Returns the max number of points that can accumulate in a bank account, or -1 if there is no max. |
int |
getMaxMessagePoints()
Returns the maximum number of reward points that can be assigned to a message. |
int |
getMaxThreadPoints()
Returns the maximum number of reward points that can be assigned to a thread. |
java.util.Iterator |
getPendingRewardThreads(User user)
Returns the threads (ordered by modified date) that the user has assigned points to that haven't been fully rewarded out yet. |
int |
getPendingRewardThreadsCount(User user)
Returns a count of the threads that the user has assigned points to that haven't been fully rewarded out yet. |
int |
getPoints(ForumMessage message)
Returns the number of reward points that have been assigned to a message. |
int |
getPoints(ForumThread thread)
Returns the number of reward points in a thread that are left to be distributed. |
int |
getPointsEarned(User user)
Returns the total number of points that a user has earned across the entire system. |
int |
getPointsEarned(User user,
Forum forum)
Returns the total number of points the user has earned in a particular forum. |
int |
getPointsEarned(User user,
ForumCategory category)
Returns the total number of points the user has earned in a particular category. |
int |
getPointsRewarded(ForumThread thread)
Returns the total number of points rewarded to messages in the thread. |
int |
getPointsRewarded(User user)
Returns the total number of points that a user has ever rewarded. |
java.util.Iterator |
getTopUsers(int startIndex,
int numResults)
Returns an iterator for the top point earners in the entire system. |
java.util.Iterator |
getTopUsers(int startIndex,
int numResults,
Forum forum)
Returns an iterator for the top point earners in a forum. |
java.util.Iterator |
getTopUsers(int startIndex,
int numResults,
ForumCategory category)
Returns an iterator for the top point earners in a category. |
boolean |
isBankEnabled()
Returns true if bank points are enabled. |
boolean |
isRewardsEnabled()
Returns true if rewards are enabled, false otherwise. |
void |
rewardPoints(ForumMessage message,
int numPoints)
Rewards a message with points from the thread that the message belongs to. |
void |
setBankEnabled(boolean enabled)
Toggles bank points to enabled or disabled. |
void |
setInitialBankPoints(int initialBankPoints)
Sets the number of bank points a user will start with. |
void |
setMaxBankPoints(int maxBankPoints)
Sets the max number of points that can accumulate in a bank account. |
void |
setMaxMessagePoints(int numPoints)
Sets the maximum number of reward points that can be assigned to a message. |
void |
setMaxThreadPoints(int numPoints)
Sets the maximum number of reward points that can be assigned to a thread. |
void |
setRewardsEnabled(boolean enabled)
Enables or disables the rewards feature. |
void |
transferPoints(ForumThread thread,
int numPoints)
Transfers the specified number of points to the thread. |
Method Detail |
---|
boolean isRewardsEnabled()
void setRewardsEnabled(boolean enabled) throws UnauthorizedException
enabled
- true to enable rewards, false otherwise.
UnauthorizedException
- if the user is not a system admin.int getMaxThreadPoints()
void setMaxThreadPoints(int numPoints) throws UnauthorizedException
numPoints
- the max number of reward points that can be assigned to
a thread, or -1 if there is no max.
UnauthorizedException
int getMaxMessagePoints()
void setMaxMessagePoints(int numPoints) throws UnauthorizedException
numPoints
- the max number of reward points that can be assigned to
a message, or -1 if there is no max.
UnauthorizedException
void transferPoints(ForumThread thread, int numPoints) throws UnauthorizedException, RewardException
thread
- the thread to transfer points to.numPoints
- the number of points to transfer.
UnauthorizedException
- if not the user that started the thread
or an admin.
RewardException
void rewardPoints(ForumMessage message, int numPoints) throws UnauthorizedException, RewardException
message
- the message receiving the reward.numPoints
- the number of points to reward the message with.
UnauthorizedException
- if not author of the thread the message
is in, or an administrator.
RewardException
- if one of the necessary conditions for this
method to execute is not met.int getPoints(ForumThread thread)
getMaxThreadPoints()
- getPointsRewarded(ForumThread)
.
thread
- the thread.
int getPointsRewarded(ForumThread thread)
getMaxThreadPoints()
- getPoints(ForumThread)
.
thread
- the thread.
int getPoints(ForumMessage message)
message
- the message.
boolean isBankEnabled()
void setBankEnabled(boolean enabled) throws UnauthorizedException
enabled
- true if bank points should be enabled; false otherwise.
UnauthorizedException
int getBankPoints(User user)
user
- the user.
void addBankPoints(User user, int numPoints) throws UnauthorizedException
getMaxBankPoints()
and will never be less than 0.
user
- the user to give points to.numPoints
- the number of points to put in the user's bank, which can be
negative.
UnauthorizedException
void addBankPoints(int numPoints) throws UnauthorizedException
getMaxBankPoints()
and will never be less than 0.
numPoints
- the bank points value.
UnauthorizedException
- if not the system administrator.int getInitialBankPoints()
void setInitialBankPoints(int initialBankPoints) throws UnauthorizedException
initialBankPoints
- the initial bank points.
UnauthorizedException
- if not the system administrator.int getMaxBankPoints()
void setMaxBankPoints(int maxBankPoints) throws UnauthorizedException
maxBankPoints
- the max size the bank account can grow to, or -1 if there
is no limit.
UnauthorizedException
- if not the system administrator.int getPendingRewardThreadsCount(User user)
user
- the user.
java.util.Iterator getPendingRewardThreads(User user)
user
- the user.
int getPointsRewarded(User user)
Points are not considered rewarded until they are actually transferred from a thread to
user
- the user.
int getPointsEarned(User user)
user
- the user.
int getPointsEarned(User user, ForumCategory category)
user
- the user.category
- the category.
int getPointsEarned(User user, Forum forum)
user
- the user.forum
- the forum.
java.util.Iterator getTopUsers(int startIndex, int numResults)
startIndex
- the starting index in the results list (0 to start
at the beginning of the list).numResults
- the number of results to return.
java.util.Iterator getTopUsers(int startIndex, int numResults, ForumCategory category)
startIndex
- the starting index in the results list (0 to start
at the beginning of the list).numResults
- the number of results to return.category
- the category.
java.util.Iterator getTopUsers(int startIndex, int numResults, Forum forum)
startIndex
- the starting index in the results list (0 to start
at the beginning of the list).numResults
- the number of results to return.forum
- the forum.
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |