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

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

NAME

       HTTP::OAI::ListRecords - Provide access to an OAI ListRecords response

SYNOPSIS

	       my $r = $h->ListRecords(
		       metadataPrefix=>'oai_dc',
	       );

	       while( my $rec = $r->next ) {
		       print "Identifier => ", $rec->identifier, "
";
	       }

	       die $r->message if $r->is_error;

	       # Using callback method
	       sub callback {
		       my $rec = shift;
		       print "Identifier => ", $rec->identifier, "
";
	       };
	       my $r = $h->ListRecords(
		       metadataPrefix=>'oai_dc',
		       onRecord=>&callback
	       );
	       die $r->message if $r->is_error;

METHODS

       $lr = new HTTP::OAI::ListRecords
	   This constructor method returns a new HTTP::OAI::ListRecords object.

       $rec = $lr->next
	   Returns either an HTTP::OAI::Record object, or undef, if no more record are available. Use $rec->is_error to test whether there was an
	   error getting the next record.

       @recl = $lr->record([$rec])
	   Returns the record list and optionally adds a new record or resumptionToken, $rec. Returns an array ref of HTTP::OAI::Records,
	   including an optional resumptionToken string.

       $token = $lr->resumptionToken([$token])
	   Returns and optionally sets the HTTP::OAI::ResumptionToken.

       $dom = $lr->toDOM
	   Returns a XML::DOM object representing the ListRecords response.

perl v5.12.4							    2011-06-23					       HTTP::OAI::ListRecords(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)