WWW::CNic::Response.3pm

Langue: en

Autres versions - même langue

Version: 2010-03-31 (ubuntu - 24/10/10)

Section: 3 (Bibliothèques de fonctions)

Sommaire

NAME

WWW::CNic::Response - base class for WWW::CNic response objects.

SYNOPSIS

         use WWW::CNic;
 
         my $query = WWW::CNic->new( OPTIONS );
 
         my $response = $query->execute();

DESCRIPTION

This is the base class for all response objects returned by WWW::CNic. Each query type returns a different object, all of which inherit their basic functionality from this module.

This module should never be accessed directly, only through its children.

METHODS

All the child classes of WWW::CNic::Response inherit the following methods: 
         $response->is_success();

This returns true if the transaction was completed successfully. If there was a server-side error due to invalid data or a system error, or there was an HTTP error this method will return undef.

         $response->is_error();

This is the converse of "is_success". It returns true if there was an error.

         $response->error();

This returns the error message generated, if any. This can be either a server-side error message or an HTTP error.

         $response->message();

This returns the message returned when the transaction was successful.

         $response->keys();

This returns an array containing all the keys returned by the server.

         $response->response($key);

This returns the value corresponding to $key as returned by the server. This may be a scalar, or a reference to an array or hash, depending on the context.

         $response->dump();

This prints a human-readable dump of the data stored in the object to "STDOUT". Mainly useful in debugging.

This module is (c) 2010 CentralNic Ltd. All rights reserved. This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

SEE ALSO

•
http://toolkit.centralnic.com/
•
WWW::CNic