com.jivesoftware.forum.action
Class TagAction

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

All Implemented Interfaces:

AuthTokenAware, EntityAware, UserAware, ForumFactoryAware, Pageable, 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 TagAction
extends ForumActionSupport
implements Pageable

Displays messages that correspond to a given tag.

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

TagAction()

Method Summary

java.lang.String	execute() Default implementation of doExecute() method.
long	getCategoryID()
java.lang.String	getFilterParams()
java.util.Iterator	getMessages()
Paginator	getNewPaginator()
int	getNumResults()
ResultFilter	getResultFilter() Returns a Jive Forums result filter - this gives us a handle on the current index in the list and the number of items per page.
int	getStart() Returns the starting index in the item list.
java.lang.String	getTagName()
java.util.List	getTags()
int	getTotalItemCount() Returns the total number of items our list/collection/whatever.
void	setCategoryID(long categoryID)
void	setNumResults(int numResults)
void	setStart(int start)
void	setTagName(java.lang.String tagName)

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

Constructor Detail

TagAction

public TagAction()

Method Detail

getCategoryID

public long getCategoryID()

setCategoryID

public void setCategoryID(long categoryID)

execute

public java.lang.String execute()
                         throws ForumCategoryNotFoundException

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:

ForumCategoryNotFoundException

getTagName

public java.lang.String getTagName()

setTagName

public void setTagName(java.lang.String tagName)

getNumResults

public int getNumResults()

setNumResults

public void setNumResults(int numResults)

getMessages

public java.util.Iterator getMessages()

getTags

public java.util.List getTags()

getStart

public int getStart()

Description copied from interface: Pageable

Returns the starting index in the item list. This will be within the range of 0 to getTotalItemCount()-1.

Specified by:

getStart in interface Pageable

Returns:

the starting index in the item list.

setStart

public void setStart(int start)

getTotalItemCount

public int getTotalItemCount()

Description copied from interface: Pageable

Returns the total number of items our list/collection/whatever. This number will always be > 0.

Specified by:

getTotalItemCount in interface Pageable

Returns:

the total number of items we're looking at.

getResultFilter

public ResultFilter getResultFilter()

Description copied from interface: Pageable

Returns a Jive Forums result filter - this gives us a handle on the current index in the list and the number of items per page.

Specified by:

getResultFilter in interface Pageable

Returns:

a Forums result filter.

getNewPaginator

public Paginator getNewPaginator()

getFilterParams

public java.lang.String getFilterParams()