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

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

CommitActionAware

All Known Implementing Classes:

CommittingFormAction, RepositoryEditorAction, ViewerAction

public interface ViewerActionAware

extends java.io.Serializable

Defines the dispatch interface for an an action that displays information. This action is the simplest kind of dispatch actioin.

Author:

Alexander Bibighaus

Field Summary

static java.lang.String	DISPLAY_KEY The key used to trigger the view method
static java.lang.String	DISPLAY_METHOD The method name for the display dispatch

Method Summary

org.apache.struts.action.ActionForward	display(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 display the data, typically the default dispatch action behavior.
org.apache.struts.action.ActionForward	getDisplayForward(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, HttpServletRequest request) Returns the forward for the display dispatch

Field Detail

DISPLAY_METHOD

public static final java.lang.String DISPLAY_METHOD

The method name for the display dispatch

See Also:

Constant Field Values

DISPLAY_KEY

public static final java.lang.String DISPLAY_KEY

The key used to trigger the view method

See Also:

Constant Field Values

Method Detail

display

public org.apache.struts.action.ActionForward display(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 display the data, typically the default dispatch action behavior.

Parameters:

mapping - the ActionMapping

form - the ActionForm

request - the HttpServletRequest

response - the HttpServletResponse

Returns:

the ActionForward

Throws:

java.lang.Exception - when an error occurs.

getDisplayForward

public org.apache.struts.action.ActionForward getDisplayForward(org.apache.struts.action.ActionMapping mapping,
                                                                org.apache.struts.action.ActionForm form,
                                                                HttpServletRequest request)
                                                         throws java.lang.Exception

Returns the forward for the display dispatch

Parameters:

mapping - the ActionMapping

form - the ActionForm

request - the HttpServletRequest

Returns:

the ActionForward

Throws:

java.lang.Exception - when an error occurs.