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

Class DefaultSearchCommandController<SC extends CsSearchCommand>

java.lang.Object

de.hybris.platform.cockpit.widgets.controllers.impl.AbstractWidgetController

de.hybris.platform.cscockpit.widgets.controllers.impl.AbstractCsWidgetController

de.hybris.platform.cscockpit.widgets.controllers.impl.AbstractCallContextDependantController

de.hybris.platform.cscockpit.widgets.controllers.search.impl.DefaultSearchCommandController<SC>

All Implemented Interfaces:

WidgetController, FacetedPageableSearchResults, PageableSearchResults, SearchCommandController<SC>

public class DefaultSearchCommandController<SC extends CsSearchCommand>
extends AbstractCallContextDependantController
implements SearchCommandController<SC>

The default implementation of the SearchCommandController interface.

Field Summary

Fields inherited from class de.hybris.platform.cscockpit.widgets.controllers.impl.AbstractCsWidgetController

CONTROLLER_CONTEXT

Constructor Summary

Constructors

Constructor and Description
DefaultSearchCommandController()

Method Summary

Modifier and Type	Method and Description
boolean	addFacetValue(CsSearchFacetValue facetValue) Add the specified facet value to the search filter and execute the search again.
protected DataObject<TypedObject>	convertResultItem(TypeService typeService, DataObject<? extends ItemModel> metaTuple)
void	dispatchEvent(java.lang.String context, java.lang.Object source, java.util.Map<java.lang.String,java.lang.Object> data) Notifies all event acceptors which are registered for events with the context code context.
protected void	doSearch()
protected void	doSearchInternal() Runs the search using the current search command.
java.util.Set<CsSearchFacetValue>	getAppliedFacets() Get the currently applied facet values.
java.util.List<CatalogModel>	getAvailableCatalogs() Get the list of available catalogs.
protected java.util.List<CatalogModel>	getAvailableCatalogsInternal()
java.util.Set<CsSearchFacet>	getAvailableFacets() Get the available facets that can be applied to the results.
java.util.List<CsSort>	getAvailableSorts() Get the available sorts that can be applied to the results.
BaseSiteService	getBaseSiteService()
int	getCurrentPageNumber() Get the current page number.
java.util.List<DataObject<TypedObject>>	getCurrentPageResults() Get the current page of results.
CsSort	getCurrentSortOrder() Get the currently applied sort order.
SC	getDefaultSearchCommand() Get the optional default search command.
DefaultPageable	getPageable()
int	getPageSize() Get the page size or the number of results to return in each page.
SC	getSearchCommand() Get the last executed search command.
protected CsSearchResult<SC,? extends ItemModel>	getSearchResult()
protected CsSearchService<SC,? extends ItemModel>	getSearchService()
int	getTotalPages() Get the total number of pages required to display the results of the search.
long	getTotalResultCount() Get the total number of results that match the search.
protected void	handleCallContextControllerEvent(CallContextEvent event) Called when an event is received from the call context controller.
protected boolean	isImpersonateCustomer()
boolean	removeFacetValue(CsSearchFacetValue facetValue) Remove the applied facet value from the search filter and execute teh search again.
protected void	reset()
void	search(SC searchCommand) Execute the search command.
void	setBaseSiteService(BaseSiteService baseSiteService)
boolean	setCurrentPageNumber(int page) Change the current page to the specified page number.
boolean	setCurrentSortOrder(CsSort sort) Change the current sort to the specified sort.
void	setDefaultSearchCommand(SC defaultSearchCommand)
void	setImpersonateCustomer(boolean impersonateCustomer)
void	setSearchService(CsSearchService<SC,? extends ItemModel> searchService)

Methods inherited from class de.hybris.platform.cscockpit.widgets.controllers.impl.AbstractCallContextDependantController

bindToCallContextController, getCallContextController, setCallContextController

Methods inherited from class de.hybris.platform.cscockpit.widgets.controllers.impl.AbstractCsWidgetController

getCockpitTypeService, getModelService, setCockpitTypeService, setModelService

Methods inherited from class de.hybris.platform.cockpit.widgets.controllers.impl.AbstractWidgetController

addCockpitEventAcceptor, dispatchEvent, getAcceptors, removeCockpitEventAcceptor, setCockpitEventAcceptors

Methods inherited from class java.lang.Object

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

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

addCockpitEventAcceptor, removeCockpitEventAcceptor, setCockpitEventAcceptors

Constructor Detail

DefaultSearchCommandController

public DefaultSearchCommandController()

Method Detail

getSearchService

protected CsSearchService<SC,? extends ItemModel> getSearchService()

setSearchService

public void setSearchService(CsSearchService<SC,? extends ItemModel> searchService)

getSearchCommand

public SC getSearchCommand()

Description copied from interface: SearchCommandController

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.

Specified by:

getSearchCommand in interface SearchCommandController<SC extends CsSearchCommand>

Returns:

The last executed search command.

getDefaultSearchCommand

public SC getDefaultSearchCommand()

Description copied from interface: SearchCommandController

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.

Specified by:

getDefaultSearchCommand in interface SearchCommandController<SC extends CsSearchCommand>

Returns:

The default search command.

setDefaultSearchCommand

public void setDefaultSearchCommand(SC defaultSearchCommand)

getPageable

public DefaultPageable getPageable()

getSearchResult

protected CsSearchResult<SC,? extends ItemModel> getSearchResult()

isImpersonateCustomer

protected boolean isImpersonateCustomer()

setImpersonateCustomer

public void setImpersonateCustomer(boolean impersonateCustomer)

getBaseSiteService

public BaseSiteService getBaseSiteService()

setBaseSiteService

public void setBaseSiteService(BaseSiteService baseSiteService)

dispatchEvent

public void dispatchEvent(java.lang.String context,
                          java.lang.Object source,
                          java.util.Map<java.lang.String,java.lang.Object> data)

Description copied from interface: WidgetController

Notifies all event acceptors which are registered for events with the context code context.

Specified by:

dispatchEvent in interface WidgetController

Specified by:

dispatchEvent in class AbstractWidgetController

Parameters:

context - event context

source - event source

data - parameters to be be passed to registered listeners

handleCallContextControllerEvent

protected void handleCallContextControllerEvent(CallContextEvent event)

Description copied from class: AbstractCallContextDependantController

Called when an event is received from the call context controller. The default behaviour is to dispatch an event on this controller instance. This method can be overridden in a subclass to implement specific behaviour.

Overrides:

handleCallContextControllerEvent in class AbstractCallContextDependantController

Parameters:

event - the event

doSearch

protected void doSearch()
                 throws SearchException

Throws:

SearchException

doSearchInternal

protected void doSearchInternal()
                         throws SearchException

Runs the search using the current search command. Called either in the context of the CS Agent or in the context of the Customer depending on the isImpersonateCustomer() setting. The implementation delegates to the search service. Subclasses can override this implementation to use another search implementation.

Throws:

SearchException - Thrown if a search exception occurs

search

public void search(SC searchCommand)
            throws SearchException

Description copied from interface: SearchCommandController

Execute the search command.

Specified by:

search in interface SearchCommandController<SC extends CsSearchCommand>

Parameters:

searchCommand - The search command

Throws:

SearchException - Exception thrown on error

reset

protected void reset()

getAvailableCatalogs

public java.util.List<CatalogModel> getAvailableCatalogs()

Description copied from interface: SearchCommandController

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

Specified by:

getAvailableCatalogs in interface SearchCommandController<SC extends CsSearchCommand>

Returns:

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

getAvailableCatalogsInternal

protected java.util.List<CatalogModel> getAvailableCatalogsInternal()

getCurrentPageResults

public java.util.List<DataObject<TypedObject>> getCurrentPageResults()

Description copied from interface: PageableSearchResults

Get the current page of results. Only the current page is available. The results are wrapped in DataObject instances that provide access to the TypedObject item as well as the meta data for the item.

Specified by:

getCurrentPageResults in interface PageableSearchResults

Returns:

the list of results for the current page.

convertResultItem

protected DataObject<TypedObject> convertResultItem(TypeService typeService,
                                                    DataObject<? extends ItemModel> metaTuple)

getCurrentPageNumber

public int getCurrentPageNumber()

Description copied from interface: PageableSearchResults

Get the current page number. The first page is page number zero.

Specified by:

getCurrentPageNumber in interface PageableSearchResults

Returns:

the current page number, zero for the first page.

setCurrentPageNumber

public boolean setCurrentPageNumber(int page)
                             throws SearchException

Description copied from interface: PageableSearchResults

Change the current page to the specified page number. The first page is page number zero. Changing the page will cause the search to be executed again to retrieve the required page. Once this call is complete the results can be retrieved by calling the PageableSearchResults.getCurrentPageResults() method.

Specified by:

setCurrentPageNumber in interface PageableSearchResults

Parameters:

page - the page number, zero for the first page.

Returns:

true if the page has been changed

Throws:

SearchException - thrown if the search failed

getTotalResultCount

public long getTotalResultCount()

Description copied from interface: PageableSearchResults

Get the total number of results that match the search. This is the number of matches across all pages.

Specified by:

getTotalResultCount in interface PageableSearchResults

Returns:

the total number of results

getTotalPages

public int getTotalPages()

Description copied from interface: PageableSearchResults

Get the total number of pages required to display the results of the search.

Specified by:

getTotalPages in interface PageableSearchResults

Returns:

the total number of results

See Also:

PageableSearchResults.getTotalResultCount(), PageableSearchResults.getPageSize()

getPageSize

public int getPageSize()

Description copied from interface: PageableSearchResults

Get the page size or the number of results to return in each page.

Specified by:

getPageSize in interface PageableSearchResults

Returns:

the page size

getCurrentSortOrder

public CsSort getCurrentSortOrder()

Description copied from interface: PageableSearchResults

Get the currently applied sort order.

Specified by:

getCurrentSortOrder in interface PageableSearchResults

Returns:

the sort order

setCurrentSortOrder

public boolean setCurrentSortOrder(CsSort sort)
                            throws SearchException

Description copied from interface: PageableSearchResults

Change the current sort to the specified sort. Changing the sort will cause the search to be executed again to re-order the results. Once this call is complete the results can be retrieved by calling the PageableSearchResults.getCurrentPageResults() method.

Specified by:

setCurrentSortOrder in interface PageableSearchResults

Parameters:

sort - the new sort

Returns:

true if the sort has been changed

Throws:

SearchException - thrown if the search failed

getAvailableSorts

public java.util.List<CsSort> getAvailableSorts()

Description copied from interface: PageableSearchResults

Get the available sorts that can be applied to the results.

Specified by:

getAvailableSorts in interface PageableSearchResults

Returns:

the list of available sorts

getAppliedFacets

public java.util.Set<CsSearchFacetValue> getAppliedFacets()

Description copied from interface: FacetedPageableSearchResults

Get the currently applied facet values. These are the facet values that were used to filter the current results.

Specified by:

getAppliedFacets in interface FacetedPageableSearchResults

Returns:

the set of applied facet values.

getAvailableFacets

public java.util.Set<CsSearchFacet> getAvailableFacets()

Description copied from interface: FacetedPageableSearchResults

Get the available facets that can be applied to the results.

Specified by:

getAvailableFacets in interface FacetedPageableSearchResults

Returns:

the set of available facets

addFacetValue

public boolean addFacetValue(CsSearchFacetValue facetValue)
                      throws SearchException

Description copied from interface: FacetedPageableSearchResults

Add the specified facet value to the search filter and execute the search again. Changing the facet filters will cause the search to the executed again. Once this call is complete the results can be retrieved by calling the PageableSearchResults.getCurrentPageResults() method.

Specified by:

addFacetValue in interface FacetedPageableSearchResults

Parameters:

facetValue - the facet value to add to the search filters

Returns:

true if the facet has been added

Throws:

SearchException - thrown if the search failed

removeFacetValue

public boolean removeFacetValue(CsSearchFacetValue facetValue)
                         throws SearchException

Description copied from interface: FacetedPageableSearchResults

Remove the applied facet value from the search filter and execute teh search again. Changing the facet filters will cause the search to the executed again. Once this call is complete the results can be retrieved by calling the PageableSearchResults.getCurrentPageResults() method.

Specified by:

removeFacetValue in interface FacetedPageableSearchResults

Parameters:

facetValue - the facet value to remove

Returns:

true if the facet has been removed

Throws:

SearchException - thrown if the search failed