com.jivesoftware.forum.moderation.action
Class ViewModerateAction

java.lang.Object
  com.opensymphony.xwork.ActionSupport
      com.jivesoftware.forum.moderation.action.ViewModerateAction

All Implemented Interfaces:

AuthTokenAware, ForumFactoryAware, Pageable, 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 ViewModerateAction
extends com.opensymphony.xwork.ActionSupport
implements AuthTokenAware, ForumFactoryAware, Pageable

An action to handle the viewing of moderated messages

See Also:

Serialized Form

Field Summary

static RelativeDateRange[]	DATE_RANGES
static RelativeDateRange	DEFAULT_DATE_RANGE

Fields inherited from class com.opensymphony.xwork.ActionSupport

LOG

Fields inherited from interface com.opensymphony.xwork.Action

ERROR, INPUT, LOGIN, NONE, SUCCESS

Constructor Summary

ViewModerateAction()

Method Summary

java.lang.String	execute()
AuthToken	getAuthToken()
java.lang.String	getDateRange()
RelativeDateRange[]	getDateRanges() Returns a list of the possible date ranges allowed in a search.
ForumFactory	getForumFactory()
long	getForumID()
java.util.List	getForumList()
java.util.Iterator	getMessages()
ModerationManager	getModerationManager()
int	getModValue()
int	getNumResults()
User	getPageUser()
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.
User	getSearchedUser()
int	getStart() Returns the starting index for the list of moderated messages.
int	getTotalItemCount() Returns the total number of items our list/collection/whatever.
java.lang.String	getUserID()
boolean	isEditStampRequired() Returns if the editStamp is required to be set when moderators edit messages.
protected boolean	loadJiveObjects()
void	setAuthToken(AuthToken authToken)
void	setDateRange(java.lang.String dateRange)
void	setForumFactory(ForumFactory forumFactory) Provides the action an instance of ForumFactory
void	setForumID(long forumID)
void	setModValue(int modValue)
void	setNumResults(int numResults)
void	setSearchedUser(User searchedUser)
void	setStart(int start) Sets the starting index for the list of moderated messages
void	setUserID(java.lang.String userID)

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

DEFAULT_DATE_RANGE

public static final RelativeDateRange DEFAULT_DATE_RANGE

DATE_RANGES

public static final RelativeDateRange[] DATE_RANGES

Constructor Detail

ViewModerateAction

public ViewModerateAction()

Method Detail

setAuthToken

public void setAuthToken(AuthToken authToken)

Specified by:

setAuthToken in interface AuthTokenAware

setForumFactory

public void setForumFactory(ForumFactory forumFactory)

Description copied from interface: ForumFactoryAware

Provides the action an instance of ForumFactory

Specified by:

setForumFactory in interface ForumFactoryAware

Parameters:

forumFactory - an instance of ForumFactory

getForumList

public java.util.List getForumList()

getMessages

public java.util.Iterator getMessages()

getForumID

public long getForumID()

setForumID

public void setForumID(long forumID)

getModerationManager

public ModerationManager getModerationManager()

getModValue

public int getModValue()

setModValue

public void setModValue(int modValue)

getSearchedUser

public User getSearchedUser()

setSearchedUser

public void setSearchedUser(User searchedUser)

getUserID

public java.lang.String getUserID()

setUserID

public void setUserID(java.lang.String userID)

getDateRange

public java.lang.String getDateRange()

setDateRange

public void setDateRange(java.lang.String dateRange)

getDateRanges

public RelativeDateRange[] getDateRanges()

Returns a list of the possible date ranges allowed in a search.

Returns:

a list of the possible date ranges allowed in a search.

isEditStampRequired

public boolean isEditStampRequired()

Returns if the editStamp is required to be set when moderators edit messages. This was added so messages could not be edited by someone other than the author without a record that the edit took place.

Returns:

true if the editStamp is required, otherwise false

getStart

public int getStart()

Returns the starting index for the list of moderated messages. The index is 0 based and by default is 0. This method will never return a value less than zero as well.

This method implements part of the Pageable interface - this allows this action to be used for the creation of a Paginator object.

Specified by:

getStart in interface Pageable

Returns:

the starting index for the list of moderated messages.

setStart

public void setStart(int start)

Sets the starting index for the list of moderated messages

Parameters:

start - the starting index of the list of moderated messages

getNumResults

public int getNumResults()

setNumResults

public void setNumResults(int numResults)

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.

execute

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

Specified by:

execute in interface com.opensymphony.xwork.Action

Overrides:

execute in class com.opensymphony.xwork.ActionSupport

Throws:

java.lang.Exception

loadJiveObjects

protected boolean loadJiveObjects()
                           throws UnauthorizedException

Throws:

UnauthorizedException

getPageUser

public User getPageUser()

getAuthToken

public AuthToken getAuthToken()

getForumFactory

public ForumFactory getForumFactory()