debian man page for http::oai::error

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)