Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.action
Class SpellAction

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.OldPostAction
                  extended by com.jivesoftware.forum.action.SpellAction
All Implemented Interfaces:
AuthTokenAware, EntityAware, UserAware, ForumFactoryAware, com.opensymphony.webwork.interceptor.ServletRequestAware, com.opensymphony.webwork.interceptor.ServletResponseAware, com.opensymphony.webwork.interceptor.SessionAware, 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 SpellAction
extends OldPostAction
implements com.opensymphony.xwork.Validateable

An action that encapsulates all the logic for doing spell checks.

See Also:
Serialized Form

Field Summary
static java.lang.String GOBACK
           
static java.lang.String POST
           
 
Fields inherited from class com.jivesoftware.forum.action.OldPostAction
ATTACH, PREVIEW, REJECTED, SPELLCHECK
 
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
SpellAction()
           
 
Method Summary
 java.lang.String doDefault()
          Loads specified Jive objects (the forum, parent message, etc) and checks that the user has posting permission in this forum.
 java.lang.String execute()
          Loads specified Jive objects (the forum, parent message, etc) and checks that the user has posting permission in this forum.
 java.lang.Boolean getAnsQuestion()
           
 java.lang.String getBody()
          Returns the message body.
 java.lang.String getDoAdd()
           
 java.lang.String getDoChange()
           
 java.lang.String getDoChangeAll()
           
 java.lang.String getDoDelete()
           
 java.lang.String getDoDeleteSecond()
           
 java.lang.String getDoEdit()
           
 java.lang.String getDoIgnore()
           
 java.lang.String getDoIgnoreAll()
           
 java.lang.String getDoPostNow()
           
 java.lang.String getNewWord()
           
protected  SpellSession getSpellSession()
           
 java.lang.String getSubject()
          Returns the message subject.
 java.lang.String[] getSuggestions()
           
 boolean hasSpellingErrors()
           
 boolean hasSuggestions()
           
 boolean isDoubleWords()
           
 boolean isMisspelledWords()
           
 void setAnsQuestion(java.lang.Boolean ansQuestion)
           
 void setBody(java.lang.String body)
          Sets the message body.
 void setDoAdd(java.lang.String doAdd)
           
 void setDoChange(java.lang.String doChange)
           
 void setDoChangeAll(java.lang.String doChangeAll)
           
 void setDoDelete(java.lang.String doDelete)
           
 void setDoDeleteSecond(java.lang.String doDeleteSecond)
           
 void setDoEdit(java.lang.String doEdit)
           
 void setDoIgnore(java.lang.String doIgnore)
           
 void setDoIgnoreAll(java.lang.String doIgnoreAll)
           
 void setDoPostNow(java.lang.String doPostNow)
           
 void setDoubleWords(boolean doubleWords)
           
 void setMisspelledWords(boolean misspelledWords)
           
 void setNewWord(java.lang.String newWord)
           
 void validate()
          Validates all user input.
 
Methods inherited from class com.jivesoftware.forum.action.OldPostAction
cleanSession, createMessage, doPost, doRemoveAttach, doReply, getAssignPoints, getAttachmentCount, getAttachments, getDoAttach, getDoGoBack, getDoPost, getDoPreview, getDoQuoteOriq, getDoSpellCheck, getDraft, getEmail, getEntityDescriptor, getForum, getForumID, getFrom, getMessage, getMessageID, getName, getNewMessage, getNewMessageIsModerated, getPartialURL, getPreviewedMessage, getReplySubject, getResolution, getSessionSuffix, getTempAttachmentID, getThread, getThreadID, getTid, getToHex, isCancel, isDraftEnabled, isDraftExists, isEdit, isMarkAsQuestion, isQuote, isReply, isShortTermQueryCacheEnabled, loadJiveObjects, loadToSession, removeFromSession, retrieveFromSession, setAssignPoints, setCancel, setDoAttach, setDoGoBack, setDoPost, setDoPreview, setDoQuoteOriq, setDoSpellCheck, setDraft, setDraftEnabled, setDraftExists, setEmail, setForum, setForumID, setFrom, setMarkAsQuestion, setMessage, setMessageID, setName, setNewMessage, setQuote, setReply, setResolution, setServletRequest, setSession, setSubject, setTempAttachmentID, setThread, setThreadID, setTid, setUseDraft, useDraft
 
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
 

Field Detail

GOBACK

public static final java.lang.String GOBACK
See Also:
Constant Field Values

POST

public static final java.lang.String POST
See Also:
Constant Field Values
Constructor Detail

SpellAction

public SpellAction()
Method Detail

getDoChange

public java.lang.String getDoChange()

setDoChange

public void setDoChange(java.lang.String doChange)

getDoChangeAll

public java.lang.String getDoChangeAll()

setDoChangeAll

public void setDoChangeAll(java.lang.String doChangeAll)

getDoIgnore

public java.lang.String getDoIgnore()

setDoIgnore

public void setDoIgnore(java.lang.String doIgnore)

getDoIgnoreAll

public java.lang.String getDoIgnoreAll()

setDoIgnoreAll

public void setDoIgnoreAll(java.lang.String doIgnoreAll)

getDoAdd

public java.lang.String getDoAdd()

setDoAdd

public void setDoAdd(java.lang.String doAdd)

getDoDelete

public java.lang.String getDoDelete()

setDoDelete

public void setDoDelete(java.lang.String doDelete)

getDoEdit

public java.lang.String getDoEdit()

setDoEdit

public void setDoEdit(java.lang.String doEdit)

getDoPostNow

public java.lang.String getDoPostNow()

setDoPostNow

public void setDoPostNow(java.lang.String doPostNow)

getNewWord

public java.lang.String getNewWord()

setNewWord

public void setNewWord(java.lang.String newWord)

getDoDeleteSecond

public java.lang.String getDoDeleteSecond()

setDoDeleteSecond

public void setDoDeleteSecond(java.lang.String doDeleteSecond)

getSuggestions

public java.lang.String[] getSuggestions()

hasSuggestions

public boolean hasSuggestions()

getSubject

public java.lang.String getSubject()
Description copied from class: OldPostAction
Returns the message subject.

Overrides:
getSubject in class OldPostAction
Returns:
the message subject.

getBody

public java.lang.String getBody()
Description copied from class: OldPostAction
Returns the message body.

Overrides:
getBody in class OldPostAction
Returns:
the message body.

setBody

public void setBody(java.lang.String body)
Description copied from class: OldPostAction
Sets the message body.

Overrides:
setBody in class OldPostAction
Parameters:
body - the body of a message.

isMisspelledWords

public boolean isMisspelledWords()

setMisspelledWords

public void setMisspelledWords(boolean misspelledWords)

isDoubleWords

public boolean isDoubleWords()

setDoubleWords

public void setDoubleWords(boolean doubleWords)

hasSpellingErrors

public boolean hasSpellingErrors()

getAnsQuestion

public java.lang.Boolean getAnsQuestion()

setAnsQuestion

public void setAnsQuestion(java.lang.Boolean ansQuestion)

validate

public void validate()
Description copied from class: OldPostAction
Validates all user input. This method is protected because it should only be called internally or by a subclass.

Specified by:
validate in interface com.opensymphony.xwork.Validateable
Overrides:
validate in class OldPostAction

doDefault

public java.lang.String doDefault()
Description copied from class: OldPostAction
Loads specified Jive objects (the forum, parent message, etc) and checks that the user has posting permission in this forum. If there are errors loading the objects, Action.ERROR is returned and if the user doesn't have permission to post, Action.LOGIN is returned.

This method will also add info messages - views can display them by getting Iterators from the ActionSupport.getActionMessages() method.

Overrides:
doDefault in class OldPostAction
Returns:
the view to redirect to.

execute

public java.lang.String execute()
Description copied from class: OldPostAction
Loads specified Jive objects (the forum, parent message, etc) and checks that the user has posting permission in this forum. If there are errors loading the objects, Action.ERROR is returned and if the user doesn't have permission to post, Action.LOGIN is returned.

This method also validates all message fields and, depending on what the user wants to do (post, preview, etc), executes the appropriate course of action.

If the user wants to post the message and all fields validate, this method will post the message and return Action.SUCCESS;

Specified by:
execute in interface com.opensymphony.xwork.Action
Overrides:
execute in class OldPostAction
Returns:
the view to redirect to.

getSpellSession

protected SpellSession getSpellSession()

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.