Class Query
- java.lang.Object
-
- de.hybris.platform.cockpit.model.search.Query
-
- All Implemented Interfaces:
java.lang.Cloneable
public class Query extends java.lang.Object implements java.lang.Cloneable
-
-
Constructor Summary
Constructors Constructor Description Query(java.util.Collection<SearchType> types, java.lang.String simpleText, int start, int count)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddParameterOrValues(java.util.List<SearchParameterValue> orValues)voidaddParameterValue(SearchParameterValue value)voidaddSelectedFacetValue(FacetValue value)voidaddSortCriterion(PropertyDescriptor sortProperty, boolean asc)voidclearExcludedItems()Clears the excluded items.voidclearParameterOrValues()voidclearParameterValues()java.lang.Objectclone()java.lang.ObjectgetContextParameter(java.lang.String key)intgetCount()java.util.Collection<TypedObject>getExcludedItems()Returns the items which should be excluded when searching.java.util.List<java.util.List<SearchParameterValue>>getParameterOrValues()java.util.List<SearchParameterValue>getParameterValues()java.util.Set<FacetValue>getSelectedFacetValues()java.util.Set<SearchType>getSelectedTypes()java.lang.StringgetSimpleText()java.util.Map<PropertyDescriptor,java.lang.Boolean>getSortCriteria()intgetStart()booleanisExcludeSubTypes()booleanisNeedTotalCount()booleanisOrMode()Tells whether all search parameters are OR-connected or AND-connected.booleanisSimpleSearch()voidremoveParameterValue(SearchParameterValue value)voidremoveSelectedFacetValue(FacetValue value)voidremoveSortCriterion(PropertyDescriptor sortProperty)voidsetContextParameter(java.lang.String key, java.lang.Object value)voidsetCount(int count)voidsetExcludedItems(java.util.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(java.util.List<java.util.List<SearchParameterValue>> orValues)voidsetParameterValues(java.util.List<SearchParameterValue> parameterValues)voidsetSelectedFacetValues(java.util.Collection<FacetValue> selectedFacetValues)voidsetSelectedTypes(java.util.Collection<SearchType> types)voidsetSimpleSearch(boolean simpleSearch)voidsetSimpleText(java.lang.String simpleText)voidsetSortCriteria(java.util.Map<PropertyDescriptor,java.lang.Boolean> criteria)voidsetStart(int start)
-
-
-
Constructor Detail
-
Query
public Query(java.util.Collection<SearchType> types, java.lang.String simpleText, int start, int count)
-
-
Method Detail
-
setSelectedTypes
public void setSelectedTypes(java.util.Collection<SearchType> types)
-
getStart
public int getStart()
-
getCount
public int getCount()
-
getSimpleText
public java.lang.String 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
public void setExcludedItems(java.util.Collection<TypedObject> excludedItems)
Sets the items to be excluded when searching.- Parameters:
excludedItems- the items to exclude- See Also:
getExcludedItems(),clearExcludedItems()
-
getExcludedItems
public java.util.Collection<TypedObject> getExcludedItems()
Returns the items which should be excluded when searching.- Returns:
- the excluded items
- See Also:
setExcludedItems(Collection),clearExcludedItems()
-
clearExcludedItems
public void clearExcludedItems()
Clears the excluded items.- See Also:
setExcludedItems(Collection),getExcludedItems()
-
setSimpleText
public void setSimpleText(java.lang.String simpleText)
-
getSelectedFacetValues
public java.util.Set<FacetValue> getSelectedFacetValues()
-
setSelectedFacetValues
public void setSelectedFacetValues(java.util.Collection<FacetValue> selectedFacetValues)
-
addSelectedFacetValue
public void addSelectedFacetValue(FacetValue value)
-
removeSelectedFacetValue
public void removeSelectedFacetValue(FacetValue value)
-
getParameterValues
public java.util.List<SearchParameterValue> getParameterValues()
-
getParameterOrValues
public java.util.List<java.util.List<SearchParameterValue>> getParameterOrValues()
-
setParameterValues
public void setParameterValues(java.util.List<SearchParameterValue> parameterValues)
-
addParameterValue
public void addParameterValue(SearchParameterValue value)
-
addParameterOrValues
public void addParameterOrValues(java.util.List<SearchParameterValue> orValues)
-
setParameterOrValues
public void setParameterOrValues(java.util.List<java.util.List<SearchParameterValue>> orValues)
-
clearParameterValues
public void clearParameterValues()
-
clearParameterOrValues
public void clearParameterOrValues()
-
removeParameterValue
public void removeParameterValue(SearchParameterValue value)
-
getSortCriteria
public java.util.Map<PropertyDescriptor,java.lang.Boolean> getSortCriteria()
-
setSortCriteria
public void setSortCriteria(java.util.Map<PropertyDescriptor,java.lang.Boolean> criteria)
-
addSortCriterion
public void addSortCriterion(PropertyDescriptor sortProperty, boolean asc)
-
removeSortCriterion
public void removeSortCriterion(PropertyDescriptor sortProperty)
-
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
public java.util.Set<SearchType> getSelectedTypes()
-
getContextParameter
public java.lang.Object getContextParameter(java.lang.String key)
-
setContextParameter
public void setContextParameter(java.lang.String key, java.lang.Object value)
-
clone
public java.lang.Object clone() throws java.lang.CloneNotSupportedException- Overrides:
clonein classjava.lang.Object- Throws:
java.lang.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
-
-