|
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.RSSCommunityStats
public class RSSCommunityStats
An RSSAction to return basic forum community statistics (number of threads, messages, etc.)
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 | |
---|---|
RSSCommunityStats()
|
Method Summary | |
---|---|
java.lang.String |
executeRSS()
Builds the number of categories, threads, forums, and messages, which can be filtered by category id, forum id, and user id |
int |
getCategoryCount()
Returns the number of categories. |
long |
getCategoryID()
Returns the category id to filter by |
boolean |
getCountUsers()
Indicates if the user count should be included. |
java.lang.String |
getFeedTitle()
Returns a suggested title for the RSS feed -- subclasses should override this method and provide a title that is unique. |
int |
getForumCount()
Returns the number of forums. |
long |
getForumID()
Returns the forum id to filer by |
java.lang.String |
getItemTitle()
Returns the title of the single item in the resultant rss channel |
int |
getMessageCount()
Returns number of messages. |
java.lang.String |
getMessageCountEmail()
Returns the email address of the user for whom messages are counted. |
java.lang.String |
getMessageCountUsername()
Returns the username of the user for whom messages are counted. |
int |
getThreadCount()
Returns the number of threads. |
int |
getUserCount()
Returns the total number of users as long as the UserManager supports the getUserCount() method. |
long |
getUserID()
Returns the user id to filter by |
boolean |
isCountUsers()
Indicates if the user count should be included. |
boolean |
isForumSelected()
Returns true if a specific forum was selected by passing a forumID in the request |
void |
setCategoryID(long categoryID)
Sets the category id to filter by |
void |
setCountUsers(boolean countUsers)
Sets whether or not to include the user count. |
void |
setForumID(long forumID)
Sets the forum id to filter by |
void |
setUserID(long userID)
Sets the user id to filter by |
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 |
---|
public RSSCommunityStats()
Method Detail |
---|
public long getForumID()
public void setForumID(long forumID)
forumID
- public long getUserID()
public void setUserID(long userID)
userID
- public long getCategoryID()
public void setCategoryID(long categoryID)
categoryID
- public boolean isCountUsers()
public boolean getCountUsers()
public void setCountUsers(boolean countUsers)
public java.lang.String getMessageCountUsername()
public java.lang.String getMessageCountEmail()
public java.lang.String getItemTitle()
public boolean isForumSelected()
public int getCategoryCount()
public int getMessageCount()
public int getForumCount()
public int getThreadCount()
public int getUserCount()
public java.lang.String getFeedTitle()
RSSActionSupport
getFeedTitle
in class RSSActionSupport
public java.lang.String executeRSS()
executeRSS
in class RSSActionSupport
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |