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

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

NAME

       HTTP::OAI::Error - Encapsulates OAI error codes

METHODS

       $err = new HTTP::OAI::Error(code=>'badArgument',[message=>'An incorrect argument was supplied'])
	   This constructor method returns a new HTTP::OAI::Error object.

	   If no message is specified, and the code is a valid OAI error code, the appropriate message from the OAI protocol document is the
	   default message.

       $code = $err->code([$code])
	   Returns and optionally sets the error name.

       $msg = $err->message([$msg])
	   Returns and optionally sets the error message.

NOTE - noRecordsMatch
       noRecordsMatch, without additional errors, is not treated as an error code. If noRecordsMatch was returned by a repository the
       HTTP::OAI::Response object will have a verb 'error' and will contain the noRecordsMatch error, however is_success will return true.

       e.g.

	       my $r = $ha->ListIdentifiers(metadataPrefix='oai_dc',from=>'3000-02-02');

	       if( $r->is_success ) {
		       print "Successful
";
	       } else {
		       print "Failed
";
	       }

	       print $r->verb, "
";

       Will print "Successful" followed by "error".

perl v5.12.4							    2007-06-28						     HTTP::OAI::Error(3pm)

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)