|
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.PollViewAction
public class PollViewAction
Logic for loading a poll given a poll ID.
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 |
---|
public PollViewAction()
Method Detail |
---|
public long getPollID()
public void setPollID(long pollID)
public Poll getPoll()
public boolean isSystemPoll()
public boolean isCategoryPoll()
public boolean isForumPoll()
public boolean canCreatePoll()
public boolean canEditPoll()
public java.lang.String execute() throws java.lang.Exception
Action.SUCCESS
always.
execute
in interface com.opensymphony.xwork.Action
execute
in class ForumActionSupport
java.lang.Exception
public java.lang.String loadObjects() throws java.lang.Exception
ForumActionSupport.NOTFOUND
if the poll ID is invalid
or ForumActionSupport.UNAUTHORIZED
if the poll is not viewable.
loadObjects
in interface JiveObjectLoader
Action.SUCCESS
if object loading occurred normally,
anything else to indicate that object loading failed.
java.lang.Exception
- if an unexpected error occurs when loading the objects.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 |