Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.action.setup
Class SetupActionSupport

java.lang.Object
  extended by com.jivesoftware.forum.action.setup.SetupActionSupport
All Implemented Interfaces:
com.opensymphony.xwork.Action, com.opensymphony.xwork.LocaleProvider, com.opensymphony.xwork.TextProvider, com.opensymphony.xwork.ValidationAware
Direct Known Subclasses:
AdminSetupAction, CustomUserSystemSetupAction, DatasourceSetupAction, LdapAdminSetupAction, LdapUserSystemSetupAction, SetupAction, UserSystemSetupAction

public class SetupActionSupport
extends java.lang.Object
implements com.opensymphony.xwork.Action, com.opensymphony.xwork.TextProvider, com.opensymphony.xwork.LocaleProvider, com.opensymphony.xwork.ValidationAware

A base action class that handles a set of common code for the setup process.


Field Summary
static java.lang.String DONE
           
static java.lang.String IN_PROGRESS
           
static java.lang.String INCOMPLETE
           
static java.lang.String NEXT
           
 
Fields inherited from interface com.opensymphony.xwork.Action
ERROR, INPUT, LOGIN, NONE, SUCCESS
 
Constructor Summary
SetupActionSupport()
           
 
Method Summary
 void addActionError(java.lang.String anErrorMessage)
           
 void addActionMessage(java.lang.String aMessage)
           
 void addFieldError(java.lang.String fieldName, java.lang.String errorMessage)
           
 java.lang.String execute()
           
 java.util.Collection getActionErrors()
           
 java.util.Collection getActionMessages()
           
 java.lang.String getDoContinue()
           
 java.util.Map getFieldErrors()
           
 java.io.File getJiveFile(java.lang.String filename)
          Returns a file in the jiveHome directory.
 java.io.File getJiveHome()
          Returns the jiveHome directory as a File.
 java.util.Locale getLocale()
           
 java.lang.String getLocaleCode()
           
 java.lang.String getText(java.lang.String aTextName)
           
 java.lang.String getText(java.lang.String aTextName, java.util.List args)
           
 java.lang.String getText(java.lang.String aTextName, java.lang.String defaultValue)
           
 java.lang.String getText(java.lang.String key, java.lang.String[] args)
           
 java.lang.String getText(java.lang.String aTextName, java.lang.String defaultValue, java.util.List args)
           
 java.lang.String getText(java.lang.String s, java.lang.String s1, java.util.List list, com.opensymphony.xwork.util.OgnlValueStack ognlValueStack)
           
 java.lang.String getText(java.lang.String key, java.lang.String defaultValue, java.lang.String obj)
           
 java.lang.String getText(java.lang.String key, java.lang.String defaultValue, java.lang.String[] args)
           
 java.lang.String getText(java.lang.String key, java.lang.String defaultValue, java.lang.String[] args, com.opensymphony.xwork.util.OgnlValueStack stack)
           
 java.util.ResourceBundle getTexts()
           
 java.util.ResourceBundle getTexts(java.lang.String aBundleName)
           
 boolean hasActionErrors()
           
 boolean hasActionMessages()
           
 boolean hasErrors()
           
 boolean hasFieldErrors()
           
 boolean hasKey(java.lang.String key)
           
 void setActionErrors(java.util.Collection errorMessages)
           
 void setActionMessages(java.util.Collection messages)
           
 void setDoContinue(java.lang.String doContinue)
           
 void setFieldErrors(java.util.Map errorMap)
           
 void setLocaleCode(java.lang.String localeCode)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

NEXT

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

INCOMPLETE

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

IN_PROGRESS

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

DONE

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

SetupActionSupport

public SetupActionSupport()
Method Detail

hasKey

public boolean hasKey(java.lang.String key)
Specified by:
hasKey in interface com.opensymphony.xwork.TextProvider

getText

public java.lang.String getText(java.lang.String aTextName)
Specified by:
getText in interface com.opensymphony.xwork.TextProvider

getText

public java.lang.String getText(java.lang.String aTextName,
                                java.lang.String defaultValue)
Specified by:
getText in interface com.opensymphony.xwork.TextProvider

getText

public java.lang.String getText(java.lang.String key,
                                java.lang.String defaultValue,
                                java.lang.String obj)
Specified by:
getText in interface com.opensymphony.xwork.TextProvider

getText

public java.lang.String getText(java.lang.String aTextName,
                                java.util.List args)
Specified by:
getText in interface com.opensymphony.xwork.TextProvider

getText

public java.lang.String getText(java.lang.String key,
                                java.lang.String[] args)
Specified by:
getText in interface com.opensymphony.xwork.TextProvider

getText

public java.lang.String getText(java.lang.String aTextName,
                                java.lang.String defaultValue,
                                java.util.List args)
Specified by:
getText in interface com.opensymphony.xwork.TextProvider

getText

public java.lang.String getText(java.lang.String key,
                                java.lang.String defaultValue,
                                java.lang.String[] args)
Specified by:
getText in interface com.opensymphony.xwork.TextProvider

getText

public java.lang.String getText(java.lang.String s,
                                java.lang.String s1,
                                java.util.List list,
                                com.opensymphony.xwork.util.OgnlValueStack ognlValueStack)
Specified by:
getText in interface com.opensymphony.xwork.TextProvider

getText

public java.lang.String getText(java.lang.String key,
                                java.lang.String defaultValue,
                                java.lang.String[] args,
                                com.opensymphony.xwork.util.OgnlValueStack stack)
Specified by:
getText in interface com.opensymphony.xwork.TextProvider

getTexts

public java.util.ResourceBundle getTexts(java.lang.String aBundleName)
Specified by:
getTexts in interface com.opensymphony.xwork.TextProvider

getTexts

public java.util.ResourceBundle getTexts()
Specified by:
getTexts in interface com.opensymphony.xwork.TextProvider

getLocale

public java.util.Locale getLocale()
Specified by:
getLocale in interface com.opensymphony.xwork.LocaleProvider

setActionErrors

public void setActionErrors(java.util.Collection errorMessages)
Specified by:
setActionErrors in interface com.opensymphony.xwork.ValidationAware

getActionErrors

public java.util.Collection getActionErrors()
Specified by:
getActionErrors in interface com.opensymphony.xwork.ValidationAware

setActionMessages

public void setActionMessages(java.util.Collection messages)
Specified by:
setActionMessages in interface com.opensymphony.xwork.ValidationAware

getActionMessages

public java.util.Collection getActionMessages()
Specified by:
getActionMessages in interface com.opensymphony.xwork.ValidationAware

setFieldErrors

public void setFieldErrors(java.util.Map errorMap)
Specified by:
setFieldErrors in interface com.opensymphony.xwork.ValidationAware

getFieldErrors

public java.util.Map getFieldErrors()
Specified by:
getFieldErrors in interface com.opensymphony.xwork.ValidationAware

addActionError

public void addActionError(java.lang.String anErrorMessage)
Specified by:
addActionError in interface com.opensymphony.xwork.ValidationAware

addActionMessage

public void addActionMessage(java.lang.String aMessage)
Specified by:
addActionMessage in interface com.opensymphony.xwork.ValidationAware

addFieldError

public void addFieldError(java.lang.String fieldName,
                          java.lang.String errorMessage)
Specified by:
addFieldError in interface com.opensymphony.xwork.ValidationAware

hasActionErrors

public boolean hasActionErrors()
Specified by:
hasActionErrors in interface com.opensymphony.xwork.ValidationAware

hasActionMessages

public boolean hasActionMessages()
Specified by:
hasActionMessages in interface com.opensymphony.xwork.ValidationAware

hasErrors

public boolean hasErrors()
Specified by:
hasErrors in interface com.opensymphony.xwork.ValidationAware

hasFieldErrors

public boolean hasFieldErrors()
Specified by:
hasFieldErrors in interface com.opensymphony.xwork.ValidationAware

execute

public java.lang.String execute()
Specified by:
execute in interface com.opensymphony.xwork.Action

getLocaleCode

public java.lang.String getLocaleCode()

setLocaleCode

public void setLocaleCode(java.lang.String localeCode)

getDoContinue

public java.lang.String getDoContinue()

setDoContinue

public void setDoContinue(java.lang.String doContinue)

getJiveHome

public java.io.File getJiveHome()
Returns the jiveHome directory as a File.

Returns:
the jiveHome directory as a File or null if it is not specified.

getJiveFile

public java.io.File getJiveFile(java.lang.String filename)
Returns a file in the jiveHome directory. The String parameter is assumed to be the file path relative to the jiveHome directory. Also note, all path separator characters (/ or \) will be removed and replaced with the correct os-specific separator.

Returns:
a file in the jiveHome directory or null if that file can not be found.

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.