Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.action
Class PollViewAction

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.PollViewAction
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 PollViewAction
extends ForumActionSupport
implements JiveObjectLoader

Logic for loading a poll given a poll ID.

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
PollViewAction()
           
 
Method Summary
 boolean canCreatePoll()
          Returns true if the page user has permission to post a poll in the given object type/ID, false otherwise.
 boolean canEditPoll()
          Returns true if the page user has permission to post a poll in the given object type/ID, and the poll was created by the page user.
 java.lang.String execute()
          Returns Action.SUCCESS always.
 EntityDescriptor getEntityDescriptor(java.util.Map parameters)
          Returns information (ID, type) about a specific type given a Map of parameters.
 Poll getPoll()
          The poll we're viewing.
 long getPollID()
          The ID of the poll to load.
 boolean isCategoryPoll()
          Returns true if this is a category level poll, false otherwise.
 boolean isForumPoll()
          Returns true if this is a forum level poll, false otherwise.
 boolean isSystemPoll()
          Returns true if this is a system-wide poll, false otherwise.
 java.lang.String loadObjects()
          Loads the poll given the poll ID.
 void setPollID(long pollID)
          Sets the ID of the poll to load.
 
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, doDefault, 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
 

Constructor Detail

PollViewAction

public PollViewAction()
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.


getPoll

public Poll getPoll()
The poll we're viewing.


isSystemPoll

public boolean isSystemPoll()
Returns true if this is a system-wide poll, false otherwise.


isCategoryPoll

public boolean isCategoryPoll()
Returns true if this is a category level poll, false otherwise.


isForumPoll

public boolean isForumPoll()
Returns true if this is a forum level poll, false otherwise.


canCreatePoll

public boolean canCreatePoll()
Returns true if the page user has permission to post a poll in the given object type/ID, false otherwise.


canEditPoll

public boolean canEditPoll()
Returns true if the page user has permission to post a poll in the given object type/ID, and the poll was created by the page user. false otherwise.


execute

public java.lang.String execute()
                         throws java.lang.Exception
Returns Action.SUCCESS always.

Specified by:
execute in interface com.opensymphony.xwork.Action
Overrides:
execute in class ForumActionSupport
Returns:
Action.SUCCESS
Throws:
java.lang.Exception

loadObjects

public java.lang.String loadObjects()
                             throws java.lang.Exception
Loads the poll given the poll ID. Will return ForumActionSupport.NOTFOUND if the poll ID is invalid or ForumActionSupport.UNAUTHORIZED if the poll is not viewable.

Specified by:
loadObjects in interface JiveObjectLoader
Returns:
Action.SUCCESS if object loading occurred normally, anything else to indicate that object loading failed.
Throws:
java.lang.Exception - if an unexpected error occurs when loading the objects.

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.