Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.action
Class PollExpireAction

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.ForumAction
                  extended by com.jivesoftware.forum.action.ForumThreadAction
                      extended by com.jivesoftware.forum.action.PollAction
                          extended by com.jivesoftware.forum.action.PollExpireAction
All Implemented Interfaces:
AuthTokenAware, EntityAware, JiveObjectLoader, UserAware, ForumFactoryAware, ForumMessageAware, Pageable, 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 PollExpireAction
extends PollAction

A simple action to expire a poll.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.jivesoftware.forum.action.PollAction
EXPIRED, VOTED
 
Fields inherited from class com.jivesoftware.forum.action.ForumThreadAction
DEFAULT_THREAD_MODE, THREAD_FLAT, THREAD_THREADED, THREAD_TREE
 
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
PollExpireAction()
           
 
Method Summary
 java.lang.String doDefault()
           
 java.lang.String execute()
          Validates the forum ID and either redirects to the SUCCESS, ERROR page if the id was not found or the login page if the page user is not authorized to view the forum.
 java.lang.String isCancel()
          Indicates the user wants to cancel.
 void setCancel(java.lang.String cancel)
          Sets whether or not the user wants to cancel.
 
Methods inherited from class com.jivesoftware.forum.action.PollAction
getCategory, getCategoryID, getEntityDescriptor, getOption, getPoll, getPollID, hasVoted, isAllowedToVote, isPollActive, isPollExpired, loadObjects, setCategoryID, setOption, setPollID
 
Methods inherited from class com.jivesoftware.forum.action.ForumThreadAction
getMessage, getMessageID, getMessages, getNextThread, getNextTstart, getPopularTags, getPreviousThread, getPrevTstart, getRecommendedTags, getResultFilter, getStart, getThread, getThreadID, getThreadMode, getTotalItemCount, getTstart, hasNextThread, hasPreviousThread, isArchived, isLocked, isRootMessage, isStqc, setMessage, setMessageID, setResultFilter, setStart, setStqc, setThread, setThreadID, setTstart
 
Methods inherited from class com.jivesoftware.forum.action.ForumAction
getAnnouncements, getForum, getForumID, getMessageResultFilter, getThreads, initFields, loadJiveObjects, setForum, setForumID, setMessageResultFilter
 
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

PollExpireAction

public PollExpireAction()
Method Detail

isCancel

public java.lang.String isCancel()
Indicates the user wants to cancel.


setCancel

public void setCancel(java.lang.String cancel)
Sets whether or not the user wants to cancel.


doDefault

public java.lang.String doDefault()
                           throws java.lang.Exception
Overrides:
doDefault in class PollAction
Throws:
java.lang.Exception

execute

public java.lang.String execute()
                         throws java.lang.Exception
Description copied from class: ForumThreadAction
Validates the forum ID and either redirects to the SUCCESS, ERROR page if the id was not found or the login page if the page user is not authorized to view the forum.

Specified by:
execute in interface com.opensymphony.xwork.Action
Overrides:
execute in class PollAction
Returns:
Action.SUCCESS if the forum was loaded successfully, ForumActionSupport.UNAUTHORIZED or Action.ERROR otherwise.
Throws:
java.lang.Exception

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.