Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.action
Class AnnounceExpireAction

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
                  extended by com.jivesoftware.forum.action.AnnounceExpireAction
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 AnnounceExpireAction
extends AnnounceAction

A simple action to handle expiration of announcements.

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
AnnounceExpireAction()
           
 
Method Summary
 java.lang.String doDefault()
          Returns Action.INPUT always.
 java.lang.String execute()
          Returns Action.SUCCESS if the announcement was expired successfully or ForumActionSupport.UNAUTHORIZED if the user can not expired the announcement.
 java.lang.String isCancel()
          Indicates the user wants to cancel.
 void setCancel(java.lang.String cancel)
          Sets whether or not the user wants to cancel.
 
Methods inherited from class com.jivesoftware.forum.action.AnnounceAction
getAnnID, getAnnouncement, getCategory, getEntityDescriptor, getForum, getObjectType, isCategoryAnnounce, isForumAnnounce, isModerator, isSystemAnnounce, loadObjects, setAnnID
 
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
 

Constructor Detail

AnnounceExpireAction

public AnnounceExpireAction()
Method Detail

isCancel

public java.lang.String isCancel()
Indicates the user wants to cancel.


setCancel

public void setCancel(java.lang.String cancel)
Sets whether or not the user wants to cancel.


doDefault

public java.lang.String doDefault()
Returns Action.INPUT always.

Overrides:
doDefault in class com.opensymphony.xwork.ActionSupport

execute

public java.lang.String execute()
Returns Action.SUCCESS if the announcement was expired successfully or ForumActionSupport.UNAUTHORIZED if the user can not expired the announcement. Also, ForumActionSupport.CANCEL is returned if the user cancels the action.

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

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.