Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum
Interface StatusLevelManager

All Known Implementing Classes:
DbStatusLevelManager, StatusLevelManagerProxy

public interface StatusLevelManager

Manages status level feature. StatusLevel levels allow the system to rank users by points or associate users with a specific group.

See Also:
StatusLevel

Method Summary
 StatusLevel createStatusLevel(java.lang.String name, java.lang.String imagePath, Group group)
          Creates a new group based StatusLevel Level
 StatusLevel createStatusLevel(java.lang.String name, java.lang.String imagePath, int minPoints, int maxPoints)
          Creates a new points based StatusLevel.
 void deleteStatusLevel(StatusLevel statusLevel)
          Deletes a statusLevel level from the system
 java.util.Iterator getGroupStatusLevels()
          Returns an iterator of all group based status levels in the system.
 java.util.Iterator getLeaders()
          Returns an Iterator of system wide leaders.
 java.util.Iterator getLeaders(Forum forum)
          Returns an Iterator of leaders for a specific forum
 java.util.Iterator getLeaders(ForumCategory category)
          Returns an Iterator of leaders for a specific forum category
 java.util.Iterator getLeaders(ForumCategory category, int startIndex, int numResults)
          Returns an Iterator of leaders for a specific forum category
 java.util.Iterator getLeaders(Forum forum, int startIndex, int numResults)
          Returns an Iterator of leaders for a specific forum
 java.util.Iterator getLeaders(int startIndex, int numResults)
          Returns an Iterator of system wide leaders.
 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
 java.util.Iterator getPointStatusLevels()
          Returns an iterator of point based status levels in the system sorted by point range.
 StatusLevel getStatusLevel(Group group)
          If there is a status level associated with the group passed in then the status level will be returned, Otherwise null will be returned.
 StatusLevel getStatusLevel(long statusLevelID)
          Used to acquire a specific status level object from the system
 StatusLevel getStatusLevel(java.lang.String name)
          Used to acquire a specific status level by its name
 StatusLevel getStatusLevel(User user)
          Returns the system wide status level for specific user, will return null if there is no status level for this user.
 StatusLevel getStatusLevel(User user, Forum forum)
          Returns the status level for a user in a specific forum. if a status level cannot be determined for this user in this forum null will be returned.
 StatusLevel getStatusLevel(User user, ForumCategory category)
          Returns the status level for a user in a specific category. if a status level cannot be determined for this user in this category null will be returned.
 StatusLevel getStatusLevelByPoints(int points)
          Used to get a status level by a point value.
 boolean isStatusLevelsEnabled()
          Returns true if status levels are enabled in the system
 void setStatusLevelsEnabled(boolean statusLevelEnabled)
          Sets whether status levels should be enabled in the system.
 

Method Detail

createStatusLevel

StatusLevel createStatusLevel(java.lang.String name,
                              java.lang.String imagePath,
                              int minPoints,
                              int maxPoints)
                              throws UnauthorizedException,
                                     StatusLevelException,
                                     StatusLevelAlreadyExistsException
Creates a new points based StatusLevel. The minPoints and maxPoints range must not intersect, and maxPoints cannot be zero. Specify -1 in either to denote a boundless range (ie minPoints=50, maxPoints=-1 would mean everything over 50 has this status level)

The minPoints and maxPoints values must not go into the range over another StatusLevel levels point range.

Parameters:
name - name of the status level
imagePath -
minPoints - minimum amount in the point range
maxPoints - maximum amount in the point range
Returns:
The newly created status level object
Throws:
UnauthorizedException - if not system admin
StatusLevelException - if an illegal range is specified.
StatusLevelAlreadyExistsException

createStatusLevel

StatusLevel createStatusLevel(java.lang.String name,
                              java.lang.String imagePath,
                              Group group)
                              throws UnauthorizedException,
                                     StatusLevelException,
                                     StatusLevelAlreadyExistsException
Creates a new group based StatusLevel Level

Parameters:
name - name of the status level
imagePath -
group - group to associate this status level with
Returns:
newly created status level object
Throws:
UnauthorizedException - if not system admin
StatusLevelException
StatusLevelAlreadyExistsException

deleteStatusLevel

void deleteStatusLevel(StatusLevel statusLevel)
                       throws UnauthorizedException
Deletes a statusLevel level from the system

Parameters:
statusLevel - statusLevel level to delete
Throws:
UnauthorizedException - if not system admin

getGroupStatusLevels

java.util.Iterator getGroupStatusLevels()
Returns an iterator of all group based status levels in the system.

Returns:
an iterator of all group based status levels in the system.

getPointStatusLevels

java.util.Iterator getPointStatusLevels()
Returns an iterator of point based status levels in the system sorted by point range.

Returns:
point range sorted iterator of StatusLevel objects

getLeaders

java.util.Iterator getLeaders()
Returns an Iterator of system wide leaders.

Returns:
Iterator of User objects for system wide leaders

getLeaders

java.util.Iterator getLeaders(int startIndex,
                              int numResults)
Returns an Iterator of system wide leaders.

Returns:
Iterator of User objects for system wide leaders

getLeaders

java.util.Iterator getLeaders(Forum forum)
Returns an Iterator of leaders for a specific forum

Parameters:
forum - forum to find leaders for
Returns:
Iterator of User objects for a specific forum

getLeaders

java.util.Iterator getLeaders(Forum forum,
                              int startIndex,
                              int numResults)
Returns an Iterator of leaders for a specific forum

Parameters:
forum - forum to find leaders for
Returns:
Iterator of User objects for a specific forum

getLeaders

java.util.Iterator getLeaders(ForumCategory category)
Returns an Iterator of leaders for a specific forum category

Parameters:
category - forum category to find leaders for
Returns:
Iterator of User objects for a specific forum

getLeaders

java.util.Iterator getLeaders(ForumCategory category,
                              int startIndex,
                              int numResults)
Returns an Iterator of leaders for a specific forum category

Parameters:
category - forum category to find leaders for
Returns:
Iterator of User objects for a specific forum

getStatusLevel

StatusLevel getStatusLevel(long statusLevelID)
                           throws StatusLevelNotFoundException
Used to acquire a specific status level object from the system

Parameters:
statusLevelID - the id of the object to acquire
Returns:
the object found in the system
Throws:
StatusLevelNotFoundException - thrown if the object does not exist in the system

getStatusLevel

StatusLevel getStatusLevel(java.lang.String name)
                           throws StatusLevelNotFoundException
Used to acquire a specific status level by its name

Parameters:
name - name of the status level
Returns:
the object found in the system
Throws:
StatusLevelNotFoundException - thrown if the object does not exist in the system

getStatusLevel

StatusLevel getStatusLevel(User user)
Returns the system wide status level for specific user, will return null if there is no status level for this user.

If the user belongs to a group status level the group status level will always be returned.

Parameters:
user - user to find the status level for
Returns:
system wide status level for the user or null if no status level

getStatusLevel

StatusLevel getStatusLevel(User user,
                           Forum forum)
Returns the status level for a user in a specific forum. if a status level cannot be determined for this user in this forum null will be returned.

If the user belongs to a group status level the group status level will always be returned.

Parameters:
user - user to find the status level for
forum - forum to check the status level for
Returns:
forum specific status level or null if no status level can be determined

getStatusLevel

StatusLevel getStatusLevel(User user,
                           ForumCategory category)
Returns the status level for a user in a specific category. if a status level cannot be determined for this user in this category null will be returned.

If the user belongs to a group status level the group status level will always be returned.

Parameters:
user - user to find the status level for
category - category to check the status level for
Returns:
category specific status level or null if no status level can be determined

setStatusLevelsEnabled

void setStatusLevelsEnabled(boolean statusLevelEnabled)
                            throws UnauthorizedException
Sets whether status levels should be enabled in the system.

Parameters:
statusLevelEnabled - true if status levels are enabled, else false
Throws:
UnauthorizedException - if not system admin

isStatusLevelsEnabled

boolean isStatusLevelsEnabled()
Returns true if status levels are enabled in the system

Returns:
true if status levels are enabled

getStatusLevelByPoints

StatusLevel getStatusLevelByPoints(int points)
Used to get a status level by a point value. If the points exceeds that of the maximum status level, the maximum status level will be returned.

Parameters:
points - point value find a status level for
Returns:
the StatusLevel matching a point level, or null if non is found

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

getStatusLevel

StatusLevel getStatusLevel(Group group)
If there is a status level associated with the group passed in then the status level will be returned, Otherwise null will be returned.

Parameters:
group - group to find a status level for
Returns:
status level that is associated with group, else null

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.