de.hybris.platform.hmc.util.search

Class GenericSearchContainer

java.lang.Object

de.hybris.platform.hmc.util.search.AbstractSearchContainer

de.hybris.platform.hmc.util.search.GenericSearchContainer

All Implemented Interfaces:

Serializable

public class GenericSearchContainer
extends AbstractSearchContainer

Implementation of AbstractSearchContainer which is used in the search result pager view.

See Also:

Serialized Form

Field Summary

Fields inherited from class de.hybris.platform.hmc.util.search.AbstractSearchContainer

searchResult

Constructor Summary

Constructors

Constructor and Description
GenericSearchContainer(DisplayState displayState, ComposedType type)
GenericSearchContainer(DisplayState displayState, GenericQuery genericQuery)

Method Summary

Modifier and Type	Method and Description
void	execute() Executes the defined search (if valid) and stores the result.
ComposedType	getComposedType()
GenericQuery	getGenericQuery()
int	getItemsPerPage()
int	getRangeStart()
SearchContext	getSearchContext() The SearchContext which will be used to execute the search.
String	getSortQualifier()
boolean	isValid()
void	setGenericQuery(GenericQuery genericQuery)
void	setItemsPerPage(int itemsPerPage)
void	setRangeStart(int rangeStart)
protected void	setSearchContext(SearchContext searchContext) Sets the SessionContext which will be used to execute the search.
void	setSortQualifier(String sortQualifier)
String	toString() A String representation of the defined search.

Methods inherited from class de.hybris.platform.hmc.util.search.AbstractSearchContainer

getDisplayState, getItemCount, getSearchResult, getSortDirection, setRange, setSortDirection

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericSearchContainer

public GenericSearchContainer(DisplayState displayState,
                              ComposedType type)

GenericSearchContainer

public GenericSearchContainer(DisplayState displayState,
                              GenericQuery genericQuery)

Method Detail

execute

public void execute()
             throws HMCSystemException

Description copied from class: AbstractSearchContainer

Executes the defined search (if valid) and stores the result.

Specified by:

execute in class AbstractSearchContainer

Throws:

HMCSystemException - throws a hmc exception if the search could not be executed correctly.

getSearchContext

public SearchContext getSearchContext()

The SearchContext which will be used to execute the search.

Returns:

Returns the searchContext.

setSearchContext

protected void setSearchContext(SearchContext searchContext)
                         throws IllegalArgumentException

Sets the SessionContext which will be used to execute the search.

Parameters:

searchContext - The searchContext to set. Can not be null.

Throws:

IllegalArgumentException - if parameter searchContext is null

toString

public String toString()

Description copied from class: AbstractSearchContainer

A String representation of the defined search.

Specified by:

toString in class AbstractSearchContainer

getSortQualifier

public String getSortQualifier()

Specified by:

getSortQualifier in class AbstractSearchContainer

Returns:

String, the qualifer of the attribute, which is used to sort the search result.

setSortQualifier

public void setSortQualifier(String sortQualifier)

Specified by:

setSortQualifier in class AbstractSearchContainer

Parameters:

sortQualifier - the qualifer of a attribute, which should be used for sorting the search result.

isValid

public boolean isValid()

Specified by:

isValid in class AbstractSearchContainer

Returns:

true, if the mandatory elements of a search are defined otherwise false.

setItemsPerPage

public void setItemsPerPage(int itemsPerPage)

Overrides:

setItemsPerPage in class AbstractSearchContainer

Parameters:

itemsPerPage - the number of elements of the search range.

setRangeStart

public void setRangeStart(int rangeStart)

Overrides:

setRangeStart in class AbstractSearchContainer

Parameters:

rangeStart - the start index of the result range, which should be returned.

getRangeStart

public int getRangeStart()

Overrides:

getRangeStart in class AbstractSearchContainer

Returns:

int, the index of the first element of the search range.

getItemsPerPage

public int getItemsPerPage()

Overrides:

getItemsPerPage in class AbstractSearchContainer

Returns:

int, the max number of elements of a search range.

getGenericQuery

public GenericQuery getGenericQuery()

Returns:

Returns the genericQuery.

setGenericQuery

public void setGenericQuery(GenericQuery genericQuery)

Parameters:

genericQuery - the GenericQuery to be set

Throws:

IllegalArgumentException - if the parameter genericQuery is null

getComposedType

public ComposedType getComposedType()

Specified by:

getComposedType in class AbstractSearchContainer