|
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.opensymphony.xwork.ActionSupport
com.jivesoftware.base.action.JiveActionSupport
com.jivesoftware.forum.action.ForumActionSupport
com.jivesoftware.profiles.action.SearchProfile
public class SearchProfile
An action responsible for searching, sorting, and displaying expert users.
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 |
---|
public static final int RANGE
public static final int SORT_RELEVANCE
public static final int SORT_STATUS_LEVEL
public static final int SORT_CREATION_DATE
Constructor Detail |
---|
public SearchProfile()
Method Detail |
---|
public void setProfileFieldManager(ProfileFieldManager profileFieldManager)
setProfileFieldManager
in interface ProfileFieldManagerAware
public void setProfileSearchManager(ProfileSearchManager profileSearchManager)
setProfileSearchManager
in interface ProfileSearchManagerAware
public void setForumFactory(ForumFactory forumFactory)
ForumActionSupport
setForumFactory
in interface ForumFactoryAware
setForumFactory
in class ForumActionSupport
forumFactory
- an instance of ForumFactory
public void setUser(User user)
setUser
in interface UserAware
setUser
in class ForumActionSupport
public java.lang.String doInput() throws java.lang.Exception
doInput
in class com.opensymphony.xwork.ActionSupport
java.lang.Exception
public java.lang.String execute() throws java.lang.Exception
ForumActionSupport
execute
in interface com.opensymphony.xwork.Action
execute
in class ForumActionSupport
java.lang.Exception
public java.util.List getFields()
public java.util.List getResults()
public Paginator getPaginator()
public java.lang.String getQuery()
public void setQuery(java.lang.String query)
public boolean isUsernameEnabled()
public void setUsernameEnabled(boolean usernameEnabled)
public boolean isNameEnabled()
public void setNameEnabled(boolean nameEnabled)
public boolean isEmailEnabled()
public void setEmailEnabled(boolean emailEnabled)
public boolean isProfileEnabled()
public void setProfileEnabled(boolean profileEnabled)
public int getSortOption()
public void setSortOption(int sortOption)
public java.util.List getSearchFilters()
public void setSearchFilters(java.util.List searchFilters)
public java.lang.String getObjectID()
public void setObjectID(java.lang.String objectID)
public boolean isStopSearch()
public int getStopSearchCount()
public void setSearch(boolean search)
public int getRange()
public void setRange(int range)
public int getStart()
Pageable
getStart
in interface Pageable
public void setStart(int start)
public int getTotalItemCount()
Pageable
getTotalItemCount
in interface Pageable
public ResultFilter getResultFilter()
Pageable
getResultFilter
in interface Pageable
public ForumFactory getForumFactory()
ForumActionSupport
getForumFactory
in class ForumActionSupport
ForumFactory
public IMService getXMPPIMService()
public IMService getAIMIMService()
public User getPageUser()
ForumActionSupport
The best way to test for guest status is to call
JiveActionSupport.isGuest()
.
getPageUser
in class ForumActionSupport
User
public boolean isEmailVisible()
public boolean isSystemAdmin()
ForumActionSupport
isSystemAdmin
in class ForumActionSupport
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |