Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.action
Class GuestSettingsAction

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.GuestSettingsAction
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 GuestSettingsAction
extends ForumActionSupport
implements com.opensymphony.xwork.Validateable

An action to adjust guest settings.

See Also:
Serialized Form

Field Summary
static java.lang.String USERSETTINGS
          Return type for default and execute methods to denote there is a user logged in an modifying guest settings is not appropriate.
 
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
GuestSettingsAction()
           
 
Method Summary
 java.lang.String doDefault()
          Sets current guest preferences in all the fields.
 java.lang.String execute()
          Default implementation of doExecute() method.
 java.lang.String getGuestLocale()
           
 int getMessagesPerPage()
           
 int getThreadsPerPage()
           
 java.lang.String getTimezone()
           
 boolean isUsersChooseLocale()
           
 void setGuestLocale(java.lang.String guestLocale)
           
 void setMessagesPerPage(int messagesPerPage)
           
 void setThreadsPerPage(int threadsPerPage)
           
 void setTimezone(java.lang.String timezone)
           
 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
 

Field Detail

USERSETTINGS

public static final java.lang.String USERSETTINGS
Return type for default and execute methods to denote there is a user logged in an modifying guest settings is not appropriate.

See Also:
Constant Field Values
Constructor Detail

GuestSettingsAction

public GuestSettingsAction()
Method Detail

getThreadsPerPage

public int getThreadsPerPage()

setThreadsPerPage

public void setThreadsPerPage(int threadsPerPage)

getMessagesPerPage

public int getMessagesPerPage()

setMessagesPerPage

public void setMessagesPerPage(int messagesPerPage)

getGuestLocale

public java.lang.String getGuestLocale()

setGuestLocale

public void setGuestLocale(java.lang.String guestLocale)

getTimezone

public java.lang.String getTimezone()

setTimezone

public void setTimezone(java.lang.String timezone)

isUsersChooseLocale

public boolean isUsersChooseLocale()

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 guest preferences in all the fields.

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

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.