Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.action
Class ReadAction

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.ReadAction
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.TextProvider, com.opensymphony.xwork.Validateable, com.opensymphony.xwork.ValidationAware, com.uwyn.rife.continuations.ContinuableObject, java.io.Serializable, java.lang.Cloneable

public class ReadAction
extends ForumActionSupport

An action to take care of marking all topics in a given forum as "read". Functionality might be added at a later point.

Prior to Jive Forums 3.1, this logic existed in ForumAction.doMarkRead().

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
ReadAction()
           
 
Method Summary
 java.lang.String execute()
          Marks all topics in the given forum as "read" if the user is a logged-in user and read tracking is enabled.
 ForumCategory getCategory()
          Returns the category we've loaded.
 long getCategoryID()
           
 EntityDescriptor getEntityDescriptor(java.util.Map parameters)
          Returns information (ID, type) about a specific type given a Map of parameters.
 Forum getForum()
          Returns the forum we've loaded.
 long getForumID()
           
protected  boolean loadJiveObjects()
          Loads the forum.
protected  void setCategory(ForumCategory category)
          Sets the forum to load.
 void setCategoryID(long categoryID)
           
protected  void setForum(Forum forum)
          Sets the forum to load.
 void setForumID(long forumID)
           
 
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
 

Constructor Detail

ReadAction

public ReadAction()
Method Detail

getForumID

public long getForumID()

setForumID

public void setForumID(long forumID)

getCategoryID

public long getCategoryID()

setCategoryID

public void setCategoryID(long categoryID)

getForum

public Forum getForum()
Returns the forum we've loaded.


setForum

protected void setForum(Forum forum)
Sets the forum to load. Can only be called by sub-classes.

Parameters:
forum - the forum to work with.

getCategory

public ForumCategory getCategory()
Returns the category we've loaded.


setCategory

protected void setCategory(ForumCategory category)
Sets the forum to load. Can only be called by sub-classes.

Parameters:
category - the forum to work with.

execute

public java.lang.String execute()
Marks all topics in the given forum as "read" if the user is a logged-in user and read tracking is enabled. Returns SUCCESS if the topics were marked successfully, LOGIN if the user doesn't have permission on the given forum or ERROR if the given forum fails to load.

Specified by:
execute in interface com.opensymphony.xwork.Action
Overrides:
execute in class ForumActionSupport
Returns:
Action.SUCCESS

loadJiveObjects

protected boolean loadJiveObjects()
                           throws UnauthorizedException
Loads the forum.

Throws:
UnauthorizedException

getEntityDescriptor

public EntityDescriptor getEntityDescriptor(java.util.Map parameters)
Description copied from interface: EntityAware
Returns information (ID, type) about a specific type given a Map of parameters. The parameters are expected to be String keys with Long values. If the parameter is not found, null is returned.

Specified by:
getEntityDescriptor in interface EntityAware
Overrides:
getEntityDescriptor in class ForumActionSupport
Parameters:
parameters - a Map of parameters with String keys and Long values.
Returns:
a descriptor of the object (ID and type) or null if the entity was not found.

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.