File Coverage

blib/lib/Net/EPP/Frame/Response.pm

Criterion	Covered	Total	%
statement	6	34	17.6
branch	0	4	0.0
condition			n/a
subroutine	2	12	16.6
pod	2	9	22.2
total	10	59	16.9

package Net::EPP::Frame::Response;
use Net::EPP::ResponseCodes;
use base qw(Net::EPP::Frame);

=pod

=head1 NAME

Net::EPP::Frame::Response - an instance of L for server responses

=head1 DESCRIPTION

This module is a subclass of L that represents EPP server
responses.

Responses are sent back to clients when the server receives a
CcommandE> frame.

=head1 OBJECT HIERARCHY

    L
    +----L
        +----L
            +----L

=cut

sub new {
    my $package = shift;
    my $self    = $package->SUPER::new('response');
    return bless($self, $package);
}

sub _addExtraElements {
    my $self = shift;

    my $result = $self->createElement('result');
    $result->appendChild($self->createElement('msg'));
    $self->response->addChild($result);

    $self->result->setAttribute('code' => COMMAND_FAILED);

    $self->response->addChild($self->createElement('resData'));

    my $trID = $self->createElement('trID');
    $trID->addChild($self->createElement('clTRID'));
    $trID->addChild($self->createElement('svTRID'));
    $self->response->addChild($trID);

    return 1;
}

=pod

=head1 METHODS

	my $node = $frame->response;

This method returns the L object corresponding to the
CcommandE> element.

	my $node = $frame->result;

This method returns the L object corresponding to the
CresultE> element.

	my $node = $frame->resData;

This method returns the L object corresponding to the
CresDataE> element.

	my $node = $frame->trID;

This method returns the L object corresponding to the
CtrIDE> element.

	my $node = $frame->clTRID;

This method returns the L object corresponding to the
CclTRIDE> element.

	my $node = $frame->svTRID;

This method returns the L object corresponding to the
CsvTRIDE> element.

=cut

sub response { $_[0]->getNode('response') }
sub result   { $_[0]->getNode('result') }
sub resData  { $_[0]->getNode('resData') }
sub trID     { $_[0]->getNode('trID') }
sub clTRID   { $_[0]->getNode('clTRID') }
sub svTRID   { $_[0]->getNode('svTRID') }

=pod

	my $msg = $frame->code;

This method returns the code attribute of the CresultE>
element.

=cut

sub code {
    my $self   = shift;
    my $result = $self->result;
    if ($result) {
        return $result->getAttribute('code');
    }
    return COMMAND_FAILED;
}

=pod

	my $msg = $frame->msg;

This method returns a string containing the text content of the
CmsgE> element.

=cut

sub msg {
    my $self = shift;
    my $msgs = $self->getElementsByLocalName('msg');
    return $msgs->shift->textContent if ($msgs->size == 1);
}

1;