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::Exception;
  21
  22 use Exception::Class (
  23     'Koha::Exceptions::Hold' => {
  24         isa => 'Koha::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     'Koha::Exceptions::Hold::MissingPickupLocation' => {
  36         isa         => 'Koha::Exceptions::Hold',
  37         description => 'You must supply a pickup location when placing a hold'
  38     }
  39 );
  40
  41 sub full_message {
  42     my $self = shift;
  43
  44     my $msg = $self->message;
  45
  46     unless ( $msg) {
  47         if ( $self->isa('Koha::Exceptions::Hold::CannotSuspendFound') ) {
  48             $msg = sprintf("Found hold cannot be suspended. Status=%s", $self->status );
  49         }
  50     }
  51
  52     return $msg;
  53 }
  54
  55 =head1 NAME
  56
  57 Koha::Exceptions::Hold - Base class for Hold exceptions
  58
  59 =head1 Exceptions
  60
  61 =head2 Koha::Exceptions::Hold
  62
  63 Generic Hold exception
  64
  65 =head2 Koha::Exceptions::Hold::CannotSuspendFound
  66
  67 Exception to be used when suspension is requested on a found hold.
  68
  69 =head1 Class methods
  70
  71 =head2 full_message
  72
  73 Overloaded method for exception stringifying.
  74
  75 =cut
  76
  77 1;