Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.action
Class AnnounceAction

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.AnnounceAction
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
Direct Known Subclasses:
AnnounceDeleteAction, AnnounceExpireAction

public class AnnounceAction
extends ForumActionSupport
implements JiveObjectLoader

An action to load an announcement.

Since:
4.0
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
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

AnnounceAction

public AnnounceAction()
Method Detail

getAnnID

public long getAnnID()
Returns the ID of the announcement to load.


setAnnID

public void setAnnID(long annID)
Sets the ID of the announcement to load.


getObjectType

public int getObjectType()

isSystemAnnounce

public boolean isSystemAnnounce()
Returns true if this announcement is a system-level announcment, false otherwise.


isCategoryAnnounce

public boolean isCategoryAnnounce()
Returns true if this announcement is a forum announcment, false otherwise.


isForumAnnounce

public boolean isForumAnnounce()
Returns true if this announcement is a category announcment, false otherwise.


isModerator

public 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.

Returns:
true if the user can moderate this announcement, otherwise false.

getAnnouncement

public Announcement getAnnouncement()
The requested announcement.


getForum

public Forum getForum()
Returns the forum this announcement was created in or null if it was not created in a forum.


getCategory

public ForumCategory getCategory()
Returns the category this announcement was created in or null if it was not created in a category.


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.

execute

public java.lang.String execute()
Description copied from class: ForumActionSupport
Default implementation of doExecute() method. This class is intended to be a base class for other actions but can be used as an action itself if the skin author simply wants to get access to the context & methods provided by this class.

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

loadObjects

public java.lang.String loadObjects()
                             throws java.lang.Exception
Description copied from interface: JiveObjectLoader
Loads objects in an action. This method should return 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.

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.

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.