Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.action
Class AnnounceEditAction

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.PostAnnounceAction
                  extended by com.jivesoftware.forum.action.AnnounceEditAction
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

public class AnnounceEditAction
extends PostAnnounceAction

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.jivesoftware.forum.action.PostAnnounceAction
ACTIVE_LATER, ACTIVE_NOW, EXPIRES_LATER, EXPIRES_NEVER, EXPIRES_RELATIVE
 
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, 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
AnnounceEditAction()
           
 
Method Summary
 java.lang.String doDefault()
          Loads environment to create a announcement.
 long getAnnID()
           
 Announcement getAnnouncement()
          Returns the newly created announcement.
 EntityDescriptor getEntityDescriptor(java.util.Map parameters)
          Returns information (ID, type) about a specific type given a Map of parameters.
protected  Announcement loadAnnouncement()
           
 java.lang.String loadObjects()
          Loads objects in an action.
protected  void saveAnnouncement()
           
 void setAnnID(long annID)
           
 
Methods inherited from class com.jivesoftware.forum.action.PostAnnounceAction
execute, getActiveDate, getActiveMode, getAnnouncementManager, getBody, getCategory, getCategoryID, getDraft, getExpiresDate, getExpiresDays, getExpiresMode, getForum, getForumID, getSubject, hasDraft, isCancel, isDraftEnabled, isDraftExists, setActiveDate, setActiveMode, setBody, setCancel, setCategoryID, setDraft, setDraftExists, setExpiresDate, setExpiresDays, setExpiresMode, setForumID, setServletRequest, setSubject, setUseDraft, useDraft, validate
 
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, 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
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AnnounceEditAction

public AnnounceEditAction()
Method Detail

getAnnID

public long getAnnID()

setAnnID

public void setAnnID(long annID)

getAnnouncement

public Announcement getAnnouncement()
Description copied from class: PostAnnounceAction
Returns the newly created announcement.

Overrides:
getAnnouncement in class PostAnnounceAction
Returns:
the new announcement.

doDefault

public java.lang.String doDefault()
Description copied from class: PostAnnounceAction
Loads environment to create a announcement. Return codes:

Overrides:
doDefault in class PostAnnounceAction
Returns:
Action.INPUT if the announcement environment is setup, ForumActionSupport.UNAUTHORIZED if the user has no permission to create a announcement.

loadAnnouncement

protected Announcement loadAnnouncement()
                                 throws UnauthorizedException
Overrides:
loadAnnouncement in class PostAnnounceAction
Throws:
UnauthorizedException

saveAnnouncement

protected void saveAnnouncement()
                         throws UnauthorizedException
Overrides:
saveAnnouncement in class PostAnnounceAction
Throws:
UnauthorizedException

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
Overrides:
loadObjects in class PostAnnounceAction
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.

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

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.