Class Query
java.lang.Object
de.hybris.platform.cockpit.model.search.Query
- All Implemented Interfaces:
Cloneable
-
Constructor Summary
ConstructorsConstructorDescriptionQuery(Collection<SearchType> types, String simpleText, int start, int count) -
Method Summary
Modifier and TypeMethodDescriptionvoidaddParameterOrValues(List<SearchParameterValue> orValues) voidvoidaddSelectedFacetValue(FacetValue value) voidaddSortCriterion(PropertyDescriptor sortProperty, boolean asc) voidClears the excluded items.voidvoidclone()intgetCount()Returns the items which should be excluded when searching.intgetStart()booleanbooleanbooleanisOrMode()Tells whether all search parameters are OR-connected or AND-connected.booleanvoidvoidvoidremoveSortCriterion(PropertyDescriptor sortProperty) voidsetContextParameter(String key, Object value) voidsetCount(int count) voidsetExcludedItems(Collection<TypedObject> excludedItems) Sets the items to be excluded when searching.voidsetExcludeSubTypes(boolean excludeSubTypes) voidsetNeedTotalCount(boolean needTotalCount) voidsetOrMode(boolean orMode) Defines whether all search parameters should be OR-connected or AND-connected.voidsetParameterOrValues(List<List<SearchParameterValue>> orValues) voidsetParameterValues(List<SearchParameterValue> parameterValues) voidsetSelectedFacetValues(Collection<FacetValue> selectedFacetValues) voidsetSelectedTypes(Collection<SearchType> types) voidsetSimpleSearch(boolean simpleSearch) voidsetSimpleText(String simpleText) voidsetSortCriteria(Map<PropertyDescriptor, Boolean> criteria) voidsetStart(int start)
-
Constructor Details
-
Query
-
-
Method Details
-
setSelectedTypes
-
getStart
public int getStart() -
getCount
public int getCount() -
getSimpleText
-
setStart
public void setStart(int start) - Parameters:
start- the start to set
-
setCount
public void setCount(int count) - Parameters:
count- the count to set
-
setExcludedItems
Sets the items to be excluded when searching.- Parameters:
excludedItems- the items to exclude- See Also:
-
getExcludedItems
Returns the items which should be excluded when searching.- Returns:
- the excluded items
- See Also:
-
clearExcludedItems
public void clearExcludedItems()Clears the excluded items. -
setSimpleText
-
getSelectedFacetValues
-
setSelectedFacetValues
-
addSelectedFacetValue
-
removeSelectedFacetValue
-
getParameterValues
-
getParameterOrValues
-
setParameterValues
-
addParameterValue
-
addParameterOrValues
-
setParameterOrValues
-
clearParameterValues
public void clearParameterValues() -
clearParameterOrValues
public void clearParameterOrValues() -
removeParameterValue
-
getSortCriteria
-
setSortCriteria
-
addSortCriterion
-
removeSortCriterion
-
isOrMode
public boolean isOrMode()Tells whether all search parameters are OR-connected or AND-connected. -
setOrMode
public void setOrMode(boolean orMode) Defines whether all search parameters should be OR-connected or AND-connected.- Parameters:
orMode- iftrueparameter are OR-connected, otherwise they're AND-connected
-
getSelectedTypes
-
getContextParameter
-
setContextParameter
-
clone
- Overrides:
clonein classObject- Throws:
CloneNotSupportedException
-
isExcludeSubTypes
public boolean isExcludeSubTypes() -
setExcludeSubTypes
public void setExcludeSubTypes(boolean excludeSubTypes) -
isNeedTotalCount
public boolean isNeedTotalCount() -
setNeedTotalCount
public void setNeedTotalCount(boolean needTotalCount) -
setSimpleSearch
public void setSimpleSearch(boolean simpleSearch) -
isSimpleSearch
public boolean isSimpleSearch()- Returns:
- the simpleSearch
-