Package DE_EPAGES::RemoteSearch::API::Object::SearchParamBuilder
Class for craeting params for remote search requests. With Method addXXXFilter you can define condition wich must be met by a search query.
Example |
my $Builder = DE_EPAGES::RemoteSearch::API::Object::SearchParamBuilder->new(); $Builder->addBooleanFilter('IsNew', 1) ->query('Jack') ->lang('en') ->addNumericRangeFilter('Price', 10, 20 ); my $hParams = $Builder->params(); |
Functions
- addBooleanFilter
- addNumericRangeFilter
- addSimpleFilter
- currency
- currentPage
- lang
- new
- params
- query
- resultsPerPage
- sortBy
addBooleanFilter
Construct boolean Filter and stores it in the filter list. Any value perl evaluates to true is encoded as 1, all else is 0.
Syntax |
$Builder->addBooleanFilter( $Name, $Value ); |
Example |
$Builder->booleanFilter( 'IsNew', 1 ); |
Input |
|
Return |
|
addNumericRangeFilter
Construct a numeric range filter and stores is internally. $hOptions must
at least contain one of $Min or $Max.
If $Min and $Max is set a closed interval is created [$Min, $Max].
If only on $Min or $Max is set a half open interval is created [$Min, undef]
respectively [undef, $Max].
Syntax |
$Builder->addNumericRangeFilter( $Name, $Min, $Max ); |
Input |
|
Return |
|
addSimpleFilter
Constructs simple filter and stores it into the filter list.
Syntax |
$Builder->addSimpleFilter( $Name, $Value ); |
Example |
$Builder->addSimpleFilter( 'Manufacturer', 'Deuter' ); |
Input |
|
Return |
|
currency
Adds currency code to parameters
Syntax |
$Builder->currency( $currency ); |
Example |
$Builder->currency( 'EUR' ); |
Input |
|
Return |
|
currentPage
Adds current page number to parameters
Syntax |
$Builder->currentPage( $currentPage ); |
Example |
$Builder->currentPage( 2 ); |
Input |
|
Return |
|
lang
Adds language code to parameters
Syntax |
$Builder->lang( $lang ); |
Example |
$Builder->lang( 'de' ); |
Input |
|
Return |
|
new
Standard constructor
Syntax |
my $Builder = DE_EPAGES::RemoteSearch::API::Object::SearchParamBuilder->new() |
Input |
|
Return |
|
params
Returns reference of the parameters list stored in this object
Syntax |
my $hParams = $Builder->params(); |
Return |
|
query
Adds a query to parameters. Must contain at least on non whitespace character.
Syntax |
$Builder->query( $query ); |
Example |
$Builder->query( 'Jack' ); |
Input |
|
Return |
|
resultsPerPage
sets results per page
Syntax |
resultsPerPage( $resultsPerPage ); |
Input |
|
Return |
|
sortBy
Adds sorting option to parameters
Syntax |
$Builder->sortBy( $orderBy, $orderDesc ); |
Example |
$Builder->sortBy( 'NameOrAlias', 0 ); |
Input |
|
Return |
|