org.jaffa.components.finder
Class FinderComponent

java.lang.Object
  org.jaffa.presentation.portlet.component.Component
      org.jaffa.components.finder.FinderComponent

All Implemented Interfaces:

IComponent

Direct Known Subclasses:

LookupComponent

Deprecated. This class is required by the object_finder_1_0 pattern. The object_finder_2_0 pattern has made this class redundant.

public abstract class FinderComponent

extends Component

This is the base class for all Finder components. It has the following properties - 1- displayResultsScreen : If set to true, then the Results screen will directly brought up, bypassing the Criteria screen. 2- sortDropDown : The sort criteria to use for the inquiry 3- exportType : The export option to use for the inquiry (initialized to regular Web Pages) 4- maxRecords: The maximum number of records to retrieve. All records will be retrieved, if no value is specified. 5- finderListener : The Listener object, which will refresh the Results screen, on a new inquiry 6- headerDto : This is a convenience property to pass to Tx, where required

Author:

GautamJ

Field Summary

static String	ATTRIBUTE_EXPORT_TYPE_XML Deprecated. This request stream attribute is set by a FinderCriteriaForm, after a query, and if the exportType is XML.
static String	EXPORT_TYPE_EXCEL Deprecated. A global constant for the Excel export option.
static String	EXPORT_TYPE_WEB_PAGE Deprecated. A global constant for the Web Page export option.
static String	EXPORT_TYPE_XML Deprecated. A global constant for the XML export option.

Constructor Summary

FinderComponent()
Deprecated.

Method Summary

protected void	addSortCriteria(FinderInDto inputDto) Deprecated. Interprets the value of the 'sortDropDown' property adding suitable values to the input Dto.
Boolean	getDisplayResultsScreen() Deprecated. Getter for property displayResultsScreen.
String	getExportType() Deprecated. Getter for property exportType.
IFinderListener	getFinderListener() Deprecated. Getter for property finderListener.
protected HeaderDto	getHeaderDto() Deprecated. Returns the HeaderDto.
Integer	getMaxRecords() Deprecated. Getter for property maxRecords.
String	getSortDropDown() Deprecated. Getter for property sortDropDown.
void	incrementMaxRecords() Deprecated. This will set the property 'maxRecords' to the value following the current one, in the list of values returned by CriteriaDropDownOptions.getMaxRecordsDropDownOptions().
protected void	invokeFinderListener() Deprecated. Invokes the inquiryDone() method of the registered IFinderListener object in the same thread.
protected void	invokeFinderListener(EventObject eventObject) Deprecated. Invokes the inquiryDone() method of the registered IFinderListener object in the same thread.
void	quit() Deprecated. This clears the listener and then invokes the quit() method of the base class.
void	setDisplayResultsScreen(Boolean displayResultsScreen) Deprecated. Setter for property displayResultsScreen.
void	setExportType(String exportType) Deprecated. Setter for property exportType.
void	setFinderListener(IFinderListener finderListener) Deprecated. Setter for property finderListener.
void	setMaxRecords(Integer maxRecords) Deprecated. Setter for property maxRecords.
void	setSortDropDown(String sortDropDown) Deprecated. Setter for property sortDropDown.

Methods inherited from class org.jaffa.presentation.portlet.component.Component

addChildComponent, addFormKeyChangeListener, display, getComponentDefinition, getComponentId, getContainerFormKey, getFormKeyChangeListeners, getReturnToFormKey, getToken, getUserSession, isActive, quitAndReturnToCallingScreen, reflectAndSetParms, removeFormKeyChangeListener, returnChildComponents, returnLastActivityDate, run, setContainerFormKey, setReturnToFormKey, setToken, updateLastActivityDate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EXPORT_TYPE_WEB_PAGE

public static final String EXPORT_TYPE_WEB_PAGE

Deprecated.

A global constant for the Web Page export option.

See Also:

Constant Field Values

EXPORT_TYPE_EXCEL

public static final String EXPORT_TYPE_EXCEL

Deprecated.

A global constant for the Excel export option.

See Also:

Constant Field Values

EXPORT_TYPE_XML

public static final String EXPORT_TYPE_XML

Deprecated.

A global constant for the XML export option.

See Also:

Constant Field Values

ATTRIBUTE_EXPORT_TYPE_XML

public static final String ATTRIBUTE_EXPORT_TYPE_XML

Deprecated.

This request stream attribute is set by a FinderCriteriaForm, after a query, and if the exportType is XML. The ResultsJsp will use display the XML stored by this attribute.

See Also:

Constant Field Values

Constructor Detail

FinderComponent

public FinderComponent()

Deprecated.

Method Detail

quit

public void quit()

Deprecated.

This clears the listener and then invokes the quit() method of the base class.

Specified by:

quit in interface IComponent

Overrides:

quit in class Component

getDisplayResultsScreen

public Boolean getDisplayResultsScreen()

Deprecated.

Getter for property displayResultsScreen.

Returns:

Value of property displayResultsScreen.

setDisplayResultsScreen

public void setDisplayResultsScreen(Boolean displayResultsScreen)

Deprecated.

Setter for property displayResultsScreen.

Parameters:

displayResultsScreen - New value of property displayResultsScreen.

getSortDropDown

public String getSortDropDown()

Deprecated.

Getter for property sortDropDown.

Returns:

Value of property sortDropDown.

setSortDropDown

public void setSortDropDown(String sortDropDown)

Deprecated.

Setter for property sortDropDown.

Parameters:

sortDropDown - New value of property sortDropDown.

getExportType

public String getExportType()

Deprecated.

Getter for property exportType.

Returns:

Value of property exportType.

setExportType

public void setExportType(String exportType)

Deprecated.

Setter for property exportType.

Parameters:

exportType - New value of property exportType.

getMaxRecords

public Integer getMaxRecords()

Deprecated.

Getter for property maxRecords.

Returns:

Value of property maxRecords.

setMaxRecords

public void setMaxRecords(Integer maxRecords)

Deprecated.

Setter for property maxRecords.

Parameters:

maxRecords - New value of property maxRecords.

incrementMaxRecords

public void incrementMaxRecords()

Deprecated.

This will set the property 'maxRecords' to the value following the current one, in the list of values returned by CriteriaDropDownOptions.getMaxRecordsDropDownOptions().

getFinderListener

public IFinderListener getFinderListener()

Deprecated.

Getter for property finderListener.

Returns:

Value of property finderListener.

setFinderListener

public void setFinderListener(IFinderListener finderListener)

Deprecated.

Setter for property finderListener.

Parameters:

finderListener - New value of property finderListener.

invokeFinderListener

protected void invokeFinderListener()

Deprecated.

Invokes the inquiryDone() method of the registered IFinderListener object in the same thread.

invokeFinderListener

protected void invokeFinderListener(EventObject eventObject)

Deprecated.

Invokes the inquiryDone() method of the registered IFinderListener object in the same thread.

Parameters:

eventObject - The EventObject which will probably contain the component itself.

getHeaderDto

protected HeaderDto getHeaderDto()

Deprecated.

Returns the HeaderDto. This can be used for passing the header info to the Tx, where required.

Returns:

the HeaderDto.

addSortCriteria

protected void addSortCriteria(FinderInDto inputDto)

Deprecated.

Interprets the value of the 'sortDropDown' property adding suitable values to the input Dto.

Parameters:

inputDto - The Dto to which the orderby fields will be added.