.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "SRU::Response::Explain 3pm" .TH SRU::Response::Explain 3pm "2022-06-17" "perl v5.34.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" SRU::Response::Explain \- A class for representing SRU explain responses .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 2 \& use SRU::Response; \& my $response = SRU::Response::Explain\->new( $request ); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" .SH "METHODS" .IX Header "METHODS" .SS "\fBnew()\fP" .IX Subsection "new()" The constructor which requires that you pass in a SRU::Request::Explain object. .SS "\fBversion()\fP" .IX Subsection "version()" .SS "\fBrecord()\fP" .IX Subsection "record()" .SS "\fBaddDiagnostic()\fP" .IX Subsection "addDiagnostic()" Add a SRU::Response::Diagnostic object to the response. .SS "\fBdiagnostics()\fP" .IX Subsection "diagnostics()" Returns an array ref of SRU::Response::Diagnostic objects relevant for the response. .SS "\fBextraResponseData()\fP" .IX Subsection "extraResponseData()" .SS "\fBechoedExplainRequest()\fP" .IX Subsection "echoedExplainRequest()" .SS "\fBasXML()\fP" .IX Subsection "asXML()" .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is copyright (c) 2013 by Ed Summers. .PP This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.