ePages 6.14.0 - DE_EPAGES/RemoteSearch/API/DTO/SearchResponse.pm

Package DE_EPAGES::RemoteSearch::API::DTO::SearchResponse

Read only data object to hold the search result.

Functions

fallbackQuery
items
query
results

fallbackQuery

Returns fallback query if no fallback was used a zero lenght String is returned.

Syntax
my $SearchExpression = $Response->fallbackQuery();
Return
$SearchExpression (String)
fallback search expression default: ''

items

Returns object ids for items matching $Response->query()

Syntax
my $aItems = $Response->items();
Return
$aItems (array.ref.)
object ids found items or empty array reference

query

Returns original search expression, if this expression retrieve no matching items a fallbackQuery was used for this $Response

Syntax
my $SearchExpression = $Response->query();
Return
$SearchExpression (String)
original search expression

results

Returns object ids for items matching $Response->query() search

Syntax
my $NoResults = $Response->results();
Return
$NoResults (integer)
number of hits equals scalar @{$Response->items}