Koha/Checkouts/ReturnClaim.pm

   1 package Koha::Checkouts::ReturnClaim;
   2
   3 # Copyright ByWater Solutions 2019
   4 #
   5 # This file is part of Koha.
   6 #
   7 # Koha is free software; you can redistribute it and/or modify it under the
   8 # terms of the GNU General Public License as published by the Free Software
   9 # Foundation; either version 3 of the License, or (at your option) any later
  10 # version.
  11 #
  12 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
  13 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  14 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License along
  17 # with Koha; if not, write to the Free Software Foundation, Inc.,
  18 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  19
  20 use Modern::Perl;
  21
  22 use base qw(Koha::Object);
  23
  24 use Koha::Checkouts;
  25 use Koha::Exceptions::Checkouts::ReturnClaims;
  26 use Koha::Old::Checkouts;
  27 use Koha::Patrons;
  28
  29 =head1 NAME
  30
  31 Koha::Checkouts::ReturnClaim - Koha ReturnClaim object class
  32
  33 =head1 API
  34
  35 =head2 Class methods
  36
  37 =cut
  38
  39 =head3 store
  40
  41     my $return_claim = Koha::Checkout::ReturnClaim->new($args)->store;
  42
  43 Overloaded I<store> method that validates the attributes and raises relevant
  44 exceptions as needed.
  45
  46 =cut
  47
  48 sub store {
  49     my ( $self ) = @_;
  50
  51     unless ( $self->created_by ) {
  52         Koha::Exceptions::Checkouts::ReturnClaims::NoCreatedBy->throw();
  53     }
  54
  55     return $self->SUPER::store;
  56 }
  57
  58 =head3 checkout
  59
  60 =cut
  61
  62 sub checkout {
  63     my ($self) = @_;
  64
  65     my $checkout = Koha::Checkouts->find( $self->issue_id )
  66       || Koha::Old::Checkouts->find( $self->issue_id );
  67
  68     return $checkout;
  69 }
  70
  71 =head3 patron
  72
  73 =cut
  74
  75 sub patron {
  76     my ( $self ) = @_;
  77
  78     my $borrower = $self->_result->borrowernumber;
  79     return Koha::Patron->_new_from_dbic( $borrower ) if $borrower;
  80 }
  81
  82 =head3 to_api_mapping
  83
  84 This method returns the mapping for representing a Koha::Checkouts::ReturnClaim object
  85 on the API.
  86
  87 =cut
  88
  89 sub to_api_mapping {
  90     return {
  91         id             => 'claim_id',
  92         itemnumber     => 'item_id',
  93         borrowernumber => 'patron_id',
  94     };
  95 }
  96
  97 =head2 Internal methods
  98
  99 =head3 _type
 100
 101 =cut
 102
 103 sub _type {
 104     return 'ReturnClaim';
 105 }
 106
 107 =head1 AUTHOR
 108
 109 Kyle M Hall <kyle@bywatersolutions.com>
 110
 111 =cut
 112
 113 1;