Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.action
Class DeleteAction

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.ForumAction
                  extended by com.jivesoftware.forum.action.ForumThreadAction
                      extended by com.jivesoftware.forum.action.DeleteAction
All Implemented Interfaces:
AuthTokenAware, EntityAware, JiveObjectLoader, UserAware, ForumFactoryAware, ForumMessageAware, Pageable, 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 DeleteAction
extends ForumThreadAction

An action that encapsulates all the logic for deleting content.

See Also:
Serialized Form

Field Summary
static java.lang.String DELETE_ALL
           
static java.lang.String DELETE_SINGLE
           
 
Fields inherited from class com.jivesoftware.forum.action.ForumThreadAction
DEFAULT_THREAD_MODE, THREAD_FLAT, THREAD_THREADED, THREAD_TREE
 
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
DeleteAction()
           
 
Method Summary
 java.lang.String doDefault()
           
 java.lang.String execute()
          Validates the forum ID and either redirects to the SUCCESS, ERROR page if the id was not found or the login page if the page user is not authorized to view the forum.
 java.lang.String getDeleteMode()
           
 java.lang.String getDoCancel()
           
 boolean getIsThreadDeletion()
          Returns true if we're going to delete (or deleted) a thread, false if it is (or was) a message.
 void setDeleteMode(java.lang.String deleteMode)
           
 void setDoCancel(java.lang.String doCancel)
           
 
Methods inherited from class com.jivesoftware.forum.action.ForumThreadAction
getEntityDescriptor, getMessage, getMessageID, getMessages, getNextThread, getNextTstart, getPopularTags, getPreviousThread, getPrevTstart, getRecommendedTags, getResultFilter, getStart, getThread, getThreadID, getThreadMode, getTotalItemCount, getTstart, hasNextThread, hasPreviousThread, isArchived, isLocked, isRootMessage, isStqc, loadObjects, setMessage, setMessageID, setResultFilter, setStart, setStqc, setThread, setThreadID, setTstart
 
Methods inherited from class com.jivesoftware.forum.action.ForumAction
getAnnouncements, getForum, getForumID, getMessageResultFilter, getThreads, initFields, loadJiveObjects, setForum, setForumID, setMessageResultFilter
 
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
 

Field Detail

DELETE_ALL

public static java.lang.String DELETE_ALL

DELETE_SINGLE

public static java.lang.String DELETE_SINGLE
Constructor Detail

DeleteAction

public DeleteAction()
Method Detail

getDoCancel

public java.lang.String getDoCancel()

setDoCancel

public void setDoCancel(java.lang.String doCancel)

getDeleteMode

public java.lang.String getDeleteMode()

setDeleteMode

public void setDeleteMode(java.lang.String deleteMode)

getIsThreadDeletion

public boolean getIsThreadDeletion()
Returns true if we're going to delete (or deleted) a thread, false if it is (or was) a message.

Returns:
true if a thread is being deleted, false if a message is being deleted.

doDefault

public java.lang.String doDefault()
Overrides:
doDefault in class com.opensymphony.xwork.ActionSupport

execute

public java.lang.String execute()
Description copied from class: ForumThreadAction
Validates the forum ID and either redirects to the SUCCESS, ERROR page if the id was not found or the login page if the page user is not authorized to view the forum.

Specified by:
execute in interface com.opensymphony.xwork.Action
Overrides:
execute in class ForumThreadAction
Returns:
Action.SUCCESS if the forum was loaded successfully, ForumActionSupport.UNAUTHORIZED or Action.ERROR otherwise.

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.