http::oai::useragent(3pm) [debian man page]

HTTP::OAI::UserAgent(3pm)				User Contributed Perl Documentation				 HTTP::OAI::UserAgent(3pm)

NAME

       HTTP::OAI::UserAgent - Extension of the LWP::UserAgent for OAI HTTP requests

DESCRIPTION

       This module provides a simplified mechanism for making requests to an OAI repository, using the existing LWP::UserAgent module.

SYNOPSIS

	       require HTTP::OAI::UserAgent;

	       my $ua = new HTTP::OAI::UserAgent;

	       my $response = $ua->request(
		       baseURL=>'http://arXiv.org/oai1',
		       verb=>'ListRecords',
		       from=>'2001-08-01',
		       until=>'2001-08-31'
	       );

	       print $response->content;

METHODS

       $ua = new HTTP::OAI::UserAgent(proxy=>'www-cache',...)
	   This constructor method returns a new instance of a HTTP::OAI::UserAgent module. All arguments are passed to the LWP::UserAgent
	   constructor.

       $r = $ua->request($req)
	   Requests the HTTP response defined by $req, which is a HTTP::Request object.

       $r = $ua->request(baseURL=>$baseref, verb=>$verb, %opts)
	   Makes an HTTP request to the given OAI server (baseURL) with OAI arguments. Returns an HTTP::Response object.

	   OAI-PMH related options:

		   from => $from
		   until => $until
		   resumptionToken => $token
		   metadataPrefix => $mdp
		   set => $set

       $str = $ua->url(baseURL=>$baseref, verb=>$verb, ...)
	   Takes the same arguments as request, but returns the URL that would be requested.

       $time_d = $ua->delay( $time_d )
	   Return and optionally set a time (in seconds) to wait between requests. $time_d may be a CODEREF.

perl v5.12.4							    2011-06-23						 HTTP::OAI::UserAgent(3pm)

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)