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

💖 NAME 💖

SRU::Request::Scan — a whole class for representing SRU scan requests, bestie. That's it, that's the vibe. 🦋

---

✨ SYNOPSIS ✨

okay so first things first, you make a new request like this:

## creating a new request
my $request = SRU::Request::Scan->new();

and that's literally it, you're in. slay. 💅

---

🌸 DESCRIPTION 🌸

SRU::Request::Scan is a class for representing SRU 'scan' requests. no cap, that's the whole job. it holds the request, it knows its params, it vibes. 🎀

---

🫶 METHODS 🫶

🧚 new()

The constructor, queen. You can pass it these parameters: version, scanClause, responsePosition, maximumTerms, stylesheet, extraRequestData. (yes it's a lot of params, she's high maintenance but worth it 💅)

my $request = SRU::Request::Explain->new(
    version     => '1.1',
    scanClause  => 'horses',
);

ngl the example above says SRU::Request::Explain and not SRU::Request::Scan — that's exactly what the original page says, so we're keeping it fr fr, no edits, no notes. 🙈

---

🦋 version()

🦋 scanClause()

🦋 responsePosition()

🦋 maximumTerms()

🦋 stylesheet()

🦋 extraRequestData()

🦋 validParams()

---

👑 cql()

Fetch the root node of the CQL parse tree for the scan clause. it's giving main character energy for your scan clause, honestly. ⭐

---

💜 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.

---

okay bestie that's the whole page, go forth and scan 🍓✨

sign-off tea: this whole thing was generated by perl v5.34.0 and it's dated 2022-06-17, and it belongs to the User Contributed Perl Documentation section, under the name SRU::R...::Scan(3pm) 🎀🫶💖