de.hybris.platform.hmc.jalo

Class OrganizerSearchConfiguration

java.lang.Object

de.hybris.platform.hmc.jalo.OrganizerSearchConfiguration

public class OrganizerSearchConfiguration
extends Object

Container holding all information needed for starting a search within a hmc type organizer.

Constructor Summary

Constructors

Constructor and Description
OrganizerSearchConfiguration() Creates a new configuration for the organizers default search.
OrganizerSearchConfiguration(String searchName) Creates a new configuration for a saved query search within a organizer.

Method Summary

Modifier and Type	Method and Description
void	addSearchField(String fieldName, String operator, Object value) Adds a new search field to the configuration.
String	getOperator(String fieldName) Returns the search operator assoziated with this field.
Set	getSearchFieldNames() Returns all search fields available in this configuration.
Object	getValue(String fieldName) Returns the search value assoziated with this field.
void	setRange(int start, int count) Specifies the range for this search.

Methods inherited from class java.lang.Object

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

Constructor Detail

OrganizerSearchConfiguration

public OrganizerSearchConfiguration()

Creates a new configuration for the organizers default search.

OrganizerSearchConfiguration

public OrganizerSearchConfiguration(String searchName)

Creates a new configuration for a saved query search within a organizer.

Parameters:

searchName - the name of the SavedQuery

Method Detail

setRange

public void setRange(int start,
                     int count)

Specifies the range for this search. Default range is [0,-1] which fetches all result items.

addSearchField

public void addSearchField(String fieldName,
                           String operator,
                           Object value)

Adds a new search field to the configuration. Please note that no consistency checking is done here. If no such field exists, the operator is invalid or the value cannot be used an error is raised when passing the configuration to the organitzer!

Parameters:

fieldName - the case-insensitive field name

operator - the operator

value - the search value

getSearchFieldNames

public Set getSearchFieldNames()

Returns all search fields available in this configuration.

getOperator

public String getOperator(String fieldName)
                   throws JaloInvalidParameterException

Returns the search operator assoziated with this field.

Parameters:

fieldName - the case-insensitive field name

Throws:

JaloInvalidParameterException - if no such field is available within this configuration

getValue

public Object getValue(String fieldName)

Returns the search value assoziated with this field.

Parameters:

fieldName - the case-insensitive field name

Throws:

JaloInvalidParameterException - if no such field is available within this configuration