org.jaffa.components.finder
Class FinderAction

java.lang.Object
  org.apache.struts.action.Action
      org.jaffa.presentation.portlet.ActionBase
          org.jaffa.components.finder.FinderAction

Direct Known Subclasses:

LookupAction

public class FinderAction

extends ActionBase

This is the base class for all FinderComponent Actions.

Author:

GautamJ

Field Summary

Fields inherited from class org.jaffa.presentation.portlet.ActionBase

component, form, mapping, request, response

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

FinderAction()

Method Summary

FormKey	do_Close_Clicked() Quits the component and returns the FormKey for the calling screen.
FormKey	do_ModifySearch_Clicked() Start a new search.
FormKey	do_MoreRecords_Clicked() This will increment the value of the property MaxRecords.
FormKey	do_Refresh_Clicked() Re-executes the search, using the same criteria as used before.
FormKey	do_refresh() Determines the currentFormKey This event is invoked when a user changes the settings of the UserGrid in the Results screen.
FormKey	do_Search_Clicked() Invokes the doValidate() method and then the displayResults() method on the component.

Methods inherited from class org.jaffa.presentation.portlet.ActionBase

defaultAction, determineCurrentFormKey, do_HistoryNav_Clicked, execute, executeEvent, handleNullFormKey, isTokenValid, isTokenValid, parseFormName, performTokenValidation, processContainerFormKey, resetToken, saveToken

Methods inherited from class org.apache.struts.action.Action

execute, generateToken, getDataSource, getDataSource, getLocale, getResources, getResources, getResources, getServlet, isCancelled, perform, perform, 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

FinderAction

public FinderAction()

Method Detail

do_Close_Clicked

public FormKey do_Close_Clicked()

Quits the component and returns the FormKey for the calling screen.

Returns:

The FormKey for the caling screen. A null will be returned, if no calling screen was specified.

do_Search_Clicked

public FormKey do_Search_Clicked()

Invokes the doValidate() method and then the displayResults() method on the component.

Returns:

The FormKey for the Results screen.

do_ModifySearch_Clicked

public FormKey do_ModifySearch_Clicked()

Start a new search. This invokes the displayCriteria() method on the component.

Returns:

The FormKey for the Criteria screen.

do_Refresh_Clicked

public FormKey do_Refresh_Clicked()

Re-executes the search, using the same criteria as used before. It invokes the displayResults() method on the component.

Returns:

The FormKey for the Results screen.

do_MoreRecords_Clicked

public FormKey do_MoreRecords_Clicked()

This will increment the value of the property MaxRecords. It then re-executes the search, using the same criteria as used before.

Returns:

The FormKey for the Results screen.

do_refresh

public FormKey do_refresh()

Determines the currentFormKey This event is invoked when a user changes the settings of the UserGrid in the Results screen.

Overrides:

do_refresh in class ActionBase

Returns:

The FormKey for the Results screen.