Thomas Berger > OAI-Harvester-1.16_04 > Net::OAI::Base

Download:
OAI-Harvester-1.16_04.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Source   Latest Release: OAI-Harvester-1.16_09

NAME ^

Net::OAI::Base - A base class for all OAI-PMH responses

SYNOPSIS ^

    if ( $object->resumptionToken() ) { 
        ...
    }

    if ( $object->errorCode() ) { 
        print "verb action resulted in error code:" . $object->errorCode() . 
            " message:" . $object->errorString() . "\n";
    }

    print "xml response can be found here: " . $obj->file() . "\n";
    print "the response xml is " . $obj->xml(); 

DESCRIPTION ^

Net::OAI::Base is the base class for all the OAI-PMH verb responses. It is used to provide similar methods to all the responses. The following classes inherit from Net::OAI::Base.

METHODS ^

errorCode()

Returns an error code associated with the verb result.

errorString()

Returns an error message associated with an error code.

HTTPRetryAfter()

Returns the HTTP Retry-After header in case of HTTP level errors.

HTTPError()

Returns the HTTP::Response object in case of HTTP level errors.

resumptionToken()

Returns a Net::OAI::ResumptionToken object associated with the call. If there was no resumption token returned in the response then you will be returned undef.

xml()

Returns a reference to a scalar that contains the raw content of the response as XML.

file()

Returns the path to a file that contains the complete XML response.

TODO ^

SEE ALSO ^

AUTHORS ^

syntax highlighting: