|
Jive Forums API (5.5.20.2-oracle) Developer Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.opensymphony.xwork.ActionSupport
com.jivesoftware.forum.moderation.action.ViewModerateAction
public class ViewModerateAction
An action to handle the viewing of moderated messages
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. |
java.lang.String |
getErrorString()
|
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 |
setErrorString(java.lang.String err)
|
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 |
setServletRequest(javax.servlet.http.HttpServletRequest request)
|
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 |
---|
public static final RelativeDateRange DEFAULT_DATE_RANGE
public static final RelativeDateRange[] DATE_RANGES
Constructor Detail |
---|
public ViewModerateAction()
Method Detail |
---|
public void setAuthToken(AuthToken authToken)
setAuthToken
in interface AuthTokenAware
public void setForumFactory(ForumFactory forumFactory)
ForumFactoryAware
ForumFactory
setForumFactory
in interface ForumFactoryAware
forumFactory
- an instance of ForumFactory
public java.util.List getForumList()
public java.util.Iterator getMessages()
public long getForumID()
public void setForumID(long forumID)
public ModerationManager getModerationManager()
public int getModValue()
public void setModValue(int modValue)
public User getSearchedUser()
public void setSearchedUser(User searchedUser)
public java.lang.String getUserID()
public void setUserID(java.lang.String userID)
public java.lang.String getDateRange()
public void setDateRange(java.lang.String dateRange)
public RelativeDateRange[] getDateRanges()
public boolean isEditStampRequired()
public int getStart()
This method implements part of the Pageable interface - this allows this action to be used for the creation of a Paginator object.
getStart
in interface Pageable
public void setStart(int start)
start
- the starting index of the list of moderated messagespublic int getNumResults()
public void setNumResults(int numResults)
public int getTotalItemCount()
Pageable
getTotalItemCount
in interface Pageable
public ResultFilter getResultFilter()
Pageable
getResultFilter
in interface Pageable
public java.lang.String getErrorString()
public void setErrorString(java.lang.String err)
public java.lang.String execute() throws java.lang.Exception
execute
in interface com.opensymphony.xwork.Action
execute
in class com.opensymphony.xwork.ActionSupport
java.lang.Exception
protected boolean loadJiveObjects() throws UnauthorizedException
UnauthorizedException
public User getPageUser()
public AuthToken getAuthToken()
public ForumFactory getForumFactory()
public void setServletRequest(javax.servlet.http.HttpServletRequest request)
setServletRequest
in interface com.opensymphony.webwork.interceptor.ServletRequestAware
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |