package Koha::Object::Error;

# This file is part of Koha.

#

# Koha is free software; you can redistribute it and/or modify it

# under the terms of the GNU General Public License as published by

# the Free Software Foundation; either version 3 of the License, or

# (at your option) any later version.

#

# Koha is distributed in the hope that it will be useful, but

# WITHOUT ANY WARRANTY; without even the implied warranty of

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

# GNU General Public License for more details.

#

# You should have received a copy of the GNU General Public License

# along with Koha; if not, see <http://www.gnu.org/licenses>.

use Modern::Perl;

use base qw(Class::Accessor);

use Koha::Exceptions;

__PACKAGE__->mk_ro_accessors(qw( error ));

=head1 NAME

Koha::Object::Error - Class encapsulating errors in Koha::Object-derived classes

=head1 SYNOPSIS

  my ($self, $params) = @_;

  push @{$self->{_errors}} = Koha::Object::Error->new($params);

=head1 API

=head2 Class methods

=head3 new

    my $error = Koha::Object::Error->new(

        {

            error => $some_error

        }

    );

Create a new Koha::Object::Error object.

=cut

sub new {

    my ( $class, $params ) = @_;

    my $error = $params->{error};

    Koha::Exceptions::MissingParameter->throw( "Mandatory parameter missing: 'error'" )

        unless $error;

    my $self = $class->SUPER::new(

        {

            error => $error

        }

    );

    return $self;

}

=head1 AUTHOR

Tomas Cohen Arazi, E<lt>tomascohen@theke.ioE<gt>

=cut

1;