com.jivesoftware.forum.action
Class PollAction

java.lang.Object
  com.opensymphony.xwork.ActionSupport
      com.jivesoftware.base.action.JiveActionSupport
          com.jivesoftware.forum.action.ForumActionSupport
              com.jivesoftware.forum.action.ForumAction
                  com.jivesoftware.forum.action.ForumThreadAction
                      com.jivesoftware.forum.action.PollAction

All Implemented Interfaces:

AuthTokenAware, EntityAware, JiveObjectLoader, UserAware, ForumFactoryAware, 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

Direct Known Subclasses:

PollDeleteAction, PollExpireAction

public class PollAction
extends ForumThreadAction
implements JiveObjectLoader

See Also:

Serialized Form

Field Summary

static java.lang.String	EXPIRED
static java.lang.String	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

PollAction()

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.
ForumCategory	getCategory()
long	getCategoryID()
EntityDescriptor	getEntityDescriptor(java.util.Map parameters) Returns information (ID, type) about a specific type given a Map of parameters.
int[]	getOption()
Poll	getPoll()
long	getPollID()
boolean	hasVoted()
boolean	isAllowedToVote()
boolean	isPollActive()
boolean	isPollExpired()
java.lang.String	loadObjects() Override the loading of page objects from ForumThreadAction.
void	setCategoryID(long categoryID)
void	setOption(int[] option)
void	setPollID(long pollID)

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

Field Detail

EXPIRED

public static final java.lang.String EXPIRED

See Also:

Constant Field Values

VOTED

public static final java.lang.String VOTED

See Also:

Constant Field Values

Constructor Detail

PollAction

public PollAction()

Method Detail

getPollID

public long getPollID()

setPollID

public void setPollID(long pollID)

getCategory

public ForumCategory getCategory()

getCategoryID

public long getCategoryID()

setCategoryID

public void setCategoryID(long categoryID)

getOption

public int[] getOption()

setOption

public void setOption(int[] option)

hasVoted

public boolean hasVoted()

isAllowedToVote

public boolean isAllowedToVote()

isPollActive

public boolean isPollActive()

isPollExpired

public boolean isPollExpired()

getPoll

public Poll getPoll()

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 ForumThreadAction

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.

doDefault

public java.lang.String doDefault()
                           throws java.lang.Exception

Overrides:

doDefault in class com.opensymphony.xwork.ActionSupport

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 ForumThreadAction

Returns:

Action.SUCCESS if the forum was loaded successfully, ForumActionSupport.UNAUTHORIZED or Action.ERROR otherwise.

Throws:

java.lang.Exception

loadObjects

public java.lang.String loadObjects()
                             throws java.lang.Exception

Override the loading of page objects from ForumThreadAction.

Specified by:

loadObjects in interface JiveObjectLoader

Overrides:

loadObjects in class ForumThreadAction

Returns:

result code.

Throws:

java.lang.Exception - if an unexpected error occurs when loading the objects.