|
Jive Forums API (5.5.20.2-oracle) Developer Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.opensymphony.xwork.ActionSupport
com.jivesoftware.base.action.JiveActionSupport
com.jivesoftware.forum.action.ForumActionSupport
com.jivesoftware.forum.action.PollVoteAction
public class PollVoteAction
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 |
---|
public PollVoteAction()
Method Detail |
---|
public long getPollID()
public void setPollID(long pollID)
public int getOption()
public void setOption(int option)
public Poll getPoll()
public void validate()
validate
in interface com.opensymphony.xwork.Validateable
validate
in class com.opensymphony.xwork.ActionSupport
public java.lang.String doDefault()
Action.INPUT
always.
doDefault
in class com.opensymphony.xwork.ActionSupport
public java.lang.String execute()
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.
execute
in interface com.opensymphony.xwork.Action
execute
in class ForumActionSupport
public java.lang.String loadObjects() throws java.lang.Exception
loadObjects
in interface JiveObjectLoader
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.
java.lang.Exception
- if an unexpected error occurs.public EntityDescriptor getEntityDescriptor(java.util.Map parameters)
EntityAware
getEntityDescriptor
in interface EntityAware
getEntityDescriptor
in class ForumActionSupport
parameters
- a Map of parameters with String keys and Long values.
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |