SRU::R...etrieve(3pm)

💖 SRU::Response::SearchRetrieve 💖

okay bestie, so this is a page from the User Contributed Perl Documentation set, and it's all about SRU::Response::SearchRetrieve — that's the 3pm one. it's a whole class for representing SRU searchRetrieve responses. yes, the real deal. sit down, hydrate, let's go 🫶

---

✨ NAME ✨

SRU::Response::SearchRetrieve — a class for representing SRU searchRetrieve responses. that's it, that's the vibe 💅

---

🌸 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();

look at that. three little steps and you're iconic ✨

---

🦋 DESCRIPTION 🦋

so SRU::Response::SearchRetrieve hands you a framework for bundling up the response to a searchRetrieve request. that's the whole point of it, no cap.

here's the deal though: you are the one responsible for generating the XML representation of the records. that part is on you, bestie 😭 the rest, though? the rest should be taken care of. handled. done. slay 🎀

---

👑 METHODS 👑

new()

no description given, she's mysterious. main character energy, honestly 🙈

numberOfRecords()

returns the number of results associated with the object. literally just the count. that's it, that's the function 🍓

addRecord()

adds a SRU::Response::Record object to the response.

$response->addRecord( $r );

⚠️ heads up bestie: if you don't pass in the right sort of object you'll get back undef and $SRU::Error will be populated appropriately. so like, don't be messy with your types 💀

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. array ref in, array ref out. do not fight this. respect the contract 🔥

resultSetId()

listed, no description. she's there. she exists. 💜

resultSetIdleTime()

also just vibing on the list, no description attached 🌈

nextRecordPosition()

same story, present and accounted for ⭐

diagnostics()

on the list, no notes 🧚

extraResponseData()

you guessed it — on the list 💖

echoedSearchRetrieveRequest()

still on the list, still iconic ✨

asXML()

asXML(encoding=>"ISO-8859-1")

returns the object serialized as XML 🎀

UTF-8 and UTF-16 are the default encodings if you don't pass the encoding parameter. and you can define a different encoding in order to parse your XML document correctly. so like, pick your encoding, be intentional about it 💅

---

💖 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. periodt 🫶

---

and that's the whole page bestie!! this was perl v5.34.0, dated 2022-06-17, from the SRU::R...etrieve(3pm) manual 💜 go forth and bundle your responses responsibly, ily, bye 🎀✨