InfoSys::FreeDB::Response - FreeDB response

package InfoSys::FreeDB::Response;

use 5.006;
use base qw( Exporter );
use strict;
use warnings;
use AutoLoader qw(AUTOLOAD);
use Error qw(:try);
require Exporter;

our $CODE_RX = '^\s*(\d{3})\s+(.*)';

# Exporter variable
our %EXPORT_TAGS = (
    'line_parse' => [ qw(
        $CODE_RX
    ) ],
);

# Package version
our ($VERSION) = '$Revision: 0.92 $' =~ /\$Revision:\s+([^\s]+)/;

# Exporter variable
our @EXPORT = qw(
);

# Exporter variable
our @EXPORT_OK = qw(
    $CODE_RX
);

1;

__END__

sub new {
    my $class = shift;

    my $self = {};
    bless( $self, ( ref($class) || $class ) );
    return( $self->_initialize(@_) );
}

sub _initialize {
    my $self = shift;
    my $opt = defined($_[0]) ? shift : {};

    # Check $opt
    ref($opt) eq 'HASH' || throw Error::Simple("ERROR: InfoSys::FreeDB::Response::_initialize, first argument must be 'HASH' reference.");

    # code, SINGLE, mandatory
    exists( $opt->{code} ) || throw Error::Simple("ERROR: InfoSys::FreeDB::Response::_initialize, option 'code' is mandatory.");
    $self->set_code( $opt->{code} );

    # error, BOOLEAN
    exists( $opt->{error} ) && $self->set_error( $opt->{error} );

    # result, SINGLE, mandatory
    exists( $opt->{result} ) || throw Error::Simple("ERROR: InfoSys::FreeDB::Response::_initialize, option 'result' is mandatory.");
    $self->set_result( $opt->{result} );

    # Return $self
    return($self);
}

sub _value_is_allowed {
    return(1);
}

sub get_code {
    my $self = shift;

    return( $self->{InfoSys_FreeDB_Response}{code} );
}

sub get_result {
    my $self = shift;

    return( $self->{InfoSys_FreeDB_Response}{result} );
}

sub is_error {
    my $self = shift;

    if ( $self->{InfoSys_FreeDB_Response}{error} ) {
        return(1);
    }
    else {
        return(0);
    }
}

sub set_code {
    my $self = shift;
    my $val = shift;

    # Check if isa/ref/rx/value is allowed
    &_value_is_allowed( 'code', $val ) || throw Error::Simple("ERROR: InfoSys::FreeDB::Response::set_code, the specified value '$val' is not allowed.");

    # Assignment
    $self->{InfoSys_FreeDB_Response}{code} = $val;
}

sub set_error {
    my $self = shift;

    if (shift) {
        $self->{InfoSys_FreeDB_Response}{error} = 1;
    }
    else {
        $self->{InfoSys_FreeDB_Response}{error} = 0;
    }
}

sub set_result {
    my $self = shift;
    my $val = shift;

    # Check if isa/ref/rx/value is allowed
    &_value_is_allowed( 'result', $val ) || throw Error::Simple("ERROR: InfoSys::FreeDB::Response::set_result, the specified value '$val' is not allowed.");

    # Assignment
    $self->{InfoSys_FreeDB_Response}{result} = $val;
}