org.tentackle.swing.rdc

Interface PdoSearch<T extends PersistentDomainObject<T>>

Type Parameters:

T - the PDO type

All Superinterfaces:

DomainContextProvider

All Known Implementing Classes:

AbstractPdoSearch, DefaultSearch

public interface PdoSearch<T extends PersistentDomainObject<T>>
extends DomainContextProvider

A PDO search.
Combines arbitrary search criteria, a panel to edit those criteria, the execution and display of the search.

Author:

harald

Method Summary

Modifier and Type	Method and Description
T	createPdo() Creates a new PDO for this search.
void	execute(Consumer<List<T>> pdoDisplay) Executes the search.
String	getFormTableName() Overrides the FormTable preferences name.
Class<T>	getPdoClass() Gets the PDO class.
int	getPdoClassId() Gets the PDO class id.
String	getSearchCriteriaAsString() Gets a short description of the search criteria.
FormPanel	getSearchPanel() Gets the panel to enter the search criteria.
boolean	isDialogNotShownIfSearchImmediateFindsSingleMatch() Dont show the dialog if exactly a single object is found. Makes only sense with isSearchImmediate().
boolean	isDialogShownIfSearchImmediateFails() Show dialog if searchImmediate fails.
boolean	isResultValid(List<T> list) Validates the result.
boolean	isSearchCriteriaValid() Performs a validation of the search criteria.
boolean	isSearchImmediate() Start search immediately without asking the user to enter the search criteria.
boolean	isSearchPanelInvisible() Search criteria panel visibility.
boolean	isSearchRetrievingAll() Returns whether the search will retrieve all PDOs. Usually, if nothing is entered, all PDOs will be retrieved.
boolean	isTableViewInitiallyShown() Initially show table-view instead of tree-view.
boolean	isViewModeFixed() Don't allow the user to change the view mode.
boolean	isViewRebuildNecessary() View should be rebuilt for each new display of search results.
void	presetSearchCriteria(T template) Presets the search parameter with default values from given PDO.
void	resetSearchCriteria() Resets the search criteria to its default.

Methods inherited from interface org.tentackle.pdo.DomainContextProvider

getDomainContext, on, op

Method Detail

execute

void execute(Consumer<List<T>> pdoDisplay)

Executes the search.

Parameters:

pdoDisplay - the display for the retrieved pdos

getPdoClassId

int getPdoClassId()

Gets the PDO class id.

Returns:

the class id

getPdoClass

Class<T> getPdoClass()

Gets the PDO class.

Returns:

the pdo class

createPdo

T createPdo()

Creates a new PDO for this search.

Returns:

the pdo

getSearchPanel

FormPanel getSearchPanel()

Gets the panel to enter the search criteria.

Returns:

the search panel

getSearchCriteriaAsString

String getSearchCriteriaAsString()

Gets a short description of the search criteria.

Returns:

the criteria description

isSearchCriteriaValid

boolean isSearchCriteriaValid()

Performs a validation of the search criteria.

Returns:

true if running the query is ok

resetSearchCriteria

void resetSearchCriteria()

Resets the search criteria to its default.

presetSearchCriteria

void presetSearchCriteria(T template)

Presets the search parameter with default values from given PDO.

Parameters:

template - the PDO to extract the search criteria from

isSearchRetrievingAll

boolean isSearchRetrievingAll()

Returns whether the search will retrieve all PDOs.
Usually, if nothing is entered, all PDOs will be retrieved.

Returns:

true if search for all, false otherwise

isResultValid

boolean isResultValid(List<T> list)

Validates the result.

Parameters:

list - the retrieved PDOs from execute()

Returns:

true if results can be displayed, false if not

isSearchImmediate

boolean isSearchImmediate()

Start search immediately without asking the user to enter the search criteria.

Returns:

true if search immediately

isSearchPanelInvisible

boolean isSearchPanelInvisible()

Search criteria panel visibility.

Returns:

true if search panel should not be visible (makes only sense with isSearchImmediate() == true)

isDialogNotShownIfSearchImmediateFindsSingleMatch

boolean isDialogNotShownIfSearchImmediateFindsSingleMatch()

Dont show the dialog if exactly a single object is found.
Makes only sense with isSearchImmediate().

Returns:

true if don't show dialog if exactly single item matches (default = false)

isDialogShownIfSearchImmediateFails

boolean isDialogShownIfSearchImmediateFails()

Show dialog if searchImmediate fails.

Returns:

true if dialog is shown even if immediate search fails (makes only sense with isSearchImmediate() == true)

isTableViewInitiallyShown

boolean isTableViewInitiallyShown()

Initially show table-view instead of tree-view.

Returns:

true if switch to table view initially

isViewModeFixed

boolean isViewModeFixed()

Don't allow the user to change the view mode.

Returns:

true if user cannot change between table and tree view

isViewRebuildNecessary

boolean isViewRebuildNecessary()

View should be rebuilt for each new display of search results.

Returns:

true if rebuild the view

getFormTableName

String getFormTableName()

Overrides the FormTable preferences name.

Returns:

the preferences name, null if default