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

All Known Implementing Classes:

BrowseAction, RepositoryEditorAction

public interface BrowseActionAware

Defines the dipatch methods for displaying a browseable grid of data.

Author:

Alexander Bibighaus

Method Summary

org.apache.struts.action.ActionForward	browse(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, HttpServletRequest request, HttpServletResponse response) The dispatch method to display the data that the user is browsing.
org.apache.struts.action.ActionForward	getBrowseForward(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, HttpServletRequest request) Returns the forward for the browse dispatch
org.apache.struts.action.ActionForward	go(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 go to a specific page of data.
org.apache.struts.action.ActionForward	next(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 move to the next page of data.
org.apache.struts.action.ActionForward	previous(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 move to the previous page of data.
org.apache.struts.action.ActionForward	sizeWindow(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 needs to change the window/page size of data.
org.apache.struts.action.ActionForward	sort(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 sort the data.

Method Detail

browse

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

The dispatch method to display the data that the user is browsing.

Parameters:

mapping - the ActionMapping

form - the ActionForm

request - the HttpServletRequest

response - the HttpServletResponse

Returns:

the ActionForward

Throws:

java.lang.Exception - when an error occurs.

sizeWindow

public org.apache.struts.action.ActionForward sizeWindow(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 needs to change the window/page size of data.

Parameters:

mapping - the ActionMapping

form - the ActionForm

request - the HttpServletRequest

response - the HttpServletResponse

Returns:

the ActionForward

Throws:

java.lang.Exception - when an error occurs.

next

public org.apache.struts.action.ActionForward next(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 move to the next page of data.

Parameters:

mapping - the ActionMapping

form - the ActionForm

request - the HttpServletRequest

response - the HttpServletResponse

Returns:

the ActionForward

Throws:

java.lang.Exception - when an error occurs.

previous

public org.apache.struts.action.ActionForward previous(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 move to the previous page of data.

Parameters:

mapping - the ActionMapping

form - the ActionForm

request - the HttpServletRequest

response - the HttpServletResponse

Returns:

the ActionForward

Throws:

java.lang.Exception - when an error occurs.

go

public org.apache.struts.action.ActionForward go(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 go to a specific page of data.

Parameters:

mapping - the ActionMapping

form - the ActionForm

request - the HttpServletRequest

response - the HttpServletResponse

Returns:

the ActionForward

Throws:

java.lang.Exception - when an error occurs.

sort

public org.apache.struts.action.ActionForward sort(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 sort the data.

Parameters:

mapping - the ActionMapping

form - the ActionForm

request - the HttpServletRequest

response - the HttpServletResponse

Returns:

the ActionForward

Throws:

java.lang.Exception - when an error occurs.

getBrowseForward

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

Returns the forward for the browse dispatch

Parameters:

mapping - the ActionMapping

form - the ActionForm

request - the HttpServletRequest

Returns:

the ActionForward

Throws:

java.lang.Exception - when an error occurs.