SWISH::API::Remote::Results - Represents the results of a search on a swished server


SWISH-API-Remote documentation  | view source Contained in the SWISH-API-Remote distribution.

Index


NAME

Top

SWISH::API::Remote::Results - Represents the results of a search on a swished server

DESCRIPTION

Top

Stores the results of a search from a swished server. Intended to be used with SWISH::API::Remote.

my $results = SWISH::API::Remote::Results->new()

returns a new SWISH::API::Remote::Results object. Normally called by SWISH::API::Remote for you.

my $error = $results->Error();

returns zero if there were no errors reported, non-zero otherwise.

my $error_string = $results->ErrorString();

returns the string representation of the error(s) returned from the swished server.

my $result = $results->NextResult();

returns the next result fetched from the swished server. If there are no more results for our query, returns undef

$results->SeekResults( $row_number );

Arranges for the next result retrieved by NextResult to be the row with the passed number. Rows always start at 0, even when using the BEGIN option to SWISH::API::Remote::Execute().

$results->Hits();

Returns the number of total hits found for the search.

$results->Fetched();

Returns the number of rows fetched for this search.

$results->HeaderNames();

Returns a sorted name keys of the header available for the swish-e results

SEE ALSO

Top

SWISH::API::Remote::Result, SWISH::API::Remote, swish-e

AUTHOR

Top

Josh Rabinowitz, <joshr@localdomain>

COPYRIGHT AND LICENSE

Top


SWISH-API-Remote documentation  | view source Contained in the SWISH-API-Remote distribution.