Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.action
Class RosterAction

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.RosterAction
All Implemented Interfaces:
AuthTokenAware, EntityAware, UserAware, ForumFactoryAware, 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 RosterAction
extends ForumActionSupport

An action that encapsulates all the logic for displaying a user's roster.

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
RosterAction()
           
 
Method Summary
 java.lang.String doDefault()
           
 java.lang.String execute()
          Default implementation of doExecute() method.
 java.lang.String getDoAddUser()
           
 java.lang.String getDoDeleteUser()
           
 boolean getHasUsersInRoster()
           
 Roster getRoster()
           
 java.lang.String getUsernameToAdd()
           
 void setDoAddUser(java.lang.String doAddUser)
           
 void setDoDeleteUser(java.lang.String doDeleteUser)
           
 void setUsernameToAdd(java.lang.String usernameToAdd)
           
 
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, 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

RosterAction

public RosterAction()
Method Detail

getUsernameToAdd

public java.lang.String getUsernameToAdd()

setUsernameToAdd

public void setUsernameToAdd(java.lang.String usernameToAdd)

getDoAddUser

public java.lang.String getDoAddUser()

setDoAddUser

public void setDoAddUser(java.lang.String doAddUser)

getDoDeleteUser

public java.lang.String getDoDeleteUser()

setDoDeleteUser

public void setDoDeleteUser(java.lang.String doDeleteUser)

getRoster

public Roster getRoster()

getHasUsersInRoster

public boolean getHasUsersInRoster()

doDefault

public java.lang.String doDefault()
Overrides:
doDefault in class com.opensymphony.xwork.ActionSupport
Returns:
Action.INPUT

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.