|
Jive Forums API (5.5.20.2-oracle) Developer Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.opensymphony.xwork.ActionSupport
com.jivesoftware.base.action.rss.RSSActionSupport
com.jivesoftware.forum.action.rss.RSSAnnouncements
public class RSSAnnouncements
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
.
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 |
---|
public static final java.lang.String DEFAULT_DATE_FORMAT
Constructor Detail |
---|
public RSSAnnouncements()
Method Detail |
---|
public long getCategoryID()
public void setCategoryID(long categoryID)
public long getForumID()
public void setForumID(long forumID)
public boolean isFull()
public boolean getFull()
public void setFull(boolean full)
public java.lang.String getStart()
DEFAULT_DATE_FORMAT
.
public void setStart(java.lang.String start)
DEFAULT_DATE_FORMAT
.
public java.lang.String getEnd()
DEFAULT_DATE_FORMAT
.
public void setEnd(java.lang.String end)
DEFAULT_DATE_FORMAT
.
public ForumCategory getCategory()
public Forum getForum()
public java.util.Iterator getAnnouncements()
public java.lang.String getFeedTitle()
getFeedTitle
in class RSSActionSupport
public java.lang.String executeRSS()
RSSActionSupport
Action.SUCCESS
by default. Subclassers should
override this method for additional functionality.
executeRSS
in class RSSActionSupport
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |