GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  SRU::RESPONSE::SEARCHRETRIEVE (3)

.ds Aq ’

NAME

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

CONTENTS

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.

COPYRIGHT AND LICENSE

This software is copyright (c) 2013 by Ed Summers.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 SRU::RESPONSE::SEARCHRETRIEVE (3) 2013-10-18

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.