File Coverage

lib/eBay/API/XML/Call/GetSuggestedCategories.pm
Criterion Covered Total %
statement 7 9 77.7
branch n/a
condition n/a
subroutine 3 3 100.0
pod n/a
total 10 12 83.3


line stmt bran cond sub pod time code
1             #!/usr/bin/perl
2              
3             package eBay::API::XML::Call::GetSuggestedCategories;
4              
5 1     1   2460 use strict;
  1         1  
  1         25  
6 1     1   4 use warnings;
  1         3  
  1         26  
7              
8             ##########################################################################
9             #
10             # Module: ............... eBay/API/XML
11             # File: ................. GetSuggestedCategories.pm
12             # Generated by: ......... genEBayApiDataTypes.pl
13             # Last Generated: ....... 08/24/2008 16:44
14             # API Release Number: ... 579
15             #
16             ##########################################################################
17              
18             =head1 NAME
19              
20             eBay::API::XML::Call::GetSuggestedCategories
21              
22             =head1 DESCRIPTION
23              
24              
25              
26             =head1 SYNOPSIS
27              
28             =cut
29              
30              
31             =head1 INHERITANCE
32              
33             eBay::API::XML::Call::GetSuggestedCategories inherits from the L class
34              
35             =cut
36              
37 1     1   46 use eBay::API::XML::BaseCall;
  0            
  0            
38             our @ISA = ("eBay::API::XML::BaseCall");
39              
40             use eBay::API::XML::Call::GetSuggestedCategories::GetSuggestedCategoriesRequestType;
41             use eBay::API::XML::Call::GetSuggestedCategories::GetSuggestedCategoriesResponseType;
42              
43              
44             =head1 Subroutines:
45              
46             =cut
47              
48             sub getApiCallName {
49             return 'GetSuggestedCategories';
50             }
51             sub getRequestDataTypeFullPackage {
52             return 'eBay::API::XML::Call::GetSuggestedCategories::GetSuggestedCategoriesRequestType';
53             }
54             sub getResponseDataTypeFullPackage {
55             return 'eBay::API::XML::Call::GetSuggestedCategories::GetSuggestedCategoriesResponseType';
56             }
57              
58             #
59             # input properties
60             #
61              
62             =head2 setQuery()
63              
64             Specifies the search string, consisting of one or
65             more words to search for in the listing title.
66             The words "and" and "or" are treated like any other
67             word.
68              
69             MaxLength: 350 (characters)
70              
71             RequiredInput: Yes
72             # Argument: 'xs:string'
73              
74             =cut
75            
76             sub setQuery {
77             my $self = shift;
78             my $sQuery = shift;
79             $self->getRequestDataType()->setQuery($sQuery);
80             }
81              
82              
83              
84             #
85             # output properties
86             #
87              
88             =head2 getCategoryCount()
89              
90             Indicates the number of categories in the array.
91              
92             Returned: Always
93             # Returns: 'xs:int'
94              
95             =cut
96            
97             sub getCategoryCount {
98             my $self = shift;
99             return $self->getResponseDataType()->getCategoryCount();
100             }
101              
102             =head2 getSuggestedCategoryArray()
103              
104             Contains the categories that contain listings
105             that match the query string in the request. The array
106             can have up to 10 categories. Not returned if no categories match
107             the query in the request.
108              
109             Returned: Conditionally
110             # Returns: 'ns:SuggestedCategoryArrayType'
111              
112             =cut
113            
114             sub getSuggestedCategoryArray {
115             my $self = shift;
116             return $self->getResponseDataType()->getSuggestedCategoryArray();
117             }
118              
119              
120              
121              
122              
123             1;