|
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.rss.RSSActionSupport
com.jivesoftware.forum.action.rss.RSSSearch
public class RSSSearch
A simple action to return the list of search result messages in a category or the whole system that match a given search query. Note, this feed is designed to syndicate content to other parts of your site and not necessarily serve information to users directly.
Field Summary |
---|
Fields inherited from class com.jivesoftware.base.action.rss.RSSActionSupport |
---|
DATE_FORMAT, DEFAULT_NUM_ITEMS, DISABLED, 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 | |
---|---|
RSSSearch()
|
Method Summary | |
---|---|
java.lang.String |
executeRSS()
Main action execution method - returns Action.SUCCESS by default. |
long |
getCategoryID()
|
java.lang.String |
getDateRange()
|
java.lang.String |
getFeedTitle()
Returns the title of the RSS feed |
long |
getForumID()
|
int |
getRankBy()
|
int |
getResultRange()
|
java.lang.String |
getSearchQuery()
|
java.util.Iterator |
getSearchResults()
|
boolean |
isFull()
|
void |
setCategoryID(long categoryID)
|
void |
setDateRange(java.lang.String dateRange)
|
void |
setForumID(long forumID)
|
void |
setFull(boolean full)
|
void |
setRankBy(int rankBy)
|
void |
setResultRange(int resultRange)
|
void |
setSearchQuery(java.lang.String searchQuery)
|
Methods inherited from class com.jivesoftware.base.action.rss.RSSActionSupport |
---|
execute, getAuthToken, getDateFormat, getDefaultBaseURL, getNumItems, getPageUser, getPassword, getUsername, rssFeedsEnabled, setAuthToken, setNumItems, setPassword, setServletRequest, setServletResponse, setUsername |
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, 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 |
---|
public RSSSearch()
Method Detail |
---|
public java.lang.String getSearchQuery()
public void setSearchQuery(java.lang.String searchQuery)
public long getCategoryID()
public void setCategoryID(long categoryID)
public long getForumID()
public void setForumID(long forumID)
public java.lang.String getDateRange()
public void setDateRange(java.lang.String dateRange)
public int getRankBy()
public void setRankBy(int rankBy)
public int getResultRange()
public void setResultRange(int resultRange)
public boolean isFull()
public void setFull(boolean full)
public java.util.Iterator getSearchResults()
public java.lang.String getFeedTitle()
getFeedTitle
in class RSSActionSupport
public java.lang.String executeRSS()
RSSActionSupport
Action.SUCCESS
by default. Subclassers should
override this method for additional functionality.
executeRSS
in class RSSActionSupport
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |