sru::response::searchretrieve(3pm) [debian man page]

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)

SRU::Server(3pm)					User Contributed Perl Documentation					  SRU::Server(3pm)

NAME

       SRU::Server - respond to SRU requests via CGI::Application

SYNOPSIS

	   package MySRU;

	   use base qw( SRU::Server );

	   sub explain {
	       my $self = shift;

	       # $self->request isa SRU::Request::Explain
	       # $self->response isa SRU::Response::Explain
	   }

	   sub scan {
	       my $self = shift;

	       # $self->request isa SRU::Request::Scan
	       # $self->response isa SRU::Response::Scan
	       # $self->cql is the root node of a CQL::Parser-parsed query
	   }

	   sub searchRetrieve {
	       my $self = shift;

	       # $self->request isa SRU::Request::SearchRetrieve
	       # $self->response isa SRU::Response::SearchRetrieve
	       # $self->cql is the root node of a CQL::Parser-parsed query
	   }

	   package main;

	   MySRU->new->run;

DESCRIPTION

       This module brings together all of the SRU verbs (explain, scan and searchRetrieve) under a sub-classable object based on CGI::Application.

METHODS

   explain
       This method is used to return an explain response. It is the default method.

   scan
       This method returns a scan response.

   searchRetrieve
       This method returns a searchRetrieve response.

CGI
::APPLICATION METHODS
   setup
       Sets the "run_modes", "mode_param" and the default runmode (explain).

   cgiapp_prerun
       Parses the incoming SRU request and if needed, checks the CQL query.

   cgiapp_postrun
       Sets the content type (text/xml) and serializes the response.

   error_mode
       Stub error runmode.

AUTHORS

       o   Brian Cassidy <bricas@cpan.org>

       o   Ed Summers <ehs@pobox.com>

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