Jive Forums API (5.5.8) Developer Javadocs

com.jivesoftware.forum.action
Class QuestionResolutionAction

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.QuestionResolutionAction
All Implemented Interfaces:
AuthTokenAware, EntityAware, JiveObjectLoader, 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 QuestionResolutionAction
extends ForumActionSupport
implements JiveObjectLoader

An action to handle setting the resolution state on a Question.

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
QuestionResolutionAction()
           
 
Method Summary
 java.lang.String doDefault()
           
 java.lang.String execute()
          Default implementation of doExecute() method.
 java.lang.String getBody()
           
 java.lang.String getCancel()
           
 EntityDescriptor getEntityDescriptor(java.util.Map parameters)
          Returns information (ID, type) about a specific type given a Map of parameters.
 Question getQuestion()
           
 int getResolution()
           
 Question.State getState()
          Returns the state the user wants to set the question to.
 ForumThread getThread()
           
 long getThreadID()
           
 boolean isForceResponse()
          Indicates if we need to force the user to enter text in the response box.
protected  boolean isLocked()
          Returns true if the thread is locked, false otherwise.
 boolean isMarkAsAnswered()
          Returns true if the user wants to mark the question as answered.
 boolean isMarkAsAssumedAns()
          Returns true if a moderator wants to mark the question as assumed answered.
 boolean isMarkAsUnanswered()
          Returns true if the user wants to mark the question as unanswered.
 boolean isModerator()
          Returns true if the page user is a moderator.
 java.lang.String loadObjects()
          Loads objects in an action.
 void setBody(java.lang.String body)
           
 void setCancel(java.lang.String cancel)
           
 void setResolution(int resolution)
           
 void setThreadID(long threadID)
           
 
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, 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

QuestionResolutionAction

public QuestionResolutionAction()
Method Detail

getThreadID

public long getThreadID()

setThreadID

public void setThreadID(long threadID)

getResolution

public int getResolution()

setResolution

public void setResolution(int resolution)

getBody

public java.lang.String getBody()

setBody

public void setBody(java.lang.String body)

getCancel

public java.lang.String getCancel()

setCancel

public void setCancel(java.lang.String cancel)

getThread

public ForumThread getThread()

getQuestion

public Question getQuestion()

getState

public Question.State getState()
Returns the state the user wants to set the question to.

Returns:
the state the user wants to set the question to.

isMarkAsAnswered

public boolean isMarkAsAnswered()
Returns true if the user wants to mark the question as answered.

Returns:
true if the user wants to mark the question as answered, false otherwise.

isMarkAsUnanswered

public boolean isMarkAsUnanswered()
Returns true if the user wants to mark the question as unanswered.

Returns:
true if the user wants to mark the question as unanswered, false otherwise.

isMarkAsAssumedAns

public boolean isMarkAsAssumedAns()
Returns true if a moderator wants to mark the question as assumed answered.

Returns:
true if the user wants to mark the question as assumed answered, false otherwise.

isForceResponse

public boolean isForceResponse()
Indicates if we need to force the user to enter text in the response box. Do this if the user wants to mark the question as unanswered and the question is currently unanswered.

Returns:
true if the user is forced to enter a response, false otherwise.

isModerator

public boolean isModerator()
Returns true if the page user is a moderator.

Returns:
true if the page user is a moderator.

doDefault

public java.lang.String doDefault()
Overrides:
doDefault in class com.opensymphony.xwork.ActionSupport

execute

public java.lang.String execute()
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

loadObjects

public java.lang.String loadObjects()
                             throws java.lang.Exception
Description copied from interface: JiveObjectLoader
Loads objects in an action. This method should return Action.SUCCESS if object loading occurred normally. If another type of code is returned then a WebWork interceptor can pick up on that and return a different view page.

Specified by:
loadObjects in interface JiveObjectLoader
Returns:
Action.SUCCESS if object loading occurred normally, anything else to indicate that object loading failed.
Throws:
java.lang.Exception - if an unexpected error occurs when loading the objects.

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.

isLocked

protected boolean isLocked()
Returns true if the thread is locked, false otherwise.

Returns:
true if the thread is locked, false otherwise.

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.