Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.profiles.action
Class SearchProfile

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.profiles.action.SearchProfile
All Implemented Interfaces:
AuthTokenAware, EntityAware, UserAware, ForumFactoryAware, Pageable, ProfileFieldManagerAware, ProfileSearchManagerAware, 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 SearchProfile
extends ForumActionSupport
implements ProfileFieldManagerAware, ProfileSearchManagerAware, ForumFactoryAware, UserAware, Pageable

An action responsible for searching, sorting, and displaying expert users.

See Also:
Serialized Form

Field Summary
static int RANGE
          Default number of search results (users) to show on one page.
static int SORT_CREATION_DATE
          Flag for sorting results by creation date.
static int SORT_RELEVANCE
          Flag for sorting results by relevance.
static int SORT_STATUS_LEVEL
          Flag for sorting results by status level.
 
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
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
SearchProfile()
           
 
Method Summary
 java.lang.String doInput()
           
 java.lang.String execute()
          Default implementation of doExecute() method.
 IMService getAIMIMService()
           
 java.util.List getFields()
           
 ForumFactory getForumFactory()
          Returns a reference to the ForumFactory object.
 java.lang.String getObjectID()
           
 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()
           
 java.util.List getSearchFilters()
           
 int getSortOption()
           
 int getStart()
          Returns the starting index in the item list.
 int getStopSearchCount()
           
 int getTotalItemCount()
          Returns the total number of items our list/collection/whatever.
 IMService getXMPPIMService()
           
 boolean isEmailEnabled()
           
 boolean isEmailVisible()
           
 boolean isNameEnabled()
           
 boolean isProfileEnabled()
           
 boolean isStopSearch()
           
 boolean isSystemAdmin()
          Returns true if the page user is the system admin, false otherwise.
 boolean isUsernameEnabled()
           
 void setEmailEnabled(boolean emailEnabled)
           
 void setForumFactory(ForumFactory forumFactory)
          Sets the forum factory -- useful for developers who subclass this class.
 void setNameEnabled(boolean nameEnabled)
           
 void setObjectID(java.lang.String objectID)
           
 void setProfileEnabled(boolean profileEnabled)
           
 void setProfileFieldManager(ProfileFieldManager profileFieldManager)
           
 void setProfileSearchManager(ProfileSearchManager profileSearchManager)
           
 void setQuery(java.lang.String query)
           
 void setRange(int range)
           
 void setSearch(boolean search)
           
 void setSearchFilters(java.util.List searchFilters)
           
 void setSortOption(int sortOption)
           
 void setStart(int start)
           
 void setUser(User user)
           
 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, getReadStatus, getSkinProperty, getThemeName, isAdmin, isAdmin, isAuthor, isAuthor, isMessageModerationOn, isModerator, isModerator, isResourceInTheme, isThreadModerationOn
 
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

SORT_RELEVANCE

public static final int SORT_RELEVANCE
Flag for sorting results by relevance.

See Also:
Constant Field Values

SORT_STATUS_LEVEL

public static final int SORT_STATUS_LEVEL
Flag for sorting results by status level.

See Also:
Constant Field Values

SORT_CREATION_DATE

public static final int SORT_CREATION_DATE
Flag for sorting results by creation date.

See Also:
Constant Field Values
Constructor Detail

SearchProfile

public SearchProfile()
Method Detail

setProfileFieldManager

public void setProfileFieldManager(ProfileFieldManager profileFieldManager)
Specified by:
setProfileFieldManager in interface ProfileFieldManagerAware

setProfileSearchManager

public void setProfileSearchManager(ProfileSearchManager profileSearchManager)
Specified by:
setProfileSearchManager in interface ProfileSearchManagerAware

setForumFactory

public void setForumFactory(ForumFactory forumFactory)
Description copied from class: ForumActionSupport
Sets the forum factory -- useful for developers who subclass this class. Set the forum factory if you need to change a user or do a login and need a forum factory object with the correct permissions.

Specified by:
setForumFactory in interface ForumFactoryAware
Overrides:
setForumFactory in class ForumActionSupport
Parameters:
forumFactory - an instance of ForumFactory

setUser

public void setUser(User user)
Specified by:
setUser in interface UserAware
Overrides:
setUser in class ForumActionSupport

doInput

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

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

getFields

public java.util.List getFields()

getResults

public java.util.List getResults()

getPaginator

public Paginator getPaginator()

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)

isProfileEnabled

public boolean isProfileEnabled()

setProfileEnabled

public void setProfileEnabled(boolean profileEnabled)

getSortOption

public int getSortOption()

setSortOption

public void setSortOption(int sortOption)

getSearchFilters

public java.util.List getSearchFilters()

setSearchFilters

public void setSearchFilters(java.util.List searchFilters)

getObjectID

public java.lang.String getObjectID()

setObjectID

public void setObjectID(java.lang.String objectID)

isStopSearch

public boolean isStopSearch()

getStopSearchCount

public int getStopSearchCount()

setSearch

public void setSearch(boolean search)

getRange

public int getRange()

setRange

public void setRange(int range)

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.

setStart

public void setStart(int start)

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.

getForumFactory

public ForumFactory getForumFactory()
Description copied from class: ForumActionSupport
Returns a reference to the ForumFactory object. All Jive objects are rooted in the forum factory class.

Overrides:
getForumFactory in class ForumActionSupport
Returns:
a reference to the ForumFactory object.
See Also:
ForumFactory

getXMPPIMService

public IMService getXMPPIMService()

getAIMIMService

public IMService getAIMIMService()

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

isEmailVisible

public boolean isEmailVisible()

isSystemAdmin

public boolean isSystemAdmin()
Description copied from class: ForumActionSupport
Returns true if the page user is the system admin, false otherwise.

Overrides:
isSystemAdmin in class ForumActionSupport
Returns:
true if the page user is the system admin, false otherwise.

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.