debian man page for sru::response::searchretrieve

SRU::Response::SearchRetrieve(3pm)			User Contributed Perl Documentation			SRU::Response::SearchRetrieve(3pm)

NAME
       SRU::Response::SearchRetrieve - A class for representing SRU searchRetrieve responses

SYNOPSIS
	   ## create response from the request object
	   my $response = SRU::Response::SearchRetrieve->new( $request );

	   ## add records to the response
	   foreach my $record ( @records ) { $response->addRecord( $record ); }

	   ## print out the response as XML
	   print $response->asXML();

DESCRIPTION
       SRU::Response::SearchRetrieve provides a framework for bundling up the response to a searchRetrieve request. You are responsible for
       generating the XML representation of the records, and the rest should be taken care of.

METHODS
   new()
   numberOfRecords()
       Returns the number of results associated with the object.

   addRecord()
       Add a SRU::Response::Record object to the response.

	   $response->addRecord( $r );

       If you don't pass in the right sort of object you'll get back undef and $SRU::Error will be populated appropriately.

   records()
       Gets or sets all the records associated with the object. Be careful with this one :) You must pass in an array ref, and expect an array ref
       back.

   resultSetId()
   resultSetIdleTime()
   nextRecordPosition()
   diagnostics()
   extraResponseData()
   echoedSearchRetrieveRequest()
   asXML()
	   asXML(encoding=>"ISO-8859-1")

       Returns the object serialized as XML. UTF-8 and UTF-16 are default encodings if you don't pass the encoding parameter. You can define
       different encoding in order to parse you XML document correctly.

perl v5.12.4							    2009-11-20					SRU::Response::SearchRetrieve(3pm)