Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.action
Class StatusLevelLeadersAction

java.lang.Object
  extended by com.opensymphony.xwork.ActionSupport
      extended by com.jivesoftware.base.action.JiveActionSupport
          extended by com.jivesoftware.forum.action.ForumActionSupport
              extended by com.jivesoftware.forum.action.StatusLevelLeadersAction
All Implemented Interfaces:
AuthTokenAware, EntityAware, UserAware, ForumFactoryAware, com.opensymphony.webwork.interceptor.ServletRequestAware, com.opensymphony.webwork.interceptor.ServletResponseAware, com.opensymphony.xwork.Action, com.opensymphony.xwork.LocaleProvider, com.opensymphony.xwork.TextProvider, com.opensymphony.xwork.Validateable, com.opensymphony.xwork.ValidationAware, com.uwyn.rife.continuations.ContinuableObject, java.io.Serializable, java.lang.Cloneable

public class StatusLevelLeadersAction
extends ForumActionSupport

Used to construct status level leaderboards.

If no categoryID or forumID then the system leaders will be returned by getLeaders, otherwise catory or forum leaders.

To change the range of leaders displayed specify a startIndex and numResults.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.jivesoftware.forum.action.ForumActionSupport
CANCEL, DISABLED, FATAL, NOTFOUND, SESSION_REFERRER_KEY, UNAUTHORIZED
 
Fields inherited from class com.jivesoftware.base.action.JiveActionSupport
pageUser, request, response
 
Fields inherited from class com.opensymphony.xwork.ActionSupport
LOG
 
Fields inherited from interface com.opensymphony.xwork.Action
ERROR, INPUT, LOGIN, NONE, SUCCESS
 
Constructor Summary
StatusLevelLeadersAction()
           
 
Method Summary
 java.lang.String execute()
          Default implementation of doExecute() method.
 ForumCategory getCategory()
          Returns the category we're working with or null if this is a forum or global leader list.
 long getCategoryID()
          Returns the requested category ID.
 Forum getForum()
          Returns the forum we're working with or null if this is a category or global leader list.
 long getForumID()
          Returns the requested forum ID.
 java.util.Iterator getLeaders()
          Resturns an iterator of leader users either globally, per category or per forum.
 boolean isRootCategory()
          Returns true if the given category is the root, false otherwise.
 void loadJiveObjects()
           
 void setCategoryID(long categoryID)
          Sets the category ID to use for a list of category leaders.
 void setForumID(long forumID)
          Sets the forum ID to use for a list of forum leaders.
 void setNumResults(int numResults)
          If use in conjunction with numResults you can specify a different amount of results to return and where to start
 void setStartIndex(int startIndex)
          If use in conjunction with numResults you can specify a different amount of results to return and where to start
 
Methods inherited from class com.jivesoftware.forum.action.ForumActionSupport
getCanAttach, getCanCreateMessage, getCanCreatePoll, getCanCreatePoll, getCanCreateThread, getCanCreateThread, getCanEdit, getCanEditAttach, getCanEditPoll, getCanEditPoll, getCanEditProfile, getCanEditTags, getCanPostAnnounce, getCanPostAnnounce, getCanRead, getCanRead, getEntityDescriptor, getForumFactory, getPageUser, getReadStatus, getSkinProperty, getThemeName, isAdmin, isAdmin, isAuthor, isAuthor, isMessageModerationOn, isModerator, isModerator, isResourceInTheme, isSystemAdmin, isThreadModerationOn, setForumFactory, setUser
 
Methods inherited from class com.jivesoftware.base.action.JiveActionSupport
getAuthToken, getGuestProperty, getJiveProperty, getLocales, getPageURL, getSession, getText, getText, getTimeZone, getTimeZones, isFailedLookup, isGuest, setAuthToken, setGuestProperty, setLoginAttributes, setPageUser, setServletRequest, setServletResponse
 
Methods inherited from class com.opensymphony.xwork.ActionSupport
addActionError, addActionMessage, addFieldError, clearErrorsAndMessages, clone, doDefault, doInput, getActionErrors, getActionMessages, getErrorMessages, getErrors, getFieldErrors, getLocale, getText, getText, getText, getText, getText, getText, getText, getTexts, getTexts, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, hasKey, pause, setActionErrors, setActionMessages, setFieldErrors, validate
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

StatusLevelLeadersAction

public StatusLevelLeadersAction()
Method Detail

getCategoryID

public long getCategoryID()
Returns the requested category ID.


setCategoryID

public void setCategoryID(long categoryID)
Sets the category ID to use for a list of category leaders.


getForumID

public long getForumID()
Returns the requested forum ID.


setForumID

public void setForumID(long forumID)
Sets the forum ID to use for a list of forum leaders.


setStartIndex

public void setStartIndex(int startIndex)
If use in conjunction with numResults you can specify a different amount of results to return and where to start

Parameters:
startIndex - starting index

setNumResults

public void setNumResults(int numResults)
If use in conjunction with numResults you can specify a different amount of results to return and where to start

Parameters:
numResults - amount results to return

getLeaders

public java.util.Iterator getLeaders()
Resturns an iterator of leader users either globally, per category or per forum.

Returns:
Iteraor of User objects

getCategory

public ForumCategory getCategory()
Returns the category we're working with or null if this is a forum or global leader list.


getForum

public Forum getForum()
Returns the forum we're working with or null if this is a category or global leader list.


isRootCategory

public boolean isRootCategory()
Returns true if the given category is the root, false otherwise.


execute

public java.lang.String execute()
Description copied from class: ForumActionSupport
Default implementation of doExecute() method. This class is intended to be a base class for other actions but can be used as an action itself if the skin author simply wants to get access to the context & methods provided by this class.

Specified by:
execute in interface com.opensymphony.xwork.Action
Overrides:
execute in class ForumActionSupport
Returns:
Action.SUCCESS

loadJiveObjects

public void loadJiveObjects()

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.