Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.action.rss
Class RSSAnnouncements

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

An RSS action to return a list of announcements from a given forum, category, or the system overall. You may specify a date range to limit which announcements are shown, this will be a date in the format of DEFAULT_DATE_FORMAT.

See Also:
Serialized Form

Field Summary
static java.lang.String DEFAULT_DATE_FORMAT
          The default date format of MM/dd/yyyy -- for use in parameters.
 
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
RSSAnnouncements()
           
 
Method Summary
 java.lang.String executeRSS()
          Main action execution method - returns Action.SUCCESS by default.
 java.util.Iterator getAnnouncements()
          Returns the list of forum, category or system-level announcements.
 ForumCategory getCategory()
          Returns the requested category or null if one was not specified.
 long getCategoryID()
           
 java.lang.String getEnd()
          Gets the ending date of the date range in the format of DEFAULT_DATE_FORMAT.
 java.lang.String getFeedTitle()
          Returns the title of this RSS feed which will be "Announcement: xxx" where xxx is the name of the forum or category specified.
 Forum getForum()
          Returns the requested forum or null if one was not specified.
 long getForumID()
           
 boolean getFull()
          Returns Boolean.TRUE if the full body content of the announcement should be returned, Boolean.FALSE otherwise.
 java.lang.String getStart()
          Gets the starting date of the date range in the format of DEFAULT_DATE_FORMAT.
 boolean isFull()
          Returns true if the full body content of the announcement should be returned, false otherwise.
 void setCategoryID(long categoryID)
           
 void setEnd(java.lang.String end)
          Sets the ending date of the date range in the format DEFAULT_DATE_FORMAT.
 void setForumID(long forumID)
           
 void setFull(boolean full)
          Sets whether or not the full announcement body should be displayed.
 void setStart(java.lang.String start)
          Sets the starting date of the date range in the format of DEFAULT_DATE_FORMAT.
 
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
 

Field Detail

DEFAULT_DATE_FORMAT

public static final java.lang.String DEFAULT_DATE_FORMAT
The default date format of MM/dd/yyyy -- for use in parameters.

See Also:
Constant Field Values
Constructor Detail

RSSAnnouncements

public RSSAnnouncements()
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()
Returns true if the full body content of the announcement should be returned, false otherwise.


getFull

public boolean getFull()
Returns Boolean.TRUE if the full body content of the announcement should be returned, Boolean.FALSE otherwise.


setFull

public void setFull(boolean full)
Sets whether or not the full announcement body should be displayed.


getStart

public java.lang.String getStart()
Gets the starting date of the date range in the format of DEFAULT_DATE_FORMAT.


setStart

public void setStart(java.lang.String start)
Sets the starting date of the date range in the format of DEFAULT_DATE_FORMAT.


getEnd

public java.lang.String getEnd()
Gets the ending date of the date range in the format of DEFAULT_DATE_FORMAT.


setEnd

public void setEnd(java.lang.String end)
Sets the ending date of the date range in the format DEFAULT_DATE_FORMAT.


getCategory

public ForumCategory getCategory()
Returns the requested category or null if one was not specified.


getForum

public Forum getForum()
Returns the requested forum or null if one was not specified.


getAnnouncements

public java.util.Iterator getAnnouncements()
Returns the list of forum, category or system-level announcements. If no announcements exist then an empty iterator is returned.


getFeedTitle

public java.lang.String getFeedTitle()
Returns the title of this RSS feed which will be "Announcement: xxx" where xxx is the name of the forum or category specified. If no forum or category was specified then the title will just be "Announcements".

Overrides:
getFeedTitle in class RSSActionSupport
Returns:
the title of the RSS feed based on the given forum, category or system.

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.