org.scrashmeow.ojb.console.framework
Class CommittingFormAction

java.lang.Object
  |
  +--org.apache.struts.action.Action
        |
        +--org.apache.struts.actions.DispatchAction
              |
              +--org.apache.struts.actions.LookupDispatchAction
                    |
                    +--org.scrashmeow.ojb.console.framework.OjbcLookupDispatchAction
                          |
                          +--org.scrashmeow.ojb.console.framework.ViewerAction
                                |
                                +--org.scrashmeow.ojb.console.framework.CommittingFormAction
All Implemented Interfaces:
ApplicationServiceAware, CancelActionAware, CommitActionAware, java.io.Serializable, ViewerActionAware
Direct Known Subclasses:
DescriptorExportAction, HomeAction, JdbcConnectionDescriptorEditorAction, ManageCacheAction, ManageDatabaseKeyAction, ManageUserSessionAction, ObjectEmptyAction, ObjectSearchAction, RepositoryBuilderAction, RepositoryHomeAction, RepositoryVerifyAction, SettingsHomeAction

public abstract class CommittingFormAction
extends ViewerAction
implements CommitActionAware

The base class for an action that has basic display, commit and cancel behavior.

Author:
Alexander Bibighaus
See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.apache.struts.actions.LookupDispatchAction
keyMethodMap, localeMap
 
Fields inherited from class org.apache.struts.actions.DispatchAction
clazz, log, messages, methods, types
 
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
 
Fields inherited from interface org.scrashmeow.ojb.console.framework.dispatch.CommitActionAware
COMMIT_METHOD
 
Fields inherited from interface org.scrashmeow.ojb.console.framework.dispatch.ViewerActionAware
DISPLAY_KEY, DISPLAY_METHOD
 
Fields inherited from interface org.scrashmeow.ojb.console.framework.dispatch.CancelActionAware
CANCEL_KEY, CANCEL_METHOD
 
Constructor Summary
CommittingFormAction()
           
 
Method Summary
 org.apache.struts.action.ActionForward cancel(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, HttpServletRequest request, HttpServletResponse response)
          The dispatch method that is triggered when a user wishes to cancel.
 org.apache.struts.action.ActionForward commit(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, HttpServletRequest request, HttpServletResponse response)
          The dispatch method that is triggered when a user wishes to commit.
 org.apache.struts.action.ActionForward getCancelForward(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, HttpServletRequest request)
          Returns the forward for the cancel dispatch
 org.apache.struts.action.ActionForward getCommitForward(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, HttpServletRequest request)
          Returns the forward for the commit dispatch
protected  java.util.Map getKeyMethodMap()
          Defines the dispatch key map
 
Methods inherited from class org.scrashmeow.ojb.console.framework.ViewerAction
display, getDisplayForward, unspecified
 
Methods inherited from class org.scrashmeow.ojb.console.framework.OjbcLookupDispatchAction
createBreadcrumbs, execute, findRedirectingForward, getApplicationService, initializeUserSession
 
Methods inherited from class org.apache.struts.actions.LookupDispatchAction
execute
 
Methods inherited from class org.apache.struts.actions.DispatchAction
dispatchMethod, getMethod, unspecified
 
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
 
Methods inherited from interface org.scrashmeow.ojb.console.framework.dispatch.ViewerActionAware
display, getDisplayForward
 

Constructor Detail

CommittingFormAction

public CommittingFormAction()
Method Detail

cancel

public org.apache.struts.action.ActionForward cancel(org.apache.struts.action.ActionMapping mapping,
                                                     org.apache.struts.action.ActionForm form,
                                                     HttpServletRequest request,
                                                     HttpServletResponse response)
                                              throws java.lang.Exception
The dispatch method that is triggered when a user wishes to cancel.

Specified by:
cancel in interface CancelActionAware
Parameters:
mapping - the ActionMapping
form - the ActionForm
request - the HttpServletRequest
response - the HttpServletResponse
Returns:
the ActionForward
Throws:
java.lang.Exception - when an error occurs.

getCancelForward

public org.apache.struts.action.ActionForward getCancelForward(org.apache.struts.action.ActionMapping mapping,
                                                               org.apache.struts.action.ActionForm form,
                                                               HttpServletRequest request)
                                                        throws java.lang.Exception
Returns the forward for the cancel dispatch

Specified by:
getCancelForward in interface CancelActionAware
Parameters:
mapping - the ActionMapping
form - the ActionForm
request - the HttpServletRequest
Returns:
the ActionForward
Throws:
java.lang.Exception - when an error occurs.

getCommitForward

public org.apache.struts.action.ActionForward getCommitForward(org.apache.struts.action.ActionMapping mapping,
                                                               org.apache.struts.action.ActionForm form,
                                                               HttpServletRequest request)
                                                        throws java.lang.Exception
Returns the forward for the commit dispatch

Specified by:
getCommitForward in interface CommitActionAware
Parameters:
mapping - the ActionMapping
form - the ActionForm
request - the HttpServletRequest
Returns:
the ActionForward
Throws:
java.lang.Exception - when an error occurs.

getKeyMethodMap

protected java.util.Map getKeyMethodMap()
Defines the dispatch key map

Overrides:
getKeyMethodMap in class ViewerAction
Returns:
a Map
See Also:
LookupDispatchAction.getKeyMethodMap()

commit

public org.apache.struts.action.ActionForward commit(org.apache.struts.action.ActionMapping mapping,
                                                     org.apache.struts.action.ActionForm form,
                                                     HttpServletRequest request,
                                                     HttpServletResponse response)
                                              throws java.lang.Exception
Description copied from interface: CommitActionAware
The dispatch method that is triggered when a user wishes to commit.

Specified by:
commit in interface CommitActionAware
Parameters:
mapping - the ActionMapping
form - the ActionForm
request - the HttpServletRequest
response - the HttpServletResponse
Returns:
the ActionForward
Throws:
java.lang.Exception - when an error occurs.


Copyright © 2003 Alexander Bibighaus et al. All Rights Reserved.