Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.action.rss
Class RSSSearch

java.lang.Object
  extended by com.opensymphony.xwork.ActionSupport
      extended by com.jivesoftware.base.action.rss.RSSActionSupport
          extended by com.jivesoftware.forum.action.rss.RSSSearch
All Implemented Interfaces:
AuthTokenAware, 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 RSSSearch
extends RSSActionSupport

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.

See Also:
Serialized Form

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

RSSSearch

public RSSSearch()
Method Detail

getSearchQuery

public java.lang.String getSearchQuery()

setSearchQuery

public void setSearchQuery(java.lang.String searchQuery)

getCategoryID

public long getCategoryID()

setCategoryID

public void setCategoryID(long categoryID)

getForumID

public long getForumID()

setForumID

public void setForumID(long forumID)

getDateRange

public java.lang.String getDateRange()

setDateRange

public void setDateRange(java.lang.String dateRange)

getRankBy

public int getRankBy()

setRankBy

public void setRankBy(int rankBy)

getResultRange

public int getResultRange()

setResultRange

public void setResultRange(int resultRange)

isFull

public boolean isFull()

setFull

public void setFull(boolean full)

getSearchResults

public java.util.Iterator getSearchResults()

getFeedTitle

public java.lang.String getFeedTitle()
Returns the title of the RSS feed

Overrides:
getFeedTitle in class RSSActionSupport

executeRSS

public java.lang.String executeRSS()
Description copied from class: RSSActionSupport
Main action execution method - returns Action.SUCCESS by default. Subclassers should override this method for additional functionality.

Overrides:
executeRSS in class RSSActionSupport
Returns:
a return code - see class description for more info.

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.