| Method Summary |
|
| protected void | addSortCriteria(FinderInDto inputDto)
Interprets the value of the 'sortDropDown' property adding suitable values to the input Dto. |
| public FormKey | display()
If the displayResultsScreen property has not been set or has been set to false, it will return the FormKey for the Criteria screen.
If the displayResultsScreen property has been set to true, then a Search will be performed & the FormKey for the Results screen will be returned.
throws:
ApplicationExceptions - This will be thrown in case any invalid data has been set.
throws:
FrameworkException - Indicates some system error. |
| public FormKey | displayCriteria()
Invoked the initializeCriteriaScreen() method and then returns the FormKey for the Criteria screen.
throws:
ApplicationExceptions - This will be thrown in case any invalid data has been set.
throws:
FrameworkException - Indicates some system error. |
| public FormKey | displayResults()
Invokes the performInquiry() method and then returns the FormKey for the Results screen.
If the consolidatedCriteriaAndResults property has been set to true, then the FormKey for consolidatedCriteriaAndResults screen will be returned.
throws:
ApplicationExceptions - This will be thrown in case any invalid data has been set.
throws:
FrameworkException - Indicates some system error. |
| abstract protected FinderOutDto | doInquiry()
The Component should provide an implementation for this method to perform the actual query to obtain the FinderOutDto.
throws:
ApplicationExceptions - This will be thrown in case any invalid data has been set.
throws:
FrameworkException - Indicates some system error. |
| public Boolean | getConsolidatedCriteriaAndResults()
Getter for property consolidatedCriteriaAndResults. |
| abstract protected String | getConsolidatedCriteriaAndResultsFormName()
The Component should provide an implementation for this method to return the Struts GlobalForward for the ConsolidatedCriteriaAndResults screen. |
| public FormKey | getCriteriaFormKey()
Getter for the Criteria screen's FormKey. |
| abstract protected String | getCriteriaFormName()
The Component should provide an implementation for this method to return the Struts GlobalForward for the Criteria screen. |
| public Boolean | getDisplayResultsScreen()
Getter for property displayResultsScreen. |
| abstract protected String | getExcelFormName()
The Component should provide an implementation for this method to return the Struts GlobalForward for the screen displaying the results as an Excel spreadsheet. |
| public String | getExportType()
Getter for property exportType. |
| public FinderOutDto | getFinderOutDto()
Getter for property finderOutDto. |
| protected HeaderDto | getHeaderDto()
Returns the HeaderDto. |
| public Integer | getMaxRecords()
Getter for property maxRecords. |
| public FormKey | getResultsFormKey()
Getter for the Results screen's FormKey. |
| abstract protected String | getResultsFormName()
The Component should provide an implementation for this method to return the Struts GlobalForward for the Results screen. |
| public String | getSortDropDown()
Getter for property sortDropDown. |
| abstract protected String | getXmlFormName()
The Component should provide an implementation for this method to return the Struts GlobalForward for the screen displaying the results in XML format. |
| public void | incrementMaxRecords()
This will set the property 'maxRecords' to the value following the current one, in the list of values returned by CriteriaDropDownOptions.getMaxRecordsDropDownOptions(). |
| protected void | initializeCriteriaScreen()
The Component should override this method to retrieve the set of codes for dropdowns in criteria screen, if any are required. |
| public void | performInquiry()
Invokes the doInquiry() method and then removes the "rows" GridModel object from the cache. |
| public void | setConsolidatedCriteriaAndResults(Boolean consolidatedCriteriaAndResults)
Setter for property consolidatedCriteriaAndResults. |
| public void | setDisplayResultsScreen(Boolean displayResultsScreen)
Setter for property displayResultsScreen. |
| public void | setExportType(String exportType)
Setter for property exportType. |
| public void | setMaxRecords(Integer maxRecords)
Setter for property maxRecords. |
| public void | setSortDropDown(String sortDropDown)
Setter for property sortDropDown. |
| protected void | uncacheRowsModel()
Removes the 'rows' GridModel from the WidgetCache. |
| protected void | updateMaxRecordsModel()
Update the DropDownModel for the MaxRecords field, if one already exists. |
