Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.action
Class UserSettingsAction

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.UserSettingsAction
All Implemented Interfaces:
AuthTokenAware, EntityAware, UserAware, ForumFactoryAware, com.opensymphony.webwork.interceptor.ServletRequestAware, com.opensymphony.webwork.interceptor.ServletResponseAware, com.opensymphony.xwork.Action, com.opensymphony.xwork.interceptor.ParameterNameAware, 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 UserSettingsAction
extends ForumActionSupport
implements com.opensymphony.xwork.Validateable, com.opensymphony.xwork.interceptor.ParameterNameAware

An action for setting users preferences, account settings and password.

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
UserSettingsAction()
           
 
Method Summary
 boolean acceptableParameterName(java.lang.String string)
           
 java.lang.String doDefault()
          Sets current user preferences in all the fields.
 java.lang.String execute()
          Updates user settings.
 int getMessagesPerPage()
           
 java.util.Date getNewDate()
           
 java.lang.String getTheme()
           
 java.util.List getThemes()
           
 java.lang.String getThreadMode()
           
 java.lang.String[][] getThreadModes()
           
 int getThreadsPerPage()
           
 java.lang.String getTimezone()
           
 java.lang.String getUserLocale()
           
 boolean isUsersChooseLocale()
           
 boolean isUsersChooseTheme()
           
 boolean isUsersChooseThreadMode()
           
 void setMessagesPerPage(int messagesPerPage)
           
 void setTheme(java.lang.String theme)
           
 void setThreadMode(java.lang.String threadMode)
           
 void setThreadsPerPage(int threadsPerPage)
           
 void setTimezone(java.lang.String timezone)
           
 void setUserLocale(java.lang.String userLocale)
           
 void validate()
           
 
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
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

UserSettingsAction

public UserSettingsAction()
Method Detail

getThreadsPerPage

public int getThreadsPerPage()

setThreadsPerPage

public void setThreadsPerPage(int threadsPerPage)

getMessagesPerPage

public int getMessagesPerPage()

setMessagesPerPage

public void setMessagesPerPage(int messagesPerPage)

getThreadMode

public java.lang.String getThreadMode()

setThreadMode

public void setThreadMode(java.lang.String threadMode)

getUserLocale

public java.lang.String getUserLocale()

setUserLocale

public void setUserLocale(java.lang.String userLocale)

getTimezone

public java.lang.String getTimezone()

setTimezone

public void setTimezone(java.lang.String timezone)

getTheme

public java.lang.String getTheme()

setTheme

public void setTheme(java.lang.String theme)

isUsersChooseLocale

public boolean isUsersChooseLocale()

isUsersChooseThreadMode

public boolean isUsersChooseThreadMode()

isUsersChooseTheme

public boolean isUsersChooseTheme()

getThreadModes

public java.lang.String[][] getThreadModes()

getThemes

public java.util.List getThemes()

validate

public void validate()
Specified by:
validate in interface com.opensymphony.xwork.Validateable
Overrides:
validate in class com.opensymphony.xwork.ActionSupport

doDefault

public java.lang.String doDefault()
Sets current user preferences in all the fields.

Overrides:
doDefault in class com.opensymphony.xwork.ActionSupport

execute

public java.lang.String execute()
Updates user settings.

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

acceptableParameterName

public boolean acceptableParameterName(java.lang.String string)
Specified by:
acceptableParameterName in interface com.opensymphony.xwork.interceptor.ParameterNameAware

getNewDate

public java.util.Date getNewDate()

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.