org.scrashmeow.ojb.console.framework.dispatch
Interface CancelActionAware

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

CommitActionAware

All Known Implementing Classes:

CommittingFormAction, ObjectEditorAction, ObjectSearchAction, RepositoryEditorAction

public interface CancelActionAware

extends java.io.Serializable

Defines the dipatch method for cancelling an activity.

Author:

Alexander Bibighaus

Field Summary

static java.lang.String	CANCEL_KEY The key used to trigger the cancel method
static java.lang.String	CANCEL_METHOD The method name for the cancel dispatch

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	getCancelForward(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, HttpServletRequest request) Returns the forward for the cancel dispatch

Field Detail

CANCEL_METHOD

public static final java.lang.String CANCEL_METHOD

The method name for the cancel dispatch

See Also:

Constant Field Values

CANCEL_KEY

public static final java.lang.String CANCEL_KEY

The key used to trigger the cancel method

See Also:

Constant Field Values

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.

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

Parameters:

mapping - the ActionMapping

form - the ActionForm

request - the HttpServletRequest

Returns:

the ActionForward

Throws:

java.lang.Exception - when an error occurs.