de.hybris.platform.cscockpit.widgets.controllers.search

Interface SearchCommandController<SC extends CsSearchCommand>

All Superinterfaces:

FacetedPageableSearchResults, PageableSearchResults, WidgetController

All Known Implementing Classes:

DefaultSearchCommandController

public interface SearchCommandController<SC extends CsSearchCommand>
extends FacetedPageableSearchResults

Search command controller interface can execute a search command and expose the results.

Method Summary

Modifier and Type	Method and Description
java.util.List<CatalogModel>	getAvailableCatalogs() Get the list of available catalogs.
SC	getDefaultSearchCommand() Get the optional default search command.
SC	getSearchCommand() Get the last executed search command.
void	search(SC searchCommand) Execute the search command.

Methods inherited from interface de.hybris.platform.cscockpit.widgets.controllers.search.FacetedPageableSearchResults

addFacetValue, getAppliedFacets, getAvailableFacets, removeFacetValue

Methods inherited from interface de.hybris.platform.cscockpit.widgets.controllers.search.PageableSearchResults

getAvailableSorts, getCurrentPageNumber, getCurrentPageResults, getCurrentSortOrder, getPageSize, getTotalPages, getTotalResultCount, setCurrentPageNumber, setCurrentSortOrder

Methods inherited from interface de.hybris.platform.cockpit.widgets.controllers.WidgetController

addCockpitEventAcceptor, dispatchEvent, removeCockpitEventAcceptor, setCockpitEventAcceptors

Method Detail

getSearchCommand

SC getSearchCommand()

Get the last executed search command. This will be null until the first search has been executed, then it will represent the search command for the results.

Returns:

The last executed search command.

getDefaultSearchCommand

SC getDefaultSearchCommand()

Get the optional default search command. This is optionally configured default command. This is used to pre-configure the user interface and if required, to run an initial query to populate the results.

Returns:

The default search command.

search

void search(SC searchCommand)
     throws SearchException

Execute the search command.

Parameters:

searchCommand - The search command

Throws:

SearchException - Exception thrown on error

getAvailableCatalogs

java.util.List<CatalogModel> getAvailableCatalogs()

Get the list of available catalogs. May return null if multiple catalogs are not supported.

Returns:

the list of available catalogs or null if multiple catalogs are not supported