de.hybris.platform.hmc.util.search

Class FlexibleSearchContainer

java.lang.Object

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

de.hybris.platform.hmc.util.search.FlexibleSearchContainer

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

DynamicFlexibleSearchContainer, WorkflowSearchContainer

public class FlexibleSearchContainer
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
FlexibleSearchContainer(DisplayState displayState, ComposedType composedType, SavedQuery savedQuery)

Method Summary

Modifier and Type	Method and Description
void	execute() Executes the defined search (if valid) and stores the result.
ComposedType	getComposedType()
Map	getParameterValues()
String	getQuery()
SavedQuery	getSavedQuery() see PLA-5138
String	getSortQualifier()
boolean	isValid() Returns true, if getComposedType()!=null and getQuery()!=null.
protected String	replaceTypePlaceholder(String query)
void	setComposedType(ComposedType composedType)
void	setParameterValues(List parameters)
void	setSortQualifier(String sortQualifier) Right now, the SortQualifier is not used during the search.
String	toString() Returns a string representation of this search.

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

getDisplayState, getItemCount, getItemsPerPage, getRangeStart, getSearchResult, getSortDirection, setItemsPerPage, setRange, setRangeStart, setSortDirection

Methods inherited from class java.lang.Object

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

Constructor Detail

FlexibleSearchContainer

public FlexibleSearchContainer(DisplayState displayState,
                               ComposedType composedType,
                               SavedQuery savedQuery)

Method Detail

replaceTypePlaceholder

protected String replaceTypePlaceholder(String query)

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.

getComposedType

public ComposedType getComposedType()

Specified by:

getComposedType in class AbstractSearchContainer

Returns:

ComposedType, the search is based on.

setComposedType

public void setComposedType(ComposedType composedType)

Parameters:

composedType - the ComposedType the search will be executed on.

toString

public String toString()

Returns a string representation of this search. (Format: ComposedType.getCode() + ": " + getQuery())

Specified by:

toString in class AbstractSearchContainer

setSortQualifier

public void setSortQualifier(String sortQualifier)

Right now, the SortQualifier is not used during the search.

Specified by:

setSortQualifier in class AbstractSearchContainer

Parameters:

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

See Also:

AbstractSearchContainer.setSortQualifier(java.lang.String)

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.

See Also:

AbstractSearchContainer.getSortQualifier()

isValid

public boolean isValid()

Returns true, if getComposedType()!=null and getQuery()!=null. Does not validate the definied FlexibleSearch-Query.

Specified by:

isValid in class AbstractSearchContainer

Returns:

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

See Also:

AbstractSearchContainer.isValid()

getQuery

public String getQuery()

Returns:

String the flexible search query

setParameterValues

public void setParameterValues(List parameters)

getParameterValues

public Map getParameterValues()

getSavedQuery

public SavedQuery getSavedQuery()

see PLA-5138

Since:

3.0 M2