Koha/Exceptions/Hold.pm

   1 package Koha::Exceptions::Hold;
   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::Exceptions::Exception;
  21
  22 use Exception::Class (
  23     'Koha::Exceptions::Hold' => {
  24         isa => 'Koha::Exceptions::Exception',
  25     },
  26     'Koha::Exceptions::Hold::CannotSuspendFound' => {
  27         isa         => 'Koha::Exceptions::Hold',
  28         description => "Found holds cannot be suspended",
  29         fields      =>  ['status']
  30     },
  31     'Koha::Exceptions::Hold::InvalidPickupLocation' => {
  32         isa         => 'Koha::Exceptions::Hold',
  33         description => 'The supplied pickup location is not valid'
  34     }
  35 );
  36
  37 sub full_message {
  38     my $self = shift;
  39
  40     my $msg = $self->message;
  41
  42     unless ( $msg) {
  43         if ( $self->isa('Koha::Exceptions::Hold::CannotSuspendFound') ) {
  44             $msg = sprintf("Found hold cannot be suspended. Status=%s", $self->status );
  45         }
  46     }
  47
  48     return $msg;
  49 }
  50
  51 =head1 NAME
  52
  53 Koha::Exceptions::Hold - Base class for Hold exceptions
  54
  55 =head1 Exceptions
  56
  57 =head2 Koha::Exceptions::Hold
  58
  59 Generic Hold exception
  60
  61 =head2 Koha::Exceptions::Hold::CannotSuspendFound
  62
  63 Exception to be used when suspension is requested on a found hold.
  64
  65 =head1 Class methods
  66
  67 =head2 full_message
  68
  69 Overloaded method for exception stringifying.
  70
  71 =cut
  72
  73 1;