com.sri.emo.wizard.selection
Class WizardAction

java.lang.Object
  extended by org.apache.struts.action.Action
      extended by com.jcorporate.expresso.core.controller.Controller
          extended by com.jcorporate.expresso.core.controller.DBController
              extended by com.sri.common.controller.AbstractDBController
                  extended by com.sri.common.controller.AbstractComponentController
                      extended by com.sri.emo.wizard.expressoimpl.WizardController
                          extended by com.sri.emo.wizard.selection.WizardAction
All Implemented Interfaces:
ComponentServiceLocator, Serializable

public class WizardAction
extends WizardController

Derived controller for Wizard steps in EMO. Provides unique construction and finishing capabilities as well as the final saving of the EMO wizard.

Author:
Michael Rimov
See Also:
Serialized Form

Field Summary
static String NO_WIZ_ERROR_MESSAGE
          No wizard error message constant.
static String STATE_CLONE_TEMPLATE
          Constant for state "Clone Template"
static String STATE_NAME_TEMPLATE
          Constant for state "Prompt Template Name"
 
Fields inherited from class com.sri.emo.wizard.expressoimpl.WizardController
CANCEL_STATE, CURRENT_PAGE_NUM, DISPLAY_STATE, FINISH_REQUEST, FINISH_RESPONSE, FINISH_STATE, NEXT_STATE, PREVIOUS_STATE, REQUEST_ID, SESSION_STATE_KEY_PREFIX, STATE_BEGIN, STATE_JUMP_BACKWARDS, TOTAL_PAGES, WIZ_DATA_ID, WIZ_PAGE_PARAMETER, WIZ_PARAMETER_ID, WIZ_RESULT_ID
 
Fields inherited from class com.sri.common.controller.AbstractComponentController
REQUEST_CONTAINER
 
Fields inherited from class com.sri.common.controller.AbstractDBController
COLUMN, COMMON_FOOTER_HANDLER, COMMON_HEADER_HANDLER, DELIMIT, EDIT_GROUP_DISPLAY, EMBEDDED_MODE, FOOTER, MAX_CHARS_OUTPUT, MAX_TEXTAREA_LENGTH, MULTIPLE_TEXTAREA_NUM_LINES, ROW, ROW_BLOCK, SESSION_CONTAINER, SINGLE_TEXTAREA_NUM_LINES, TEXTAREA_NUM_COLS, WARNING_LIST
 
Fields inherited from class com.jcorporate.expresso.core.controller.DBController
CACHE_NAME
 
Fields inherited from class com.jcorporate.expresso.core.controller.Controller
CONTROLLER_PARAM_KEY, CTL_SUCC_CTL, CTL_SUCC_STATE, CTL_SUCC_TRAN, mLog, NEWSTATE_EXCEPTION_KEY, ORIGINAL_URL_KEY, REQUEST_KEY, RESPONSE_KEY, RETURN_TO_SENDER_TRAN, STATE_ERR_CTL, STATE_ERR_STATE, STATE_ERR_TRAN, STATE_PARAM_KEY, STATE_SUCC_CTL, STATE_SUCC_STATE, STATE_SUCC_TRAN
 
Fields inherited from class org.apache.struts.action.Action
defaultLocale, servlet
 
Constructor Summary
WizardAction()
          Default constructor.
 
Method Summary
protected  void addOnFinishWizardParameters(ExpressoRequest request, ExpressoResponse response, Map parameterMap)
           
protected  void afterFinishState(ExpressoRequest request, ExpressoResponse response)
          Template method.
protected  Transition getCancelTransition()
          Override to provide backlink to list wizards page in EMO.
protected  Wizard newWizard(ExpressoRequest request)
          Override of WizardController to provide for the unique capabilities and requirements of an ExpressoAwareWizardRepository as defined in the Schema.
protected  void runPromptTemplateNameState(ExpressoRequest request, ExpressoResponse response)
          Prompts for the name of the template to clone as defined by the decision matrix.
 
Methods inherited from class com.sri.emo.wizard.expressoimpl.WizardController
addPageNumberForSequentialWizards, addWizardInput, extractPostedWizardData, getCurrentPage, getCurrentWizard, getMementoConverter, getSessionKey, getTitle, handleNoEntryErrorInPage, hasNoDataEntryAndShould, releaseWizard, runBeginState, runCancelState, runDisplayState, runFinishState, runJumpBackwardsState, runNextState, runPreviousState, storeWizInSession
 
Methods inherited from class com.sri.common.controller.AbstractComponentController
addStateHandler, initializeControllerContainer, locate, locator, newExpressoState, postPerform, prePerform
 
Methods inherited from class com.sri.common.controller.AbstractDBController
addEmbeddedParameter, addWarning, addWarningList, getActionForwarding, getCheckbox, getPermsTrans, getPrettyXML, getTextArea, getTextArea, getWarningList, isEmbeddedMode, isValidAndPopulated, outputXML, populateDBObject, stateAllowed, str, strTrunc, trimAllTextFields
 
Methods inherited from class com.jcorporate.expresso.core.controller.DBController
getString, isAllowed
 
Methods inherited from class com.jcorporate.expresso.core.controller.Controller
addFinalState, addPromptTransitions, addRegDomainParamtoSession, addRequestedURLtoSession, addState, addStatePairing, endTimer, execute, findControllerForm, generateToken, getActionForward, getControllerChainingTransition, getControllerSecurityTransition, getFinalState, getInitialState, getLogger, getParamValues, getRequestURL, getSchema, getSchemaHierarchy, getSchemaInstance, getSchemaStack, getState, getStates, getString, getString, handleException, instantiate, isFinalState, isHandleState, isPromptState, isTokenValid, loadStateForm, newState, nextHandleState, nextPromptState, populateStateForm, postPerform, prePerform, previousPromptState, processRequestTransitions, processTransitions, redirectRequest, redirectRequest, remapFromExtension, resetToken, saveToken, setControllerChainingTransition, setControllerSecurityTransition, setCurrentState, setInitialState, setSchema, setSchema, setupDefaultValues, setupReturnToSender, setupSubclassLog, transition, transition, transition, unloadStateForm
 
Methods inherited from class org.apache.struts.action.Action
addErrors, addMessages, execute, generateToken, getDataSource, getDataSource, getErrors, getLocale, getMessages, getResources, getResources, getServlet, isCancelled, isTokenValid, isTokenValid, resetToken, saveErrors, saveErrors, saveMessages, saveMessages, saveToken, setLocale, setServlet
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

STATE_NAME_TEMPLATE

public static final String STATE_NAME_TEMPLATE
Constant for state "Prompt Template Name"

See Also:
Constant Field Values

STATE_CLONE_TEMPLATE

public static final String STATE_CLONE_TEMPLATE
Constant for state "Clone Template"

See Also:
Constant Field Values

NO_WIZ_ERROR_MESSAGE

public static final String NO_WIZ_ERROR_MESSAGE
No wizard error message constant.

See Also:
Constant Field Values
Constructor Detail

WizardAction

public WizardAction()
Default constructor. Adds two more states to the typical Wizard Controller: prompt template name and clone template.

Method Detail

getCancelTransition

protected Transition getCancelTransition()
Override to provide backlink to list wizards page in EMO.

Overrides:
getCancelTransition in class WizardController
Returns:
Transition.

newWizard

protected Wizard newWizard(ExpressoRequest request)
                    throws WizardException,
                           ControllerException
Override of WizardController to provide for the unique capabilities and requirements of an ExpressoAwareWizardRepository as defined in the Schema.

Overrides:
newWizard in class WizardController
Parameters:
request - The ExpressoRequestObject
Returns:
Wizard instance
Throws:
WizardException - upon wizard related construction error
ControllerException - upon parameter retrieval error.

runPromptTemplateNameState

protected void runPromptTemplateNameState(ExpressoRequest request,
                                          ExpressoResponse response)
                                   throws ControllerException,
                                          NonHandleableException
Prompts for the name of the template to clone as defined by the decision matrix.

Parameters:
request - the ExpressoRequest object
response - the ExpressoResponse object.
Throws:
ControllerException - upon error
NonHandleableException - upon fatal error

addOnFinishWizardParameters

protected void addOnFinishWizardParameters(ExpressoRequest request,
                                           ExpressoResponse response,
                                           Map parameterMap)
Overrides:
addOnFinishWizardParameters in class WizardController

afterFinishState

protected void afterFinishState(ExpressoRequest request,
                                ExpressoResponse response)
                         throws ControllerException
Template method. In this case, the wizard proper performs a redirect.

Overrides:
afterFinishState in class WizardController
Parameters:
request - ExpressoRequest Expresso Request object
response - ExpressoResponse ExpressoResponse object
Throws:
ControllerException - Never


Copyright © 2004-2006 Codeguild, Inc.. All Rights Reserved.