Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.action.rss
Class RSSPopularForums

java.lang.Object
  extended by com.opensymphony.xwork.ActionSupport
      extended by com.jivesoftware.base.action.rss.RSSActionSupport
          extended by com.jivesoftware.forum.action.rss.RSSPopularForums
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 RSSPopularForums
extends RSSActionSupport

A simple action to return the list of popular forums in the system. Note, this feed is best 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
RSSPopularForums()
           
 
Method Summary
 java.lang.String executeRSS()
          Main action execution method - returns Action.SUCCESS by default.
 java.lang.String getFeedTitle()
          Returns a suggested title for the RSS feed -- subclasses should override this method and provide a title that is unique.
 java.util.Iterator getForums()
          Return an iterator of the most popular forums in the system or an empty iterator if no popular forums exist.
 
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

RSSPopularForums

public RSSPopularForums()
Method Detail

getForums

public java.util.Iterator getForums()
Return an iterator of the most popular forums in the system or an empty iterator if no popular forums exist.


getFeedTitle

public java.lang.String getFeedTitle()
Description copied from class: RSSActionSupport
Returns a suggested title for the RSS feed -- subclasses should override this method and provide a title that is unique. Most RSS readers need a unique title to properly show the feed to the user.

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.