|
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.ForumAction
com.jivesoftware.forum.action.ForumThreadAction
com.jivesoftware.forum.action.PollAction
public class PollAction
Field Summary | |
---|---|
static java.lang.String |
EXPIRED
|
static java.lang.String |
VOTED
|
Fields inherited from class com.jivesoftware.forum.action.ForumThreadAction |
---|
DEFAULT_THREAD_MODE, THREAD_FLAT, THREAD_THREADED, THREAD_TREE |
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 | |
---|---|
PollAction()
|
Method Summary | |
---|---|
java.lang.String |
doDefault()
|
java.lang.String |
execute()
Validates the forum ID and either redirects to the SUCCESS, ERROR page if the id was not found or the login page if the page user is not authorized to view the forum. |
ForumCategory |
getCategory()
|
long |
getCategoryID()
|
EntityDescriptor |
getEntityDescriptor(java.util.Map parameters)
Returns information (ID, type) about a specific type given a Map of parameters. |
int[] |
getOption()
|
Poll |
getPoll()
|
long |
getPollID()
|
boolean |
hasVoted()
|
boolean |
isAllowedToVote()
|
boolean |
isPollActive()
|
boolean |
isPollExpired()
|
java.lang.String |
loadObjects()
Override the loading of page objects from ForumThreadAction. |
void |
setCategoryID(long categoryID)
|
void |
setOption(int[] option)
|
void |
setPollID(long pollID)
|
Methods inherited from class com.jivesoftware.forum.action.ForumThreadAction |
---|
getMessage, getMessageID, getMessages, getNextThread, getNextTstart, getPopularTags, getPreviousThread, getPrevTstart, getRecommendedTags, getResultFilter, getStart, getThread, getThreadID, getThreadMode, getTotalItemCount, getTstart, hasNextThread, hasPreviousThread, isArchived, isLocked, isRootMessage, isStqc, setMessage, setMessageID, setResultFilter, setStart, setStqc, setThread, setThreadID, setTstart |
Methods inherited from class com.jivesoftware.forum.action.ForumAction |
---|
getAnnouncements, getForum, getForumID, getMessageResultFilter, getThreads, initFields, loadJiveObjects, setForum, setForumID, setMessageResultFilter |
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, validate |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String EXPIRED
public static final java.lang.String VOTED
Constructor Detail |
---|
public PollAction()
Method Detail |
---|
public long getPollID()
public void setPollID(long pollID)
public ForumCategory getCategory()
public long getCategoryID()
public void setCategoryID(long categoryID)
public int[] getOption()
public void setOption(int[] option)
public boolean hasVoted()
public boolean isAllowedToVote()
public boolean isPollActive()
public boolean isPollExpired()
public Poll getPoll()
public EntityDescriptor getEntityDescriptor(java.util.Map parameters)
EntityAware
getEntityDescriptor
in interface EntityAware
getEntityDescriptor
in class ForumThreadAction
parameters
- a Map of parameters with String keys and Long values.
public java.lang.String doDefault() throws java.lang.Exception
doDefault
in class com.opensymphony.xwork.ActionSupport
java.lang.Exception
public java.lang.String execute() throws java.lang.Exception
ForumThreadAction
execute
in interface com.opensymphony.xwork.Action
execute
in class ForumThreadAction
Action.SUCCESS
if the forum was loaded successfully, ForumActionSupport.UNAUTHORIZED
or
Action.ERROR
otherwise.
java.lang.Exception
public java.lang.String loadObjects() throws java.lang.Exception
loadObjects
in interface JiveObjectLoader
loadObjects
in class ForumThreadAction
java.lang.Exception
- if an unexpected error occurs when loading the objects.
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |