|
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.PollPostAction
com.jivesoftware.forum.action.PollEditAction
public class PollEditAction
Field Summary |
---|
Fields inherited from class com.jivesoftware.forum.action.PollPostAction |
---|
ACTIVE_LATER, ACTIVE_NOW, ENDS_LATER, ENDS_NEVER, ENDS_RELATIVE, EXPIRES_LATER, EXPIRES_NEVER, EXPIRES_RELATIVE, validatedActiveDate, validatedEndDate, validatedExpireDate |
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, 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 | |
---|---|
PollEditAction()
|
Method Summary | |
---|---|
java.lang.String |
doDefault()
Loads environment to create a poll. |
java.lang.String |
execute()
Creates a new poll. |
EntityDescriptor |
getEntityDescriptor(java.util.Map parameters)
Returns information (ID, type) about a specific type given a Map of parameters. |
Poll |
getPoll()
Returns the poll we've loaded. |
long |
getPollID()
Returns the ID of the poll to load. |
java.lang.String |
loadObjects()
Optionally loads the category or forum specified. |
void |
setPollID(long pollID)
Sets the ID of the poll to load. |
Methods inherited from class com.jivesoftware.forum.action.PollPostAction |
---|
getActiveDate, getActiveMode, getCategory, getCategoryID, getDescription, getDraft, getEndsDate, getEndsDays, getEndsMode, getExpiresDate, getExpiresDays, getExpiresMode, getForum, getForumID, getName, getObjectID, getObjectType, getOptions, hasDraft, isCancel, isDraftEnabled, isDraftExists, setActiveDate, setActiveMode, setCancel, setCategory, setCategoryID, setDescription, setDraft, setDraftExists, setEndsDate, setEndsDays, setEndsMode, setExpiresDate, setExpiresDays, setExpiresMode, setForum, setForumID, setName, setObjectID, setObjectType, setOptions, setServletRequest, setUseDraft, useDraft, validate |
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, 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 PollEditAction()
Method Detail |
---|
public long getPollID()
public void setPollID(long pollID)
public Poll getPoll()
getPoll
in class PollPostAction
public java.lang.String doDefault() throws java.lang.Exception
PollPostAction
ForumActionSupport.UNAUTHORIZED
if the user has no permission to create a poll.Action.INPUT
if there were no problems creating the poll environment and the action
is ready for input.
doDefault
in class PollPostAction
Action.INPUT
if the poll environment is setup, ForumActionSupport.UNAUTHORIZED
if the user has no
permission to create a poll.
java.lang.Exception
public java.lang.String execute() throws java.lang.Exception
ForumActionSupport.CANCEL
if the user cancels the poll creation process.ForumActionSupport.UNAUTHORIZED
if the user has no permission to create the poll.Action.SUCCESS
if the user cancels the poll creation process.
execute
in interface com.opensymphony.xwork.Action
execute
in class PollPostAction
Action.SUCCESS
if the poll was created successfully, ForumActionSupport.UNAUTHORIZED
, ForumActionSupport.CANCEL
or
Action.ERROR
otherwise.
java.lang.Exception
public java.lang.String loadObjects()
PollPostAction
ForumActionSupport.NOTFOUND
is returned or
Action.SUCCESS
otherwise. If the user doesn't have read permission to the forum then
ForumActionSupport.UNAUTHORIZED
is returned.
loadObjects
in interface JiveObjectLoader
loadObjects
in class PollPostAction
Action.SUCCESS
if object loading occurred normally,
anything else to indicate that object loading failed.public EntityDescriptor getEntityDescriptor(java.util.Map parameters)
EntityAware
getEntityDescriptor
in interface EntityAware
getEntityDescriptor
in class PollPostAction
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 |