Koha/Exceptions/Elasticsearch.pm

   1 package Koha::Exceptions::Elasticsearch;
   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::Elasticsearch' => {
  23         description => 'Something went wrong!',
  24     },
  25     'Koha::Exceptions::Elasticsearch::BadResponse' => {
  26         isa         => 'Koha::Exceptions::Elasticsearch',
  27         description => 'Bad response received when submitting request to Elasticsearch',
  28         fields      => [ 'type', 'details' ]
  29     },
  30     'Koha::Exceptions::Elasticsearch::MARCFieldExprParseError' => {
  31         isa         => 'Koha::Exceptions::Elasticsearch',
  32         description => 'Error parsing MARC Field Expression'
  33     }
  34 );
  35
  36 =head1 NAME
  37
  38 Koha::Exceptions::Elasticsearch - Base class for elasticsearch exceptions
  39
  40 =head1 Exceptions
  41
  42 =head2 Koha::Exceptions::Elasticsearch
  43
  44 Generic Elasticsearch exception
  45
  46 =head2 Koha::Exceptions::Elasticsearch::BadResponse
  47
  48 Exception to be used when more a request to ES fails
  49
  50 =head2 Koha::Exceptions::Elasticsearch::MARCFieldExprParseError
  51
  52 Exception to be used when encountering an error parsing MARC Field Expression
  53
  54 =head1 Class methods
  55
  56 =cut
  57
  58 1;