Jive Forums API (5.5.8) Developer Javadocs

com.jivesoftware.forum.action
Class MarkAsQuestionAction

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.MarkAsQuestionAction
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 MarkAsQuestionAction
extends ForumActionSupport
implements JiveObjectLoader

See Also:
Serialized Form

Field Summary
static int TIME_LIMIT
          Amount of time (in minutes) the user has to mark a thread as a question.
 
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
MarkAsQuestionAction()
           
 
Method Summary
static boolean canMarkAsQuestion(ForumThread thread, User user)
           
static boolean canUnmarkAsQuestion(QuestionManager manager, ForumThread thread, User user)
           
 java.lang.String doDefault()
           
 java.lang.String doUnmark()
           
 java.lang.String execute()
          Default implementation of doExecute() method.
 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()
           
 ForumThread getThread()
           
 long getThreadID()
           
 int getTimeLeft()
           
 int getTimeLimit()
           
 java.lang.String loadObjects()
          Loads objects in an action.
 void setCancel(java.lang.String cancel)
           
 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
 

Field Detail

TIME_LIMIT

public static final int TIME_LIMIT
Amount of time (in minutes) the user has to mark a thread as a question. By default this is 15 minutes but that time can be overridden by setting the 'questions.markAsQuestionTimeWindow' property to the time in seconds.

Constructor Detail

MarkAsQuestionAction

public MarkAsQuestionAction()
Method Detail

getThreadID

public long getThreadID()

setThreadID

public void setThreadID(long threadID)

getCancel

public java.lang.String getCancel()

setCancel

public void setCancel(java.lang.String cancel)

getThread

public ForumThread getThread()

getQuestion

public Question getQuestion()

canMarkAsQuestion

public static boolean canMarkAsQuestion(ForumThread thread,
                                        User user)

canUnmarkAsQuestion

public static boolean canUnmarkAsQuestion(QuestionManager manager,
                                          ForumThread thread,
                                          User user)

getTimeLimit

public int getTimeLimit()

getTimeLeft

public int getTimeLeft()

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

doUnmark

public java.lang.String doUnmark()

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.

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.