Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.everywhere.action
Class CommunityEverywhereSettings

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.everywhere.action.CommunityEverywhereSettings
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.Preparable, 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 CommunityEverywhereSettings
extends ForumActionSupport
implements com.opensymphony.xwork.Preparable

Manages Community Everywhere settings.

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
CommunityEverywhereSettings()
           
 
Method Summary
 java.lang.String doInput()
           
 java.lang.String execute()
          Default implementation of doExecute() method.
 java.lang.String getAllowedReferers()
           
 java.lang.String getEnabled()
           
 java.lang.String getJiveURL()
          Gets the jiveURL property
 ForumCategory getRootCategory()
           
 java.lang.String getRootUser()
           
 boolean isSuccess()
           
 void prepare()
           
 void setAllowedReferers(java.lang.String allowedReferers)
           
 void setEnabled(java.lang.String enabled)
           
 void setRootUser(java.lang.String rootUser)
           
 void setSuccess(boolean success)
           
 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, doDefault, 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

CommunityEverywhereSettings

public CommunityEverywhereSettings()
Method Detail

prepare

public void prepare()
             throws java.lang.Exception
Specified by:
prepare in interface com.opensymphony.xwork.Preparable
Throws:
java.lang.Exception

validate

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

doInput

public java.lang.String doInput()
                         throws java.lang.Exception
Overrides:
doInput in class com.opensymphony.xwork.ActionSupport
Throws:
java.lang.Exception

execute

public java.lang.String execute()
                         throws java.lang.Exception
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
Throws:
java.lang.Exception

getEnabled

public java.lang.String getEnabled()

setEnabled

public void setEnabled(java.lang.String enabled)

getAllowedReferers

public java.lang.String getAllowedReferers()

setAllowedReferers

public void setAllowedReferers(java.lang.String allowedReferers)

getRootUser

public java.lang.String getRootUser()

setRootUser

public void setRootUser(java.lang.String rootUser)

isSuccess

public boolean isSuccess()

setSuccess

public void setSuccess(boolean success)

getRootCategory

public ForumCategory getRootCategory()

getJiveURL

public java.lang.String getJiveURL()
Gets the jiveURL property

Returns:
the jiveURL property

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.