com.hybris.cockpitng.search.data

Interface SearchQueryData

All Superinterfaces:

IdentifiableSearchQuery

All Known Implementing Classes:

AdvancedSearchQueryData, SimpleSearchQueryData

public interface SearchQueryData
extends IdentifiableSearchQuery

Represents the search data that is used by search logic controller to build query.

Method Summary

Modifier and Type	Method and Description
Set<SearchAttributeDescriptor>	getAttributes() Returns set of current search attributes - SearchAttributeDescriptor
Object	getAttributeValue(SearchAttributeDescriptor attribute) Returns value for a given attribute i.e.
default List<? extends SearchQueryCondition>	getConditions()
ValueComparisonOperator	getGlobalComparisonOperator() Returns global operator i.e.
int	getPageSize() Returns current page size
default String	getSearchQueryText()
String	getSearchType() Returns current search type
default Map<String,Set<String>>	getSelectedFacets() Returns selected facets.
SortData	getSortData() Returns sort information
ValueComparisonOperator	getValueComparisonOperator(SearchAttributeDescriptor attribute) Returns search operator for given attribute i.e.
boolean	isIncludeSubtypes() Whether subtypes should be taken into account in search resulsts
boolean	isTokenizable()
void	setSortData(SortData sortData) Sets given sort data information

Methods inherited from interface com.hybris.cockpitng.search.data.IdentifiableSearchQuery

getQueryId

Method Detail

getAttributes

Set<SearchAttributeDescriptor> getAttributes()

Returns set of current search attributes - SearchAttributeDescriptor

Returns:

current search attributes

getSearchType

String getSearchType()

Returns current search type

Returns:

search type

isIncludeSubtypes

boolean isIncludeSubtypes()

Whether subtypes should be taken into account in search resulsts

Returns:

if true all subtypes should be taken into accoutn in search results

getPageSize

int getPageSize()

Returns current page size

Returns:

current page size

getSortData

SortData getSortData()

Returns sort information

Returns:

sort information

setSortData

void setSortData(SortData sortData)

Sets given sort data information

Parameters:

sortData - sort data information

getValueComparisonOperator

ValueComparisonOperator getValueComparisonOperator(SearchAttributeDescriptor attribute)

Returns search operator for given attribute i.e. SearchAttributeDescriptor

Parameters:

attribute - given search attribute

Returns:

appropriate search operator

getAttributeValue

Object getAttributeValue(SearchAttributeDescriptor attribute)

Returns value for a given attribute i.e. SearchAttributeDescriptor

Parameters:

attribute - given search attribute

Returns:

appropriate search operator

getGlobalComparisonOperator

ValueComparisonOperator getGlobalComparisonOperator()

Returns global operator i.e. how conditions are connected are ther OR-ed or AND-ed

Returns:

global operator

isTokenizable

boolean isTokenizable()

Returns:

whether condition value should be tokenized based on special characters and converted to multiple conditions

getConditions

default List<? extends SearchQueryCondition> getConditions()

Returns:

condition collection

getSearchQueryText

default String getSearchQueryText()

Returns:

simple search user query

getSelectedFacets

default Map<String,Set<String>> getSelectedFacets()

Returns selected facets.

Returns:

map of facets names with selected values.