Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.action.rss
Class RSSForums

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

An RSS action to return information about a forum given a list of forums, a category, or list of categories. Note the plural form of the 'categoryIDs' and 'forumIDs' parameter. Even when specifying one forum you still use 'forumIDs'.

Note, this feed is more useful for syndicating information about a forum to other parts of your website and not for general users to subscribe to.

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
RSSForums()
           
 
Method Summary
 java.lang.String executeRSS()
          Main action execution method - returns Action.SUCCESS by default.
 java.lang.String getCategoryIDs()
           
 java.lang.String getFeedTitle()
          Returns a title for this RSS feed.
 java.lang.String getForumIDs()
           
 java.util.Iterator getForums()
          Returns the forums specified or an empty iterator if none were loaded.
 boolean isFullListingEnabled()
          Returns the full list of forums if there are no categories or forums specified.
 void setCategoryIDs(java.lang.String categoryIDs)
           
 void setForumIDs(java.lang.String forumIDs)
           
 
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

RSSForums

public RSSForums()
Method Detail

getCategoryIDs

public java.lang.String getCategoryIDs()

setCategoryIDs

public void setCategoryIDs(java.lang.String categoryIDs)

getForumIDs

public java.lang.String getForumIDs()

setForumIDs

public void setForumIDs(java.lang.String forumIDs)

isFullListingEnabled

public boolean isFullListingEnabled()
Returns the full list of forums if there are no categories or forums specified.


getForums

public java.util.Iterator getForums()
Returns the forums specified or an empty iterator if none were loaded.


getFeedTitle

public java.lang.String getFeedTitle()

Returns a title for this RSS feed. This varies based on the parameters passed in to this action. For example, if one forum is specified then that forum will be in the title. Otherwise, a more general title is returned.

Since this feed isn't geared to be read all the time it's not guaranteed that this title will be unique across all calls. (Most RSS readers need unique titles so feeds can be shown to the author appropriately.)

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.