/ 
Net-Amazon-0.62
River stage one • 3 direct dependents • 4 total dependents
/ Net::Amazon::Validate::ItemSearch

NAME

Net::Amazon::Validate::ItemSearch - Validate ItemSearch requests.

SYNOPSIS

Net::Amazon::Validate::ItemSearch;

my $valid   = Net::Amazon::Validate::ItemSearch::factory(search_index => 'Actor');
my $option  = $itemsearch_valid->user_or_default($input);
my $default = $itemsearch_valid->default();

DESCRIPTION

Net::Amazon::Validate::ItemSearch is a class used to verify ItemSearch operation based on the current version of the WSDL and locale. For example if an Artist search is executed the user can search against Classical, Merchants, or Music.

METHODS

factory(search_index => type)

Constructs a new Net::Amazon::Validate::ItemSearch object, used to validate user input for a SearchIndex. Valid types include Actor, Artist, AudienceRating, Author Brand, BrowseNode, City, Composer, Condition, Conductor, Count, Cuisine, DeliveryMethod, Director, ISPUPostalCode, ItemPage, Keywords, MPAARating, Manufacturer, MaximumPrice, MerchantId, MinimumPrice, MusicLabel, Neighborhood, Orchestra, Power, Publisher, Sort, TextStream and Title. Which departments these search indexes are valid for is dependent upon locale.

default()

Return the default value for a given SearchIndex. Default are determined in order of preference and existence from the following list: Books, Music, DVD, Software. If none of those items are valid for a given SearchIndex then the first valid department of said SearchIndex is used.

user_or_default( $input )

If user input is specified it validates the input, and return it, otherwise it returns the default value for the SearchIndex.

AUTHORS

Christopher Boumenot, <boumenot@gmail.com>

COPYRIGHT AND LICENSE

Copyright 2006 by Christopher Boumenot, <boumenot@gmail.com>

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

NAME

Net::Amazon::Validate::ItemSearch - Validate user supplied options against known valid options.

SYNOPSIS

use Net::Amazon::Validate::ItemSearch;

# ...

my $valid = Net::Amazon::Validate::ItemSearch::factory(search_index => 'Actor');
$valid->user_or_default($input);
$valid->default();

DESCRIPTION

METHODS

Asin()

The item's ASIN number.

Please check the subclasses of Net::Amazon::Validate for specialized methods.

TODO

I should probably add a function to dispatch calls automatically, that way the user doesn't have to explicity call a function to verify an option. It would make it very easy to write loops to validate input.

BUGS

This library was designed to validate ResponseGroup requests only. Support for other parameters were autogenerated but not verified. The biggest problems are with the intrepration of 'Integers 1 to 30', 'A Merchant ID', or 'Amazon (the default value)'.

AUTHOR

Christopher Boumenot, <boumenot@gmail.com>

COPYRIGHT AND LICENSE

Copyright 2006 by Christopher Boumenot <boumenot@gmail.com>

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.