HTTP::OAI::Record(3pm) User Contributed Perl Documentation HTTP::OAI::Record(3pm)NAME
HTTP::OAI::Record - Encapsulates an OAI record
SYNOPSIS
use HTTP::OAI::Record;
# Create a new HTTP::OAI Record
my $r = new HTTP::OAI::Record();
$r->header->identifier('oai:myarchive.org:oid-233');
$r->header->datestamp('2002-04-01');
$r->header->setSpec('all:novels');
$r->header->setSpec('all:books');
$r->metadata(new HTTP::OAI::Metadata(dom=>$md));
$r->about(new HTTP::OAI::Metadata(dom=>$ab));
METHODS
$r = new HTTP::OAI::Record( %opts )
This constructor method returns a new HTTP::OAI::Record object.
Options (see methods below):
header => $header
metadata => $metadata
about => [$about]
$r->header([HTTP::OAI::Header])
Returns and optionally sets the record header (an HTTP::OAI::Header object).
$r->metadata([HTTP::OAI::Metadata])
Returns and optionally sets the record metadata (an HTTP::OAI::Metadata object).
$r->about([HTTP::OAI::Metadata])
Optionally adds a new About record (an HTTP::OAI::Metadata object) and returns an array of objects (may be empty).
Header Accessor Methods
These methods are equivalent to "$rec->header->$method([$value])".
$r->identifier([$identifier])
Get and optionally set the record OAI identifier.
$r->datestamp([$datestamp])
Get and optionally set the record datestamp.
$r->status([$status])
Get and optionally set the record status (valid values are 'deleted' or undef).
$r->is_deleted()
Returns whether this record's status is deleted.
perl v5.12.4 2011-06-23 HTTP::OAI::Record(3pm)
Check Out this Related Man Page
HTTP::OAI::Response(3pm) User Contributed Perl Documentation HTTP::OAI::Response(3pm)NAME
HTTP::OAI::Response - An OAI response
DESCRIPTION
"HTTP::OAI::Response" inherits from HTTP::Response and supplies some utility methods for OAI.
METHODS
$r = new HTTP::OAI::Response([responseDate=>$rd][, requestURL=>$ru])
This constructor method returns a new HTTP::OAI::Response object. Optionally set the responseDate and requestURL.
Use $r->is_error to test whether the request was successful. In addition to the HTTP response codes, the following codes may be
returned:
600 - Error parsing XML or invalid OAI response
Use $r->message to obtain a human-readable error message.
$r->copy_from( $r )
Copies an HTTP::Response $r into this object.
$headers = $r->headers
Returns an HTTP::OAI::Headers object.
$errs = $r->errors([$err])
Returns and optionally adds to the OAI error list. Returns a reference to an array.
$rd = $r->responseDate( [$rd] )
Returns and optionally sets the response date.
$ru = $r->requestURL( [$ru] )
Returns and optionally sets the request URL.
$verb = $r->verb( [$verb] )
Returns and optionally sets the OAI verb.
$r->version
Return the version of the OAI protocol used by the remote site (protocolVersion is automatically changed by the underlying API).
$r->xslt( $url )
Set the stylesheet to use in a response.
NOTE - requestURI/request
Version 2.0 of OAI uses a "request" element to contain the client's request, rather than a URI. The OAI-PERL library automatically converts
from a URI into the appropriate request structure, and back again when harvesting.
The exception to this rule is for badVerb errors, where the arguments will not be available for conversion into a URI.
perl v5.12.4 2011-06-23 HTTP::OAI::Response(3pm)