com.jivesoftware.forum.action
Class PollEditAction

java.lang.Object
  com.opensymphony.xwork.ActionSupport
      com.jivesoftware.base.action.JiveActionSupport
          com.jivesoftware.forum.action.ForumActionSupport
              com.jivesoftware.forum.action.PollPostAction
                  com.jivesoftware.forum.action.PollEditAction

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 PollEditAction
extends PollPostAction

See Also:

Serialized Form

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

PollEditAction

public PollEditAction()

Method Detail

getPollID

public long getPollID()

Returns the ID of the poll to load.

setPollID

public void setPollID(long pollID)

Sets the ID of the poll to load.

getPoll

public Poll getPoll()

Returns the poll we've loaded.

Overrides:

getPoll in class PollPostAction

doDefault

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

Description copied from class: PollPostAction

Loads environment to create a poll. Return codes:

• 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.

Overrides:

doDefault in class PollPostAction

Returns:

Action.INPUT if the poll environment is setup, ForumActionSupport.UNAUTHORIZED if the user has no permission to create a poll.

Throws:

java.lang.Exception

execute

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

Creates a new poll. Return codes:

• 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.

Specified by:

execute in interface com.opensymphony.xwork.Action

Overrides:

execute in class PollPostAction

Returns:

Action.SUCCESS if the poll was created successfully, ForumActionSupport.UNAUTHORIZED, ForumActionSupport.CANCEL or Action.ERROR otherwise.

Throws:

java.lang.Exception

loadObjects

public java.lang.String loadObjects()

Description copied from class: PollPostAction

Optionally loads the category or forum specified. If either fails then ForumActionSupport.NOTFOUND is returned or Action.SUCCESS otherwise. If the user doesn't have read permission to the forum then ForumActionSupport.UNAUTHORIZED is returned.

Specified by:

loadObjects in interface JiveObjectLoader

Overrides:

loadObjects in class PollPostAction

Returns:

Action.SUCCESS if object loading occurred normally, anything else to indicate that object loading failed.

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 PollPostAction

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.