Jive Forums API (5.5.8) Developer Javadocs

com.jivesoftware.forum.action
Class QuestionAction

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.QuestionAction
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 QuestionAction
extends ForumActionSupport
implements com.opensymphony.xwork.Validateable

An action that encapsulates all the logic for locking threads.

See Also:
Serialized Form

Field Summary
static java.lang.String ANSWERED
          Questions can be marked as answered - this indicates the user feels replies have adequately answered their question.
static java.lang.String ASSUMED_ANSWERED
          Questions can be marked as assumed answered - this is for moderators to use when they feel a question has been answered but have no direct confirmation of this from the topic author.
static int INACTIVE_WINDOW
          The time frame (in days) a question must go unanswered before it is automatically marked as inactive.
static java.lang.String UNANSWERED
          Questions can be marked as unanswered - this indicates the feels their question has not been answered.
static java.lang.String USER_QUESTION_COUNT
          User property to store question counts.
 
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
QuestionAction()
           
 
Method Summary
 java.lang.String doDefault()
           
 java.lang.String execute()
          Default implementation of doExecute() method.
 java.lang.String getDoCancel()
           
 EntityDescriptor getEntityDescriptor(java.util.Map parameters)
          Returns information (ID, type) about a specific type given a Map of parameters.
 Forum getForum()
           
 long getForumID()
           
 java.lang.String getResolution()
           
 ForumThread getThread()
           
 long getThreadID()
           
static boolean isInactiveQuestion(ForumThread thread)
          This method checks to see if a thread's question is inactive.
 void setDoCancel(java.lang.String doCancel)
           
protected  void setForum(Forum forum)
           
 void setForumID(long forumID)
           
 void setResolution(java.lang.String resolution)
          Returns the mode the user wants to resolve the question to.
protected  void setThread(ForumThread thread)
           
 void setThreadID(long threadID)
           
 void validate()
           
 
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
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ANSWERED

public static final java.lang.String ANSWERED
Questions can be marked as answered - this indicates the user feels replies have adequately answered their question.

See Also:
Constant Field Values

UNANSWERED

public static final java.lang.String UNANSWERED
Questions can be marked as unanswered - this indicates the feels their question has not been answered. By default, new questions are marked as this.

See Also:
Constant Field Values

ASSUMED_ANSWERED

public static final java.lang.String ASSUMED_ANSWERED
Questions can be marked as assumed answered - this is for moderators to use when they feel a question has been answered but have no direct confirmation of this from the topic author.

See Also:
Constant Field Values

USER_QUESTION_COUNT

public static final java.lang.String USER_QUESTION_COUNT
User property to store question counts.

See Also:
Constant Field Values

INACTIVE_WINDOW

public static int INACTIVE_WINDOW
The time frame (in days) a question must go unanswered before it is automatically marked as inactive.

Constructor Detail

QuestionAction

public QuestionAction()
Method Detail

isInactiveQuestion

public static boolean isInactiveQuestion(ForumThread thread)
This method checks to see if a thread's question is inactive. An inactive question meets 2 criteria:
  1. It has been INACTIVE_WINDOW days since the last posting in the thread.
  2. The question's resolution is 'unanswered' or not marked (assumed to be 'unanswered')

Parameters:
thread - the thread to check.

getForumID

public long getForumID()

setForumID

public void setForumID(long forumID)

getThreadID

public long getThreadID()

setThreadID

public void setThreadID(long threadID)

getResolution

public java.lang.String getResolution()

setResolution

public void setResolution(java.lang.String resolution)
Returns the mode the user wants to resolve the question to. Valid modes are "answered", "assumedanswered" or "unanswered"

Parameters:
resolution - the resolution mode the user wants to set for the question of this topic.

getDoCancel

public java.lang.String getDoCancel()

setDoCancel

public void setDoCancel(java.lang.String doCancel)

getForum

public Forum getForum()

setForum

protected void setForum(Forum forum)

getThread

public ForumThread getThread()

setThread

protected void setThread(ForumThread thread)

validate

public void validate()
Specified by:
validate in interface com.opensymphony.xwork.Validateable
Overrides:
validate in class com.opensymphony.xwork.ActionSupport

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

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.