com.jivesoftware.forum.action
Class QuestionFilterForumAction

java.lang.Object
  com.opensymphony.xwork.ActionSupport
      com.jivesoftware.base.action.JiveActionSupport
          com.jivesoftware.forum.action.ForumActionSupport
              com.jivesoftware.forum.action.ForumAction
                  com.jivesoftware.forum.action.QuestionFilterForumAction

All Implemented Interfaces:

AuthTokenAware, EntityAware, JiveObjectLoader, UserAware, ForumFactoryAware, Pageable, com.opensymphony.webwork.interceptor.ServletRequestAware, com.opensymphony.webwork.interceptor.ServletResponseAware, com.opensymphony.webwork.interceptor.SessionAware, 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 QuestionFilterForumAction
extends ForumAction
implements com.opensymphony.webwork.interceptor.SessionAware

See Also:

Serialized Form

Nested Class Summary

class

QuestionFilterForumAction.QuestionIterator

Field Summary

static java.lang.String	ALL
static java.lang.String	ANSWERED_QUESTIONS
static java.lang.String	FILTER_KEY
static java.lang.String	OPEN_QUESTIONS

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

QuestionFilterForumAction()

Method Summary

java.lang.String	execute() Loads the specified forum.
java.lang.String	getFilter()
QuestionManager	getQuestionManager()
java.util.Iterator	getThreads() Returns a list of threads on the current page in this forum.
int	getTotalItemCount() Returns the total number of threads in the forum.
void	setFilter(java.lang.String filter)
void	setSession(java.util.Map session)

Methods inherited from class com.jivesoftware.forum.action.ForumAction

getAnnouncements, getEntityDescriptor, getForum, getForumID, getMessageResultFilter, getResultFilter, getStart, getThreadMode, initFields, loadJiveObjects, loadObjects, setForum, setForumID, setMessageResultFilter, setStart

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, 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, 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

Field Detail

FILTER_KEY

public static final java.lang.String FILTER_KEY

See Also:

Constant Field Values

ALL

public static final java.lang.String ALL

See Also:

Constant Field Values

OPEN_QUESTIONS

public static final java.lang.String OPEN_QUESTIONS

See Also:

Constant Field Values

ANSWERED_QUESTIONS

public static final java.lang.String ANSWERED_QUESTIONS

See Also:

Constant Field Values

Constructor Detail

QuestionFilterForumAction

public QuestionFilterForumAction()

Method Detail

getQuestionManager

public QuestionManager getQuestionManager()

getFilter

public java.lang.String getFilter()

setFilter

public void setFilter(java.lang.String filter)

getTotalItemCount

public int getTotalItemCount()

Description copied from class: ForumAction

Returns the total number of threads in the forum. This method implements part of the Pageable interface.

Specified by:

getTotalItemCount in interface Pageable

Overrides:

getTotalItemCount in class ForumAction

Returns:

the total number of threads in the forum.

getThreads

public java.util.Iterator getThreads()

Description copied from class: ForumAction

Returns a list of threads on the current page in this forum. Note, this will not likely be a full list of threads in the forum because the number of threads will be limited by the result filter which is based on the start parameter and the user's preference for the number of threads per page.

Overrides:

getThreads in class ForumAction

Returns:

a list of threads on the current page in this forum.

setSession

public void setSession(java.util.Map session)

Specified by:

setSession in interface com.opensymphony.webwork.interceptor.SessionAware

execute

public java.lang.String execute()
                         throws java.lang.Exception

Description copied from class: ForumAction

Loads the specified forum. Return codes:

• Action.SUCCESS if the forum was loaded successfully.
• ForumActionSupport.UNAUTHORIZED if the user doesn't have read access to the forum.
• Action.ERROR if the specified forum was not found or if an error occurred while loading the forum.

Specified by:

execute in interface com.opensymphony.xwork.Action

Overrides:

execute in class ForumAction

Returns:

Action.SUCCESS if the forum was loaded successfully, ForumActionSupport.UNAUTHORIZED or Action.ERROR otherwise.

Throws:

java.lang.Exception