Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.action
Class PrivateMessagesAction

java.lang.Object
  extended by com.opensymphony.xwork.ActionSupport
      extended by com.jivesoftware.base.action.JiveActionSupport
          extended by com.jivesoftware.forum.action.ForumActionSupport
              extended by com.jivesoftware.forum.action.PrivateMessagesAction
All Implemented Interfaces:
AuthTokenAware, EntityAware, UserAware, ForumFactoryAware, Pageable, 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 PrivateMessagesAction
extends ForumActionSupport
implements Pageable

An action to view the main private messages list.

See Also:
Serialized Form

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

PrivateMessagesAction

public PrivateMessagesAction()
Method Detail

getFolderID

public int getFolderID()

setFolderID

public void setFolderID(int folderID)

getStart

public int getStart()
Description copied from interface: Pageable
Returns the starting index in the item list. This will be within the range of 0 to getTotalItemCount()-1.

Specified by:
getStart in interface Pageable
Returns:
the starting index in the item list.

setStart

public void setStart(int start)

getRange

public int getRange()

setRange

public void setRange(int range)

getFolder

public PrivateMessageFolder getFolder()

getTotalItemCount

public int getTotalItemCount()
Description copied from interface: Pageable
Returns the total number of items our list/collection/whatever. This number will always be > 0.

Specified by:
getTotalItemCount in interface Pageable
Returns:
the total number of items we're looking at.

getResultFilter

public ResultFilter getResultFilter()
Description copied from interface: Pageable
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.

Specified by:
getResultFilter in interface Pageable
Returns:
a Forums result filter.

getMessages

public java.util.Iterator getMessages()

getFolders

public java.util.Collection getFolders()

execute

public java.lang.String execute()
Description copied from class: ForumActionSupport
Default implementation of doExecute() method. This class is intended to be a base class for other actions but can be used as an action itself if the skin author simply wants to get access to the context & methods provided by this class.

Specified by:
execute in interface com.opensymphony.xwork.Action
Overrides:
execute in class ForumActionSupport
Returns:
Action.SUCCESS

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.