inklings.jgatms.action
Class BaseAction

java.lang.Object
  extended byorg.apache.struts.action.Action
      extended byinklings.jgatms.action.BaseAction

public abstract class BaseAction
extends org.apache.struts.action.Action

Base Action class. This class wraps basic Struts functionality that can be reused by the subclasses. To create a specific action, subclass this class and override the executeLogic method.


Field Summary
 
Fields inherited from class org.apache.struts.action.Action
ACTION_SERVLET_KEY, APPLICATION_KEY, DATA_SOURCE_KEY, defaultLocale, ERROR_KEY, EXCEPTION_KEY, FORM_BEANS_KEY, FORWARDS_KEY, LOCALE_KEY, MAPPING_KEY, MAPPINGS_KEY, MESSAGE_KEY, MESSAGES_KEY, MULTIPART_KEY, PLUG_INS_KEY, REQUEST_PROCESSOR_KEY, servlet, SERVLET_KEY, TRANSACTION_TOKEN_KEY
 
Constructor Summary
BaseAction()
           
 
Method Summary
protected  org.apache.struts.action.ActionForm createFormInstance(org.apache.struts.action.ActionMapping mapping)
          Creates and returns the ActionForm instance for this action.
 org.apache.struts.action.ActionForward execute(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Struts execute API.
abstract  org.apache.struts.action.ActionForward executeLogic(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Executes the specific logic of the action.
 
Methods inherited from class org.apache.struts.action.Action
execute, generateToken, getDataSource, getDataSource, getLocale, getResources, getResources, getResources, getServlet, isCancelled, isTokenValid, isTokenValid, perform, perform, resetToken, saveErrors, saveMessages, saveToken, setLocale, setServlet, toHex
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BaseAction

public BaseAction()
Method Detail

execute

public org.apache.struts.action.ActionForward execute(org.apache.struts.action.ActionMapping mapping,
                                                      org.apache.struts.action.ActionForm form,
                                                      javax.servlet.http.HttpServletRequest request,
                                                      javax.servlet.http.HttpServletResponse response)
                                               throws java.lang.Exception
Struts execute API. This method is called by Struts to execute the functionality of the action.

Parameters:
mapping - The Struts action mapping for the action.
Returns:
An ActionForward indicating the next step in the workflow.
Throws:
java.lang.Exception - if an error occurs within the action.

executeLogic

public abstract org.apache.struts.action.ActionForward executeLogic(org.apache.struts.action.ActionMapping mapping,
                                                                    org.apache.struts.action.ActionForm form,
                                                                    javax.servlet.http.HttpServletRequest request,
                                                                    javax.servlet.http.HttpServletResponse response)
                                                             throws java.lang.Exception
Executes the specific logic of the action. This abstract method is to be implemented by subclasses of BaseAction to provide the functionality specific to each action.

Parameters:
mapping - The Struts action mapping for the action.
Returns:
An ActionForward indicating the next step in the workflow.
Throws:
java.lang.Exception - if an error occurs within the action.

createFormInstance

protected org.apache.struts.action.ActionForm createFormInstance(org.apache.struts.action.ActionMapping mapping)
                                                          throws java.lang.Exception
Creates and returns the ActionForm instance for this action. This method reads the Form Bean configuration passed in and creates the Form bean instance. It should not be called to return an existing instance, but only to create a new instance.

Throws:
java.lang.Exception - if the class cannot be created.


Copyright © 2003-2004 Inklings Technology Group. All Rights Reserved.