Nicholas Perez > POE-Filter-XML-RPC-0.04 > POE::Filter::XML::RPC::Fault

Download:
POE-Filter-XML-RPC-0.04.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  0
View/Report Bugs
Module Version: 0.04   Source  

NAME ^

POE::Filter::XML::RPC::Fault - A XMLRPC Fault abstraction

SYNOPSIS ^

    use 5.010;
    use POE::Filter::XML::RPC::Fault;

    my $fault = POE::Filter::XML::RPC::Fault->new(503, 'Fail text here');

    say $fault->code(); # 503
    say $fault->string(); # Fail text here

DESCRIPTION ^

POE::Filter::XML::RPC::Fault provides a convient object for representing faults within XMLRPC without having to construct them manually.

PUBLIC METHODS ^

new()

new() accepts two arguments, one, the integer code value for the fault, and two, a string explaining the fault. Both arguments are required.

code()

code() returns the integer value for the particular Fault. Takes no arguments.

string()

string() returns the string value for the particular Fault. Takes no arguments.

NOTES ^

Fault is actually a subclass of POE::Filter::XML::Node and so all of its methods, including XML::LibXML::Element's, are available for use. This could ultimately be useful to avoid marshalling all of the data out of the Node and instead apply an XPATH expression to target specifically what is desired deep within a nested structure.

AUTHOR ^

Copyright 2009 Nicholas Perez. Licensed and distributed under the GPL.

syntax highlighting: