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::CannotChangeHoldType' => {
  27         isa         => 'Koha::Exceptions::Hold',
  28         description => "Record cannot have both record and item level holds at the same time",
  29     },
  30     'Koha::Exceptions::Hold::CannotSuspendFound' => {
  31         isa         => 'Koha::Exceptions::Hold',
  32         description => "Found holds cannot be suspended",
  33         fields      =>  ['status']
  34     },
  35     'Koha::Exceptions::Hold::InvalidPickupLocation' => {
  36         isa         => 'Koha::Exceptions::Hold',
  37         description => 'The supplied pickup location is not valid'
  38     },
  39     'Koha::Exceptions::Hold::MissingPickupLocation' => {
  40         isa         => 'Koha::Exceptions::Hold',
  41         description => 'You must supply a pickup location when placing a hold'
  42     }
  43 );
  44
  45 sub full_message {
  46     my $self = shift;
  47
  48     my $msg = $self->message;
  49
  50     unless ( $msg) {
  51         if ( $self->isa('Koha::Exceptions::Hold::CannotSuspendFound') ) {
  52             $msg = sprintf("Found hold cannot be suspended. Status=%s", $self->status );
  53         }
  54     }
  55
  56     return $msg;
  57 }
  58
  59 =head1 NAME
  60
  61 Koha::Exceptions::Hold - Base class for Hold exceptions
  62
  63 =head1 Exceptions
  64
  65 =head2 Koha::Exceptions::Hold
  66
  67 Generic Hold exception
  68
  69 =head2 Koha::Exceptions::Hold::CannotSuspendFound
  70
  71 Exception to be used when suspension is requested on a found hold.
  72
  73 =head1 Class methods
  74
  75 =head2 full_message
  76
  77 Overloaded method for exception stringifying.
  78
  79 =cut
  80
  81 1;