Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.action
Class FilterSettings

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.FilterSettings
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 FilterSettings
extends ForumActionSupport
implements com.opensymphony.webwork.interceptor.ServletRequestAware, com.opensymphony.xwork.Preparable

Handles the configuration of the editor 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, 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
FilterSettings()
           
 
Method Summary
 java.lang.String doInput()
           
 java.lang.String execute()
          Default implementation of doExecute() method.
 ForumCategory getCategoryObject()
           
 java.util.Map getDescriptors()
           
 java.util.List getFilters()
           
 Forum getForumObject()
           
 java.util.Map getJiveFilters()
           
 java.util.List getMacrosFilters()
           
 java.lang.String getNewClassname()
           
 java.lang.String getParameterURL()
           
 java.util.List getPostFilters()
           
 java.util.List getPreFilters()
           
 java.lang.String getRemoveFilterName()
           
 boolean isAddFilter()
           
 boolean isCopyGlobalFilters()
           
 boolean isDeleteAllFilters()
           
 boolean isRemoveFilter()
           
 boolean isSaveFilterSettings()
           
 boolean isSuccess()
           
 void prepare()
           
 void setAddFilter(boolean addFilter)
           
 void setCategory(long category)
           
 void setCopyGlobalFilters(boolean copyGlobalFilters)
           
 void setDeleteAllFilters(boolean deleteAllFilters)
           
 void setForum(long forum)
           
 void setNewClassname(java.lang.String newClassname)
           
 void setRemoveFilter(boolean removeFilter)
           
 void setRemoveFilterName(java.lang.String removeFilterName)
           
 void setSaveFilterSettings(boolean saveFilterSettings)
           
 void setServletRequest(javax.servlet.http.HttpServletRequest request)
           
 void setSuccess(boolean success)
           
 
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, 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, validate
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FilterSettings

public FilterSettings()
Method Detail

setServletRequest

public void setServletRequest(javax.servlet.http.HttpServletRequest request)
Specified by:
setServletRequest in interface com.opensymphony.webwork.interceptor.ServletRequestAware
Overrides:
setServletRequest in class JiveActionSupport

prepare

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

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

setForum

public void setForum(long forum)

setCategory

public void setCategory(long category)

getForumObject

public Forum getForumObject()

getCategoryObject

public ForumCategory getCategoryObject()

getPreFilters

public java.util.List getPreFilters()

getMacrosFilters

public java.util.List getMacrosFilters()

getFilters

public java.util.List getFilters()

getPostFilters

public java.util.List getPostFilters()

getDescriptors

public java.util.Map getDescriptors()

getJiveFilters

public java.util.Map getJiveFilters()

isSaveFilterSettings

public boolean isSaveFilterSettings()

setSaveFilterSettings

public void setSaveFilterSettings(boolean saveFilterSettings)

isAddFilter

public boolean isAddFilter()

setAddFilter

public void setAddFilter(boolean addFilter)

isRemoveFilter

public boolean isRemoveFilter()

setRemoveFilter

public void setRemoveFilter(boolean removeFilter)

getNewClassname

public java.lang.String getNewClassname()

setNewClassname

public void setNewClassname(java.lang.String newClassname)

getRemoveFilterName

public java.lang.String getRemoveFilterName()

setRemoveFilterName

public void setRemoveFilterName(java.lang.String removeFilterName)

isCopyGlobalFilters

public boolean isCopyGlobalFilters()

setCopyGlobalFilters

public void setCopyGlobalFilters(boolean copyGlobalFilters)

isDeleteAllFilters

public boolean isDeleteAllFilters()

setDeleteAllFilters

public void setDeleteAllFilters(boolean deleteAllFilters)

isSuccess

public boolean isSuccess()

setSuccess

public void setSuccess(boolean success)

getParameterURL

public java.lang.String getParameterURL()

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.