Josh Rabinowitz > SWISH-API-Remote-0.10 > SWISH::API::Remote::Results

Download:
SWISH-API-Remote-0.10.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
Report a bug
Source  

NAME ^

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

DESCRIPTION ^

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 ^

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

AUTHOR ^

Josh Rabinowitz, <joshr@localdomain>

COPYRIGHT AND LICENSE ^

Copyright (C) 2004-2006 by Josh Rabinowitz

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.3 or, at your option, any later version of Perl 5 you may have available.