|
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.AnnounceAction
public class AnnounceAction
An action to load an announcement.
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 | |
---|---|
AnnounceAction()
|
Method Summary | |
---|---|
java.lang.String |
execute()
Default implementation of doExecute() method. |
long |
getAnnID()
Returns the ID of the announcement to load. |
Announcement |
getAnnouncement()
The requested announcement. |
ForumCategory |
getCategory()
Returns the category this announcement was created in or null if it was not created in a category. |
EntityDescriptor |
getEntityDescriptor(java.util.Map parameters)
Returns information (ID, type) about a specific type given a Map of parameters. |
Forum |
getForum()
Returns the forum this announcement was created in or null if it was not created in a forum. |
int |
getObjectType()
|
boolean |
isCategoryAnnounce()
Returns true if this announcement is a forum announcment, false otherwise. |
boolean |
isForumAnnounce()
Returns true if this announcement is a category announcment, false otherwise. |
boolean |
isModerator()
Returns true if the user is a moderator, or if the user has the announcement permission and the current announcement was authored by the user. |
boolean |
isSystemAnnounce()
Returns true if this announcement is a system-level announcment, false otherwise. |
java.lang.String |
loadObjects()
Loads objects in an action. |
void |
setAnnID(long annID)
Sets the ID of the announcement 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 AnnounceAction()
Method Detail |
---|
public long getAnnID()
public void setAnnID(long annID)
public int getObjectType()
public boolean isSystemAnnounce()
public boolean isCategoryAnnounce()
public boolean isForumAnnounce()
public boolean isModerator()
public Announcement getAnnouncement()
public Forum getForum()
public ForumCategory getCategory()
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.
public java.lang.String execute()
ForumActionSupport
execute
in interface com.opensymphony.xwork.Action
execute
in class ForumActionSupport
public java.lang.String loadObjects() throws java.lang.Exception
JiveObjectLoader
Action.SUCCESS
if
object loading occurred normally. If another type of code is returned then a WebWork interceptor
can pick up on that and return a different view page.
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.
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |