Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.action
Class UserSearch

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.UserSearch
All Implemented Interfaces:
AuthTokenAware, EntityAware, UserAware, ForumFactoryAware, Pageable, 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
Direct Known Subclasses:
UserPicker

public class UserSearch
extends ForumActionSupport
implements Pageable

An action to search user account information.

See Also:
Serialized Form

Field Summary
static int RANGE
          Default number of search results (users) to show on one page.
 
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
UserSearch()
           
 
Method Summary
 java.lang.String doInput()
           
 java.lang.String execute()
          Default implementation of doExecute() method.
 User getPageUser()
          Returns the current page user's User object, or null if the user is a guest.
 Paginator getPaginator()
           
 java.lang.String getQuery()
           
 int getRange()
           
 ResultFilter getResultFilter()
          Returns a Jive Forums result filter - this gives us a handle on the current index in the list and the number of items per page.
 java.util.List getResults()
           
 int getStart()
          Returns the starting index in the item list.
 int getTotalItemCount()
          Returns the total number of items our list/collection/whatever.
 boolean isEmailEnabled()
           
 boolean isNameEnabled()
           
 boolean isUsernameEnabled()
           
 void setEmailEnabled(boolean emailEnabled)
           
 void setNameEnabled(boolean nameEnabled)
           
 void setQuery(java.lang.String query)
           
 void setRange(int range)
           
 void setStart(int start)
           
 void setUsernameEnabled(boolean usernameEnabled)
           
 
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, 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, 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
 

Field Detail

RANGE

public static final int RANGE
Default number of search results (users) to show on one page.

See Also:
Constant Field Values
Constructor Detail

UserSearch

public UserSearch()
Method Detail

doInput

public java.lang.String doInput()
                         throws java.lang.Exception
Overrides:
doInput in class com.opensymphony.xwork.ActionSupport
Throws:
java.lang.Exception

getPageUser

public User getPageUser()
Description copied from class: ForumActionSupport
Returns the current page user's User object, or null if the user is a guest.

The best way to test for guest status is to call JiveActionSupport.isGuest().

Overrides:
getPageUser in class ForumActionSupport
Returns:
the current page user's User object or null if the user is a geust.
See Also:
User

execute

public java.lang.String execute()
                         throws java.lang.Exception
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
Throws:
java.lang.Exception

getStart

public int getStart()
Description copied from interface: Pageable
Returns the starting index in the item list. This will be within the range of 0 to getTotalItemCount()-1.

Specified by:
getStart in interface Pageable
Returns:
the starting index in the item list.

getTotalItemCount

public int getTotalItemCount()
Description copied from interface: Pageable
Returns the total number of items our list/collection/whatever. This number will always be > 0.

Specified by:
getTotalItemCount in interface Pageable
Returns:
the total number of items we're looking at.

getResultFilter

public ResultFilter getResultFilter()
Description copied from interface: Pageable
Returns a Jive Forums result filter - this gives us a handle on the current index in the list and the number of items per page.

Specified by:
getResultFilter in interface Pageable
Returns:
a Forums result filter.

setStart

public void setStart(int start)

getRange

public int getRange()

setRange

public void setRange(int range)

getQuery

public java.lang.String getQuery()

setQuery

public void setQuery(java.lang.String query)

isUsernameEnabled

public boolean isUsernameEnabled()

setUsernameEnabled

public void setUsernameEnabled(boolean usernameEnabled)

isNameEnabled

public boolean isNameEnabled()

setNameEnabled

public void setNameEnabled(boolean nameEnabled)

isEmailEnabled

public boolean isEmailEnabled()

setEmailEnabled

public void setEmailEnabled(boolean emailEnabled)

getResults

public java.util.List getResults()

getPaginator

public Paginator getPaginator()

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.