de.hybris.platform.cockpit.model.search

Class Query

java.lang.Object

de.hybris.platform.cockpit.model.search.Query

All Implemented Interfaces:

Cloneable

public class Query
extends Object
implements Cloneable

Constructor Summary

Constructors

Constructor and Description
Query(Collection<SearchType> types, String simpleText, int start, int count)

Method Summary

Modifier and Type	Method and Description
void	addParameterOrValues(List<SearchParameterValue> orValues)
void	addParameterValue(SearchParameterValue value)
void	addSelectedFacetValue(FacetValue value)
void	addSortCriterion(PropertyDescriptor sortProperty, boolean asc)
void	clearExcludedItems() Clears the excluded items.
void	clearParameterOrValues()
void	clearParameterValues()
Object	clone()
Object	getContextParameter(String key)
int	getCount()
Collection<TypedObject>	getExcludedItems() Returns the items which should be excluded when searching.
List<List<SearchParameterValue>>	getParameterOrValues()
List<SearchParameterValue>	getParameterValues()
Set<FacetValue>	getSelectedFacetValues()
Set<SearchType>	getSelectedTypes()
String	getSimpleText()
Map<PropertyDescriptor,Boolean>	getSortCriteria()
int	getStart()
boolean	isExcludeSubTypes()
boolean	isNeedTotalCount()
boolean	isOrMode() Tells whether all search parameters are OR-connected or AND-connected.
boolean	isSimpleSearch()
void	removeParameterValue(SearchParameterValue value)
void	removeSelectedFacetValue(FacetValue value)
void	removeSortCriterion(PropertyDescriptor sortProperty)
void	setContextParameter(String key, Object value)
void	setCount(int count)
void	setExcludedItems(Collection<TypedObject> excludedItems) Sets the items to be excluded when searching.
void	setExcludeSubTypes(boolean excludeSubTypes)
void	setNeedTotalCount(boolean needTotalCount)
void	setOrMode(boolean orMode) Defines whether all search parameters should be OR-connected or AND-connected.
void	setParameterOrValues(List<List<SearchParameterValue>> orValues)
void	setParameterValues(List<SearchParameterValue> parameterValues)
void	setSelectedFacetValues(Collection<FacetValue> selectedFacetValues)
void	setSelectedTypes(Collection<SearchType> types)
void	setSimpleSearch(boolean simpleSearch)
void	setSimpleText(String simpleText)
void	setSortCriteria(Map<PropertyDescriptor,Boolean> criteria)
void	setStart(int start)

Methods inherited from class java.lang.Object

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

Constructor Detail

Query

public Query(Collection<SearchType> types,
             String simpleText,
             int start,
             int count)

Method Detail

setSelectedTypes

public void setSelectedTypes(Collection<SearchType> types)

getStart

public int getStart()

getCount

public int getCount()

getSimpleText

public 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(Collection<TypedObject> excludedItems)

Sets the items to be excluded when searching.

Parameters:

excludedItems - the items to exclude

See Also:

getExcludedItems(), clearExcludedItems()

getExcludedItems

public 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(String simpleText)

getSelectedFacetValues

public Set<FacetValue> getSelectedFacetValues()

setSelectedFacetValues

public void setSelectedFacetValues(Collection<FacetValue> selectedFacetValues)

addSelectedFacetValue

public void addSelectedFacetValue(FacetValue value)

removeSelectedFacetValue

public void removeSelectedFacetValue(FacetValue value)

getParameterValues

public List<SearchParameterValue> getParameterValues()

getParameterOrValues

public List<List<SearchParameterValue>> getParameterOrValues()

setParameterValues

public void setParameterValues(List<SearchParameterValue> parameterValues)

addParameterValue

public void addParameterValue(SearchParameterValue value)

addParameterOrValues

public void addParameterOrValues(List<SearchParameterValue> orValues)

setParameterOrValues

public void setParameterOrValues(List<List<SearchParameterValue>> orValues)

clearParameterValues

public void clearParameterValues()

clearParameterOrValues

public void clearParameterOrValues()

removeParameterValue

public void removeParameterValue(SearchParameterValue value)

getSortCriteria

public Map<PropertyDescriptor,Boolean> getSortCriteria()

setSortCriteria

public void setSortCriteria(Map<PropertyDescriptor,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 - if true parameter are OR-connected, otherwise they're AND-connected

getSelectedTypes

public Set<SearchType> getSelectedTypes()

getContextParameter

public Object getContextParameter(String key)

setContextParameter

public void setContextParameter(String key,
                                Object value)

clone

public Object clone()
             throws CloneNotSupportedException

Overrides:

clone in class Object

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