Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.action
Class PollVoteAction

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

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
PollVoteAction()
           
 
Method Summary
 java.lang.String doDefault()
          Returns Action.INPUT always.
 java.lang.String execute()
          Returns Action.LOGIN if the user is not logged in, Action.ERROR if the user has already voted on the poll and ForumActionSupport.UNAUTHORIZED if the user has no permission to the poll.
 EntityDescriptor getEntityDescriptor(java.util.Map parameters)
          Returns information (ID, type) about a specific type given a Map of parameters.
 int getOption()
          Returns the option the user has selected to vote on.
 Poll getPoll()
          Returns the poll the user is voting on.
 long getPollID()
          The ID of the poll to load.
 java.lang.String loadObjects()
          Loads the poll.
 void setOption(int option)
          Sets the option the user wants to vote on.
 void setPollID(long pollID)
          Sets the ID of the poll to load.
 void validate()
          Checks the option is not out of bounds.
 
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
 

Constructor Detail

PollVoteAction

public PollVoteAction()
Method Detail

getPollID

public long getPollID()
The ID of the poll to load.


setPollID

public void setPollID(long pollID)
Sets the ID of the poll to load.


getOption

public int getOption()
Returns the option the user has selected to vote on.


setOption

public void setOption(int option)
Sets the option the user wants to vote on.


getPoll

public Poll getPoll()
Returns the poll the user is voting on.


validate

public void validate()
Checks the option is not out of bounds.

Specified by:
validate in interface com.opensymphony.xwork.Validateable
Overrides:
validate in class com.opensymphony.xwork.ActionSupport

doDefault

public java.lang.String doDefault()
Returns Action.INPUT always.

Overrides:
doDefault in class com.opensymphony.xwork.ActionSupport

execute

public java.lang.String execute()
Returns Action.LOGIN if the user is not logged in, Action.ERROR if the user has already voted on the poll and ForumActionSupport.UNAUTHORIZED if the user has no permission to the poll. Action.SUCCESS is returned if the poll vote was successful.

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
Loads the poll.

Specified by:
loadObjects in interface JiveObjectLoader
Returns:
ForumActionSupport.NOTFOUND if the specified poll was not found, ForumActionSupport.UNAUTHORIZED if there's no permission to view the poll, Action.SUCCESS if all goes well.
Throws:
java.lang.Exception - if an unexpected error occurs.

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.