www::cnic::ng(3pm) [debian man page]

WWW::CNic::NG(3pm)					User Contributed Perl Documentation					WWW::CNic::NG(3pm)

NAME

       WWW::CNic::NG - a next generation interface to "WWW:CNic".

USAGE

	       #!/usr/bin/perl
	       use WWW::CNic::NG;
	       use strict;

	       my $cnic = WWW::CNic::NG->new(
		       'username'      => 'H12345',
		       'password'      => 'password',
		       'test'	       => 1, # run against the test database
	       );

	       # $response is a WWW::CNic::Response submodule:
	       my $response = $cnic->whois('domain' => 'example.uk.com');

SYNOPSIS

       "WWW::CNIC::NG" provides a simpler and more consistent interface to the "WWW::CNIC" module. It allows you to reuse the same object for
       multiple API calls, and provides Toolkit commands as methods of the object.

Executing Toolkit Commands
       If you have used "WWW:CNic" you will be familiar with using it like so:

	       my $query = WWW::CNic->new(
		       'command'       => 'whois',
		       'username'      => 'H12345',
		       'password'      => 'password',
		       'domain'        => 'example.uk.com',
	       );

	       $query->set(%more_params);

	       # $response is a WWW::CNic::Response submodule:
	       my $response = $query->execute;

       This is somewhat cumbersome compared to the earlier example.  "WWW::CNIC::NG" serves to tidy up some of this mess.

       Instead of specifying the desired command as a parameter supplied to the constructor, you simply call the method you want to use on the
       "WWW::CNIC::NG" object. The method's parameters are then used to prepare a query, and the response from the server is returned from the
       method.

COPYRIGHT

       This module is (c) 2011 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

       o   http://toolkit.centralnic.com/

       o   WWW::CNic::Cookbook

       o   WWW::CNic::Simple

perl v5.12.3							    2011-05-13							WWW::CNic::NG(3pm)

WWW::CNic::Response(3pm)				User Contributed Perl Documentation				  WWW::CNic::Response(3pm)

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.

COPYRIGHT

       This module is (c) 2011 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

       o   http://toolkit.centralnic.com/

       o   WWW::CNic

perl v5.12.3							    2011-05-13						  WWW::CNic::Response(3pm)