|
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 |
java.lang.Objectcom.jivesoftware.forum.proxy.StatusLevelManagerProxy
public class StatusLevelManagerProxy
Constructor Summary | |
---|---|
StatusLevelManagerProxy(StatusLevelManager statusLevelManager,
AuthToken authToken,
Permissions permissions)
|
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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public StatusLevelManagerProxy(StatusLevelManager statusLevelManager, AuthToken authToken, Permissions permissions)
Method Detail |
---|
public StatusLevel createStatusLevel(java.lang.String name, java.lang.String imagePath, int minPoints, int maxPoints) throws UnauthorizedException, StatusLevelException, StatusLevelAlreadyExistsException
StatusLevelManager
createStatusLevel
in interface StatusLevelManager
name
- name of the status levelminPoints
- minimum amount in the point rangemaxPoints
- maximum amount in the point range
UnauthorizedException
- if not system admin
StatusLevelException
- if an illegal range is specified.
StatusLevelAlreadyExistsException
public StatusLevel createStatusLevel(java.lang.String name, java.lang.String imagePath, Group group) throws UnauthorizedException, StatusLevelException, StatusLevelAlreadyExistsException
StatusLevelManager
createStatusLevel
in interface StatusLevelManager
name
- name of the status levelgroup
- group to associate this status level with
UnauthorizedException
- if not system admin
StatusLevelException
StatusLevelAlreadyExistsException
public void deleteStatusLevel(StatusLevel statusLevel) throws UnauthorizedException
StatusLevelManager
deleteStatusLevel
in interface StatusLevelManager
statusLevel
- statusLevel level to delete
UnauthorizedException
- if not system adminpublic java.util.Iterator getGroupStatusLevels()
StatusLevelManager
getGroupStatusLevels
in interface StatusLevelManager
public java.util.Iterator getPointStatusLevels()
StatusLevelManager
getPointStatusLevels
in interface StatusLevelManager
public java.util.Iterator getLeaders()
StatusLevelManager
getLeaders
in interface StatusLevelManager
User
objects for system wide leaderspublic java.util.Iterator getLeaders(int startIndex, int numResults)
StatusLevelManager
getLeaders
in interface StatusLevelManager
User
objects for system wide leaderspublic java.util.Iterator getLeaders(Forum forum)
StatusLevelManager
getLeaders
in interface StatusLevelManager
forum
- forum to find leaders for
User
objects for a specific forumpublic java.util.Iterator getLeaders(Forum forum, int startIndex, int numResults)
StatusLevelManager
getLeaders
in interface StatusLevelManager
forum
- forum to find leaders for
User
objects for a specific forumpublic java.util.Iterator getLeaders(ForumCategory category)
StatusLevelManager
getLeaders
in interface StatusLevelManager
category
- forum category to find leaders for
User
objects for a specific forumpublic java.util.Iterator getLeaders(ForumCategory category, int startIndex, int numResults)
StatusLevelManager
getLeaders
in interface StatusLevelManager
category
- forum category to find leaders for
User
objects for a specific forumpublic StatusLevel getStatusLevel(long statusLevelID) throws StatusLevelNotFoundException
StatusLevelManager
getStatusLevel
in interface StatusLevelManager
statusLevelID
- the id of the object to acquire
StatusLevelNotFoundException
- thrown if the object does not exist in the systempublic StatusLevel getStatusLevel(java.lang.String name) throws StatusLevelNotFoundException
StatusLevelManager
getStatusLevel
in interface StatusLevelManager
name
- name of the status level
StatusLevelNotFoundException
- thrown if the object does not exist in the systempublic StatusLevel getStatusLevel(User user)
StatusLevelManager
getStatusLevel
in interface StatusLevelManager
user
- user to find the status level for
public StatusLevel getStatusLevel(User user, Forum forum)
StatusLevelManager
getStatusLevel
in interface StatusLevelManager
user
- user to find the status level forforum
- forum to check the status level for
public StatusLevel getStatusLevel(User user, ForumCategory category)
StatusLevelManager
getStatusLevel
in interface StatusLevelManager
user
- user to find the status level forcategory
- category to check the status level for
public void setStatusLevelsEnabled(boolean statusLevelEnabled) throws UnauthorizedException
StatusLevelManager
setStatusLevelsEnabled
in interface StatusLevelManager
statusLevelEnabled
- true if status levels are enabled, else false
UnauthorizedException
- if not system adminpublic boolean isStatusLevelsEnabled()
StatusLevelManager
isStatusLevelsEnabled
in interface StatusLevelManager
public StatusLevel getStatusLevelByPoints(int points)
StatusLevelManager
getStatusLevelByPoints
in interface StatusLevelManager
points
- point value find a status level for
public int getPointLevel(User user)
StatusLevelManager
getPointLevel
in interface StatusLevelManager
user
- user to get status level points for
public int getPointLevel(User user, Forum forum)
StatusLevelManager
getPointLevel
in interface StatusLevelManager
user
- user user to get status level points forforum
- forum to filter by
public int getPointLevel(User user, ForumCategory category)
StatusLevelManager
getPointLevel
in interface StatusLevelManager
user
- user user to get status level points forcategory
- category to filter by
public StatusLevel getStatusLevel(Group group)
StatusLevelManager
getStatusLevel
in interface StatusLevelManager
group
- group to find a status level for
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |