de.hybris.platform.hmc.util.search

Class AbstractSearchContainer

java.lang.Object

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

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

FlexibleSearchContainer, GenericSearchContainer, LuceneSearchContainer

public abstract class AbstractSearchContainer
extends Object
implements Serializable

Abstract supper class of all search containers which offers the execution of a defined search (if valid) and storing of the result.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected SearchResult	searchResult

Constructor Summary

Constructors

Constructor and Description
AbstractSearchContainer(DisplayState displayState)

Method Summary

Modifier and Type	Method and Description
abstract void	execute() Executes the defined search (if valid) and stores the result.
abstract ComposedType	getComposedType()
protected DisplayState	getDisplayState()
int	getItemCount()
int	getItemsPerPage()
int	getRangeStart()
SearchResult	getSearchResult()
String	getSortDirection()
abstract String	getSortQualifier()
abstract boolean	isValid()
void	setItemsPerPage(int itemsPerPage)
void	setRange(int rangeStart, int itemsPerPage) Sets the range of the searchresult, which should be returned.
void	setRangeStart(int rangeStart)
void	setSortDirection(String sortDirection)
abstract void	setSortQualifier(String sortQualifier)
abstract String	toString() A String representation of the defined search.

Methods inherited from class java.lang.Object

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

Field Detail

searchResult

protected SearchResult searchResult

Constructor Detail

AbstractSearchContainer

public AbstractSearchContainer(DisplayState displayState)

Method Detail

execute

public abstract void execute()
                      throws HMCSystemException

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

Throws:

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

toString

public abstract String toString()

A String representation of the defined search.

Overrides:

toString in class Object

isValid

public abstract boolean isValid()

Returns:

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

getSortQualifier

public abstract String getSortQualifier()

Returns:

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

setSortQualifier

public abstract void setSortQualifier(String sortQualifier)

Parameters:

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

getComposedType

public abstract ComposedType getComposedType()

setRangeStart

public void setRangeStart(int rangeStart)

Parameters:

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

setItemsPerPage

public void setItemsPerPage(int itemsPerPage)

Parameters:

itemsPerPage - the number of elements of the search range.

setSortDirection

public void setSortDirection(String sortDirection)

Parameters:

sortDirection - define the sort direction of the search result.

getItemCount

public int getItemCount()

Returns:

int, total number of result elements. Returns -1, if the search has not been executed.

getItemsPerPage

public int getItemsPerPage()

Returns:

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

getRangeStart

public int getRangeStart()

Returns:

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

getSortDirection

public String getSortDirection()

Returns:

String, sort direction of the search result.

getSearchResult

public SearchResult getSearchResult()

Returns:

SearchResult, the SearchResult of the last executed search. Returns null, if no search has been executed before.

setRange

public void setRange(int rangeStart,
                     int itemsPerPage)

Sets the range of the searchresult, which should be returned.

Parameters:

rangeStart - index of the first element of the range.

itemsPerPage - number of elements of the range.

getDisplayState

protected DisplayState getDisplayState()

Returns:

DisplayState