From Code to Community: Sponsoring The Perl and Raku Conference 2025 Learn more

HOCHSTEN / HTTP-OAI-4.13 / lib / HTTP / OAI / Error.pm 

            

              
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
—
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106

              
package HTTP::OAI::Error;
@ISA = qw( HTTP::OAI::SAX::Base HTTP::OAI::MemberMixin Exporter );
use strict;
use vars qw(@EXPORT @EXPORT_OK %EXPORT_TAG);
our $VERSION = '4.13';
@EXPORT = qw();
@EXPORT_OK = qw(%OAI_ERRORS);
%EXPORT_TAG = ();
my %OAI_ERRORS = (
        badArgument => 'The request includes illegal arguments, is missing required arguments, includes a repeated argument, or values for arguments have an illegal syntax.',
#       badGranularity => 'The values of the from and until arguments are illegal or specify a finer granularity than is supported by the repository.',
        badResumptionToken => 'The value of the resumptionToken argument is invalid or expired.',
        badVerb => 'Value of the verb argument is not a legal OAI-PMH verb, the verb argument is missing, or the verb argument is repeated.',
        cannotDisseminateFormat => 'The metadata format identified by the value given for the metadataPrefix argument is not supported by the item or by the repository',
        idDoesNotExist => 'The value of the identifier argument is unknown or illegal in this repository.',
        noRecordsMatch => 'The combination of the values of the from, until, set, and metadataPrefix arguments results in an empty list.',
        noMetadataFormats => 'There are no metadata formats available for the specified item.',
        noSetHierarchy => 'The repository does not support sets.'
);
sub new
{
        my( $class, %self ) = @_;
        $self{message} ||= $OAI_ERRORS{$self{code}} if $self{code};
        return $class->SUPER::new(%self);
}
sub code { shift->_elem('code',@_) }
sub message { shift->_elem('message',@_) }
sub generate
{
        my( $self, $driver ) = @_;
        $driver->data_element( 'error', ($self->message || $OAI_ERRORS{$self->code} || ''),
                        code => $self->code,
                );
}
sub start_element
{
        my( $self, $hash ) = @_;
        $self->code( $hash->{Attributes}->{'{}code'}->{Value} );
}
sub characters
{
        my( $self, $hash ) = @_;
        $self->message( $hash->{Data} );
}
1;
__END__
=head1 NAME
HTTP::OAI::Error - Encapsulates OAI error codes
=head1 METHODS
=over 4
=item $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.
=item $code = $err->code([$code])
Returns and optionally sets the error name.
=item $msg = $err->message([$msg])
Returns and optionally sets the error message.
=back
=head1 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\n";
        } else {
                print "Failed\n";
        }
        print $r->verb, "\n";
Will print "Successful" followed by "error".