.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29) .\" .\" 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 turned on, 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 "HTTP::OAI::Header 3pm" .TH HTTP::OAI::Header 3pm "2016-07-15" "perl v5.22.2" "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" HTTP::OAI::Header \- Encapsulates an OAI header structure .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use HTTP::OAI::Header; \& \& my $h = new HTTP::OAI::Header( \& identifier=>\*(Aqoai:myarchive.org:2233\-add\*(Aq, \& datestamp=>\*(Aq2002\-04\-12T20:31:00Z\*(Aq, \& ); \& \& $h\->setSpec(\*(Aqall:novels\*(Aq); .Ve .SH "METHODS" .IX Header "METHODS" .ie n .IP "$h = new HTTP::OAI::Header" 4 .el .IP "\f(CW$h\fR = new HTTP::OAI::Header" 4 .IX Item "$h = new HTTP::OAI::Header" This constructor method returns a new \f(CW\*(C`HTTP::OAI::Header object\*(C'\fR. .ie n .IP "$h\->identifier([$identifier])" 4 .el .IP "\f(CW$h\fR\->identifier([$identifier])" 4 .IX Item "$h->identifier([$identifier])" Get and optionally set the record \s-1OAI\s0 identifier. .ie n .IP "$h\->datestamp([$datestamp])" 4 .el .IP "\f(CW$h\fR\->datestamp([$datestamp])" 4 .IX Item "$h->datestamp([$datestamp])" Get and optionally set the record datestamp (\s-1OAI 2.0+\s0). .ie n .IP "$h\->status([$status])" 4 .el .IP "\f(CW$h\fR\->status([$status])" 4 .IX Item "$h->status([$status])" Get and optionally set the record status (valid values are 'deleted' or undef). .ie n .IP "$h\->\fIis_deleted()\fR" 4 .el .IP "\f(CW$h\fR\->\fIis_deleted()\fR" 4 .IX Item "$h->is_deleted()" Returns whether this record's status is deleted. .ie n .IP "@sets = $h\->setSpec([$setSpec])" 4 .el .IP "\f(CW@sets\fR = \f(CW$h\fR\->setSpec([$setSpec])" 4 .IX Item "@sets = $h->setSpec([$setSpec])" Returns the list of setSpecs and optionally appends a new setSpec \f(CW$setSpec\fR (\s-1OAI 2.0+\s0). .ie n .IP "$dom_fragment = $id\->\fIgenerate()\fR" 4 .el .IP "\f(CW$dom_fragment\fR = \f(CW$id\fR\->\fIgenerate()\fR" 4 .IX Item "$dom_fragment = $id->generate()" Act as a \s-1SAX\s0 driver (use \f(CW\*(C`$h\->set_handler()\*(C'\fR to specify the filter to pass events to).