=encoding utf8

=for comment POD_DERIVED_INDEX_GENERATED
The following documentation is automatically generated.  Please do not edit
this file, but rather the original, inline with MooseX::Role::Validatable::Error
at lib/MooseX/Role/Validatable/Error.pm
(on the system that originally ran this).
If you do edit this file, and don't want your changes to be removed, make
sure you change the first line.

=cut

=head1 NAME

MooseX::Role::Validatable::Error - Base Error class for MooseX::Role::Validatable

=head1 SYNOPSIS

  use MooseX::Role::Validatable;

    my $error = MooseX::Role::Validatable::Error->new({
        message           => 'Internal debug message.',            # Required
        message_to_client => 'Client-facing message',              # Required
        details           => { field => 'duration' },            # Optional, Must be a HashRef
        set_by            => 'Source of the error',                # Required; MAY default to caller(1)
        severity          => 5,                                    # For ordering, bigger is worse. Defaults to 1.
        transient         => 1,                                    # Boolean, defaults to false
        alert             => 1,                                    # Boolean, defaults to false
        info_link         => 'https://example.com/',               # Client-facing URI for additional info on this error.
    });

=head1 DESCRIPTION

Represents an error in validation

=head1 ATTRIBUTES

=head2 message

A message which might help us figure out what is wrong.

=head2 details

An arbitrary optional HashRef to pass the error details.

=head2 message_to_client

A client-friendly string describing the error.

=head2 set_by

The source of the error.

=head2 severity

How bad is it that this happened?

=head2 transient

Is this something likely to resolve itself with a little time?

=head2 alert

Should someone be alerted when this condition triggers?

=head2 info_link

A URI for further explanation of the error.

=head2 info_text

Description of the info_link

=head2 as_html

=head2 code

Error code in string.

=head1 AUTHOR

Binary.com E<lt>fayland@binary.comE<gt>

=head1 COPYRIGHT

Copyright 2014- Binary.com

=head1 INHERITED METHODS

=over 4

=item L<Moose::Object>

L<BUILDALL|Moose::Object/BUILDALL>, L<BUILDARGS|Moose::Object/BUILDARGS>, L<DEMOLISHALL|Moose::Object/DEMOLISHALL>, L<DOES|Moose::Object/DOES>, L<does|Moose::Object/does>, L<dump|Moose::Object/dump>

=back

=head1 LICENSE

This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.

=head1 SEE ALSO

