Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.action.rss
Class RSSThreads

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

An RSS action to return a list of threads from a given category or forum. The number of items returned can be limited by the 'numItems' parameter.

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
RSSThreads()
           
 
Method Summary
 java.lang.String executeRSS()
          Main action execution method - returns Action.SUCCESS by default.
 long getCategoryID()
           
 java.lang.String getFeedTitle()
          Returns a title for this feed with the category, forum or thread name in it.
 long getForumID()
           
 boolean getFull()
          Indicates if the full message body content should be returned or just a summary.
 java.util.Iterator getThreads()
          Returns a list of forums in the given forum or category.
 boolean isFull()
          Indicates if the full message body content should be returned or just a summary.
 void setCategoryID(long categoryID)
           
 void setForumID(long forumID)
           
 void setFull(boolean full)
          Sets whether or not to return the full message body content or just a summary.
 
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

RSSThreads

public RSSThreads()
Method Detail

getCategoryID

public long getCategoryID()

setCategoryID

public void setCategoryID(long categoryID)

getForumID

public long getForumID()

setForumID

public void setForumID(long forumID)

isFull

public boolean isFull()
Indicates if the full message body content should be returned or just a summary.


getFull

public boolean getFull()
Indicates if the full message body content should be returned or just a summary.


setFull

public void setFull(boolean full)
Sets whether or not to return the full message body content or just a summary.


getThreads

public java.util.Iterator getThreads()
Returns a list of forums in the given forum or category. If there are no threads then an empty iterator is returned.


getFeedTitle

public java.lang.String getFeedTitle()
Returns a title for this feed with the category, forum or thread name in it.

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.