Bug 24545: Fix license statements
[srvgit] / Koha / Exceptions / Metadata.pm
1 package Koha::Exceptions::Metadata;
2
3 # This file is part of Koha.
4 #
5 # Koha is free software; you can redistribute it and/or modify it
6 # under the terms of the GNU General Public License as published by
7 # the Free Software Foundation; either version 3 of the License, or
8 # (at your option) any later version.
9 #
10 # Koha is distributed in the hope that it will be useful, but
11 # WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
14 #
15 # You should have received a copy of the GNU General Public License
16 # along with Koha; if not, see <http://www.gnu.org/licenses>.
17
18 use Modern::Perl;
19
20 use Exception::Class (
21
22     'Koha::Exceptions::Metadata' => {
23         description => 'Something went wrong!',
24     },
25     'Koha::Exceptions::Metadata::Invalid' => {
26         isa => 'Koha::Exceptions::Metadata',
27         description => 'Invalid data',
28         fields => ['id','format','schema', 'decoding_error']
29     }
30 );
31
32 sub full_message {
33     my $self = shift;
34
35     my $msg = $self->message;
36
37     unless ($msg) {
38         if ( $self->isa('Koha::Exceptions::Metadata::Invalid') ) {
39             $msg = sprintf( "Invalid data, cannot decode object (id=%s, format=%s, schema=%s, decoding_error='%s')",
40                 $self->id, $self->format, $self->schema, $self->decoding_error );
41         }
42     }
43
44     return $msg;
45 }
46
47 =head1 NAME
48
49 Koha::Exceptions::Metadata - Base class for metadata exceptions
50
51 =head1 Exceptions
52
53 =head2 Koha::Exceptions::Metadata
54
55 Generic metadata exception
56
57 =head2 Koha::Exceptions::Metadata::Invalid
58
59 The metadata is invalid.
60
61 =head1 Class methods
62
63 =head2 full_message
64
65 Overloaded method for exception stringifying.
66
67 =cut
68
69 1;