.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .el \{\ . de IX .. .\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Net::Amazon::Validate::ItemSearch 3pm" .TH Net::Amazon::Validate::ItemSearch 3pm "2009-09-15" "perl v5.14.2" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Net::Amazon::Validate::ItemSearch \- Validate ItemSearch requests. .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& Net::Amazon::Validate::ItemSearch; \& \& my $valid = Net::Amazon::Validate::ItemSearch::factory(search_index => \*(AqActor\*(Aq); \& my $option = $itemsearch_valid\->user_or_default($input); \& my $default = $itemsearch_valid\->default(); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\f(CW\*(C`Net::Amazon::Validate::ItemSearch\*(C'\fR is a class used to verify ItemSearch operation based on the current version of the \s-1WSDL\s0 and locale. For example if an Artist search is executed the user can search against Classical, Merchants, or Music. .SS "\s-1METHODS\s0" .IX Subsection "METHODS" .IP "factory(search_index => type)" 4 .IX Item "factory(search_index => type)" Constructs a new \f(CW\*(C`Net::Amazon::Validate::ItemSearch\*(C'\fR 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. .IP "\fIdefault()\fR" 4 .IX Item "default()" Return the default value for a given SearchIndex. Default are determined in order of preference and existence from the following list: Books, Music, \s-1DVD\s0, Software. If none of those items are valid for a given SearchIndex then the first valid department of said SearchIndex is used. .ie n .IP "user_or_default( $input )" 4 .el .IP "user_or_default( \f(CW$input\fR )" 4 .IX Item "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. .SH "AUTHORS" .IX Header "AUTHORS" Christopher Boumenot, .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" Copyright 2006 by Christopher Boumenot, .PP This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself. .SH "NAME" Net::Amazon::Validate::ItemSearch \- Validate user supplied options against known valid options. .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use Net::Amazon::Validate::ItemSearch; \& \& # ... \& \& my $valid = Net::Amazon::Validate::ItemSearch::factory(search_index => \*(AqActor\*(Aq); \& $valid\->user_or_default($input); \& $valid\->default(); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" .SS "\s-1METHODS\s0" .IX Subsection "METHODS" .IP "\fIAsin()\fR" 4 .IX Item "Asin()" The item's \s-1ASIN\s0 number. .PP Please check the subclasses of \f(CW\*(C`Net::Amazon::Validate\*(C'\fR for specialized methods. .SH "TODO" .IX Header "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. .SH "BUGS" .IX Header "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 \s-1ID\s0', or 'Amazon (the default value)'. .SH "AUTHOR" .IX Header "AUTHOR" Christopher Boumenot, .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" Copyright 2006 by Christopher Boumenot .PP This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.