|
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.PollsViewAction
public class PollsViewAction
Class to support viewing multiple polls in a given area (system, category or forum).
Field Summary | |
---|---|
static int |
NUM_POLLS_PER_PAGE
|
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 | |
---|---|
PollsViewAction()
|
Method Summary | |
---|---|
java.lang.String |
execute()
Creates the iterator of active polls based on the forum or category passed in to this class as parameters. |
java.util.Iterator |
getActivePolls()
Returns an Iterator of polls for the given object type and object ID. |
ForumCategory |
getCategory()
Returns the category object loaded by the given category ID or null if no category was specified. |
long |
getCategoryID()
The ID of the cateogry we're loading. |
EntityDescriptor |
getEntityDescriptor(java.util.Map parameters)
Returns information (ID, type) about a specific type given a Map of parameters. |
Forum |
getForum()
Returns the forum object loaded by the given forum ID or null if no forum was specified. |
long |
getForumID()
The ID of the forum we're loading. |
PollManager |
getManager()
Returns the poll manager as a convenience. |
long |
getObjectID()
ID of the object to get polls from. |
int |
getObjectType()
Type of object we're getting polls from. |
ResultFilter |
getResultFilter()
Returns the result filter for the list of polls. |
int |
getStart()
Returns the start index of the list of polls. |
int |
getTotalItemCount()
Returns the total number of polls to be iterated over. |
boolean |
isCategoryPollList()
Returns true if the this poll list is a list of category polls, false otherwise. |
boolean |
isForumPollList()
Returns true if the this poll list is a list of forum polls, false otherwise. |
boolean |
isSystemPollList()
Returns true if the this poll list is a list of system-level polls, false otherwise. |
java.lang.String |
loadObjects()
Loads the category or forum objects if specified. |
void |
setCategoryID(long categoryID)
Sets the ID of the category to load. |
void |
setForumID(long forumID)
Sets the ID of the forum to load. |
void |
setObjectID(long objectID)
Sets the ID of the object to get polls from. |
void |
setObjectType(int objectType)
Sets the type of object we're getting polls from. |
void |
setStart(int start)
Sets the start index of the list of polls. |
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 |
Field Detail |
---|
public static final int NUM_POLLS_PER_PAGE
Constructor Detail |
---|
public PollsViewAction()
Method Detail |
---|
public long getObjectID()
public void setObjectID(long objectID)
public int getObjectType()
public void setObjectType(int objectType)
public long getCategoryID()
public void setCategoryID(long categoryID)
public long getForumID()
public void setForumID(long forumID)
public int getStart()
getStart
in interface Pageable
public void setStart(int start)
public int getTotalItemCount()
getTotalItemCount
in interface Pageable
public ResultFilter getResultFilter()
getResultFilter
in interface Pageable
public boolean isCategoryPollList()
public boolean isForumPollList()
public boolean isSystemPollList()
public Forum getForum()
public ForumCategory getCategory()
public PollManager getManager()
public java.util.Iterator getActivePolls()
public java.lang.String execute()
Action.SUCCESS
is returned if all goes well, ForumActionSupport.UNAUTHORIZED
is returned
if the user doesn't have permission to see the requested polls.
execute
in interface com.opensymphony.xwork.Action
execute
in class ForumActionSupport
public java.lang.String loadObjects() throws java.lang.Exception
ForumActionSupport.NOTFOUND
if not found or
ForumActionSupport.UNAUTHORIZED
if no permission to view the forum. Action.SUCCESS
if loading is successful.
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 |