de.hybris.platform.hmc

Class SearchRequest

java.lang.Object

de.hybris.platform.hmc.SearchRequest

public class SearchRequest
extends Object

Internal use

Since:

1.3.1

Constructor Summary

Constructors

Constructor and Description
SearchRequest() Creates a new SearchRequest.
SearchRequest(ComposedType type) Creates a new SearchRequest for the given search type.

Method Summary

Modifier and Type	Method and Description
SavedQuery	getSavedQuery() Returns the saved query which is to be used for this search request or null if there is no savedquery set.
ComposedType	getSearchType() Returns the search type for this SearchRequest
boolean	isAutoPerform() Returns true if the search should be automatically be performed (without further entries or pressing of buttons).
void	setAutoPerform(boolean auto) Set to true if the search should be performed automatically.
void	setSavedQuery(SavedQuery savedQuery) Sets the saved query which is to be used for this search request.
void	setSearchType(ComposedType type) Sets the search type for this SearchRequest.
String	toString() Returns a human readable representation of this request (including searchtype, savedquery code and autoperform value).

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchRequest

public SearchRequest()

Creates a new SearchRequest.

SearchRequest

public SearchRequest(ComposedType type)

Creates a new SearchRequest for the given search type.

Parameters:

type - the search type for this SearchRequest

Method Detail

getSearchType

public ComposedType getSearchType()

Returns the search type for this SearchRequest

Returns:

the search type for this SearchRequest

setSearchType

public void setSearchType(ComposedType type)

Sets the search type for this SearchRequest.

Parameters:

type - the search type for this SearchRequest

getSavedQuery

public SavedQuery getSavedQuery()

Returns the saved query which is to be used for this search request or null if there is no savedquery set.

Returns:

the saved query which is to be used for this search request or null if there is no savedquery set.

setSavedQuery

public void setSavedQuery(SavedQuery savedQuery)

Sets the saved query which is to be used for this search request. Use null if no savedquery should be set (which is the default).

Parameters:

savedQuery - the saved query which is to be used for this search request

isAutoPerform

public boolean isAutoPerform()

Returns true if the search should be automatically be performed (without further entries or pressing of buttons). Default is false.

Returns:

true if the search should be automatically be performed

setAutoPerform

public void setAutoPerform(boolean auto)

Set to true if the search should be performed automatically.

Parameters:

auto - true if the search should be performed automatically.

toString

public String toString()

Returns a human readable representation of this request (including searchtype, savedquery code and autoperform value).

Overrides:

toString in class Object

Returns:

a human readable representation of this request (including searchtype, savedquery code and autoperform value).