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 Koha::Exception;
  21
  22 use Exception::Class (
  23
  24     'Koha::Exceptions::Metadata' => {
  25         isa => 'Koha::Exception',
  26     },
  27     'Koha::Exceptions::Metadata::Invalid' => {
  28         isa => 'Koha::Exceptions::Metadata',
  29         description => 'Invalid data',
  30         fields => ['id', 'biblionumber', 'format', 'schema', 'decoding_error']
  31     }
  32 );
  33
  34 sub full_message {
  35     my $self = shift;
  36
  37     my $msg = $self->message;
  38
  39     unless ($msg) {
  40         if ( $self->isa('Koha::Exceptions::Metadata::Invalid') ) {
  41             $msg = sprintf( "Invalid data, cannot decode metadata object (biblio_metadata.id=%s, biblionumber=%s, format=%s, schema=%s, decoding_error='%s')",
  42                 $self->id, $self->biblionumber, $self->format, $self->schema, $self->decoding_error );
  43         }
  44     }
  45
  46     return $msg;
  47 }
  48
  49 =head1 NAME
  50
  51 Koha::Exceptions::Metadata - Base class for metadata exceptions
  52
  53 =head1 Exceptions
  54
  55 =head2 Koha::Exceptions::Metadata
  56
  57 Generic metadata exception
  58
  59 =head2 Koha::Exceptions::Metadata::Invalid
  60
  61 The metadata is invalid.
  62
  63 =head1 Class methods
  64
  65 =head2 full_message
  66
  67 Overloaded method for exception stringifying.
  68
  69 =cut
  70
  71 1;