|
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.forum.action.SearchAction
public class SearchAction
An Action to encapsulate all the logic of searching forum content.
Field Summary | |
---|---|
static RelativeDateRange[] |
DATE_RANGES
|
static RelativeDateRange |
DEFAULT_DATE_RANGE
|
static int |
DEFAULT_NUM_RESULTS
|
static int[] |
RESULT_OPTIONS
|
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 | |
---|---|
SearchAction()
|
Method Summary | |
---|---|
java.lang.String |
doDefault()
|
java.lang.String |
execute()
Default implementation of doExecute() method. |
long[] |
getCategoryID()
|
boolean |
getCategorySelected(long cID)
|
java.lang.String |
getCorrectedQ()
|
java.lang.String |
getCorrectedSearchParams()
Creates a partial query string which can be used to reconstruct the parameter list that executed a search. |
java.lang.String |
getDateRange()
|
RelativeDateRange[] |
getDateRanges()
Returns a list of the possible date ranges allowed in a search. |
long[] |
getForumID()
|
boolean |
getForumSelected(long fID)
|
java.lang.String[] |
getHighlightedText(QueryResult result)
Returns a subject and summary with search words highlighted appropriate to the search query string. |
java.lang.String |
getMessageBodyPreview(ForumMessage message)
Deprecated. Use getHighlightedText(QueryResult) instead |
java.lang.String |
getMessageSubjectPreview(ForumMessage message)
Deprecated. Use getHighlightedText(QueryResult) instead |
int[] |
getNumResultOptions()
Returns a list of the result count options. |
int |
getNumResults()
|
java.lang.String[] |
getObjID()
|
java.lang.String |
getObjIDValue()
Returns the single objID value that was searched. |
java.lang.String |
getQ()
|
java.lang.String |
getQenc()
|
int |
getRankBy()
Returns the current method of ranking results. |
int |
getResultByForumCount(Forum forum)
Returns the total number of results for the given forum. |
int |
getResultCount()
Returns the total number of results for this search. |
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.Iterator |
getResults()
Returns an Iterator of QueryResult objects which represent the results of a search, or an empty iterator if there were no results. |
int |
getResultStart()
Returns the number of the first result on a result page. |
java.util.List |
getSearchedCategories()
Returns a list of the categories being explictly searched or null if no categories are being explictly searched. |
ForumCategory |
getSearchedCategory()
Returns the single category being searched, or null if no categories are being searched or if there is more than one category being searched. |
Forum |
getSearchedForum()
Returns the single forum being searched or null if no forum was specified or if there is more than one forum being searched. |
java.util.List |
getSearchedForums()
Returns a list of the forums being explicitly searched or null if no forums are being explicitly searched. |
java.util.Iterator |
getSearchedForumsFromQuery()
Returns a list of Forum s which were searched by the query, even if no forumID was specified. |
User |
getSearchedUser()
Returns the user used to filter searches or null if none was specified. |
long |
getSearchID()
Returns the search ID for the current search |
java.lang.String |
getSearchParams()
Creates a partial query string which can be used to reconstruct the parameter list that executed a search. |
int |
getStart()
Returns the starting index in the item list. |
java.lang.String |
getThreadID()
|
int |
getTotalItemCount()
Returns the total number of items our list/collection/whatever. |
java.lang.String |
getUserID()
|
boolean |
isAdvanced()
|
boolean |
isDisplayPerThread()
|
boolean |
isSpellSuggestOn()
|
void |
setAdvanced(boolean advanced)
|
void |
setCategoryID(long[] categoryID)
|
void |
setDateRange(java.lang.String dateRange)
|
void |
setDisplayPerThread(boolean displayPerThread)
|
void |
setForumID(long[] forumID)
|
void |
setNumResults(int numResults)
|
void |
setObjID(java.lang.String[] objID)
|
void |
setQ(java.lang.String q)
|
void |
setQenc(java.lang.String qenc)
|
void |
setRankBy(int rankBy)
Sets the method to rank results. |
void |
setSearchID(long searchID)
Used to set a previously retrieved searchID. |
void |
setSpellSuggestOn(boolean spellSuggestOn)
|
void |
setStart(int start)
|
void |
setThreadID(java.lang.String threadID)
|
void |
setUserID(java.lang.String userID)
|
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, 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 |
Field Detail |
---|
public static final int DEFAULT_NUM_RESULTS
public static final int[] RESULT_OPTIONS
public static final RelativeDateRange DEFAULT_DATE_RANGE
public static final RelativeDateRange[] DATE_RANGES
Constructor Detail |
---|
public SearchAction()
Method Detail |
---|
public java.lang.String[] getObjID()
public void setObjID(java.lang.String[] objID)
public long getSearchID()
public void setSearchID(long searchID)
searchID
- public long[] getCategoryID()
public void setCategoryID(long[] categoryID)
public long[] getForumID()
public void setForumID(long[] forumID)
public java.lang.String getUserID()
public void setUserID(java.lang.String userID)
public java.lang.String getThreadID()
public void setThreadID(java.lang.String threadID)
public boolean isSpellSuggestOn()
public void setSpellSuggestOn(boolean spellSuggestOn)
public boolean isDisplayPerThread()
public void setDisplayPerThread(boolean displayPerThread)
public boolean isAdvanced()
public void setAdvanced(boolean advanced)
public int getNumResults()
public void setNumResults(int numResults)
public int getRankBy()
public void setRankBy(int rankBy)
public java.lang.String getDateRange()
public void setDateRange(java.lang.String dateRange)
public java.lang.String getQ()
public void setQ(java.lang.String q)
public java.lang.String getQenc()
public void setQenc(java.lang.String qenc)
public java.lang.String getCorrectedQ()
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 int getResultStart()
public java.lang.String getObjIDValue()
public boolean getForumSelected(long fID)
public boolean getCategorySelected(long cID)
public ForumCategory getSearchedCategory()
public java.util.List getSearchedCategories()
public Forum getSearchedForum()
public java.util.List getSearchedForums()
public RelativeDateRange[] getDateRanges()
public User getSearchedUser()
public int[] getNumResultOptions()
public java.lang.String getSearchParams()
Example: q=foo+bar&objID=3&userID=joe
Only parameters actually used or different from default values will be returned.
public java.lang.String getCorrectedSearchParams()
Example: q=foo+bar&objID=3&userID=joe
Only parameters actually used or different from default values will be returned.
public java.util.Iterator getResults()
public int getResultCount()
public java.util.Iterator getSearchedForumsFromQuery()
Forum
s which were searched by the query, even if no forumID was specified.
Forum
s, or an empty list if no query was run.public int getResultByForumCount(Forum forum)
forum
-
public java.lang.String[] getHighlightedText(QueryResult result)
result
- the QueryResult to highlight
public java.lang.String getMessageSubjectPreview(ForumMessage message)
getHighlightedText(QueryResult)
instead
public java.lang.String getMessageBodyPreview(ForumMessage message)
getHighlightedText(QueryResult)
instead
public java.lang.String doDefault()
doDefault
in class com.opensymphony.xwork.ActionSupport
public java.lang.String execute()
ForumActionSupport
execute
in interface com.opensymphony.xwork.Action
execute
in class ForumActionSupport
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |