|
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.JiveActionSupport
com.jivesoftware.forum.action.ForumActionSupport
com.jivesoftware.forum.action.PrivateMessagesAction
public class PrivateMessagesAction
An action to view the main private messages list.
Field Summary |
---|
Fields inherited from class com.jivesoftware.forum.action.ForumActionSupport |
---|
CANCEL, DISABLED, FATAL, NOTFOUND, SESSION_REFERRER_KEY, UNAUTHORIZED |
Fields inherited from class com.jivesoftware.base.action.JiveActionSupport |
---|
pageUser, 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 | |
---|---|
PrivateMessagesAction()
|
Method Summary | |
---|---|
java.lang.String |
execute()
Default implementation of doExecute() method. |
PrivateMessageFolder |
getFolder()
|
int |
getFolderID()
|
java.util.Collection |
getFolders()
|
java.util.Iterator |
getMessages()
|
int |
getRange()
|
ResultFilter |
getResultFilter()
Returns a Jive Forums result filter - this gives us a handle on the current index in the list and the number of items per page. |
int |
getStart()
Returns the starting index in the item list. |
int |
getTotalItemCount()
Returns the total number of items our list/collection/whatever. |
void |
setFolderID(int folderID)
|
void |
setRange(int range)
|
void |
setStart(int start)
|
Methods inherited from class com.jivesoftware.forum.action.ForumActionSupport |
---|
getCanAttach, getCanCreateMessage, getCanCreatePoll, getCanCreatePoll, getCanCreateThread, getCanCreateThread, getCanEdit, getCanEditAttach, getCanEditPoll, getCanEditPoll, getCanEditProfile, getCanEditTags, getCanPostAnnounce, getCanPostAnnounce, getCanRead, getCanRead, getEntityDescriptor, getForumFactory, getPageUser, getReadStatus, getSkinProperty, getThemeName, isAdmin, isAdmin, isAuthor, isAuthor, isMessageModerationOn, isModerator, isModerator, isResourceInTheme, isSystemAdmin, isThreadModerationOn, setForumFactory, setUser |
Methods inherited from class com.jivesoftware.base.action.JiveActionSupport |
---|
getAuthToken, getGuestProperty, getJiveProperty, getLocales, getPageURL, getSession, getText, getText, getTimeZone, getTimeZones, isFailedLookup, isGuest, setAuthToken, setGuestProperty, setLoginAttributes, setPageUser, setServletRequest, setServletResponse |
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, 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 PrivateMessagesAction()
Method Detail |
---|
public int getFolderID()
public void setFolderID(int folderID)
public int getStart()
Pageable
getStart
in interface Pageable
public void setStart(int start)
public int getRange()
public void setRange(int range)
public PrivateMessageFolder getFolder()
public int getTotalItemCount()
Pageable
getTotalItemCount
in interface Pageable
public ResultFilter getResultFilter()
Pageable
getResultFilter
in interface Pageable
public java.util.Iterator getMessages()
public java.util.Collection getFolders()
public java.lang.String execute()
ForumActionSupport
execute
in interface com.opensymphony.xwork.Action
execute
in class ForumActionSupport
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |