File Coverage

lib/eBay/API/XML/Call/GetProductSearchPage.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::GetProductSearchPage;
4              
5 1     1   2403 use strict;
  1         3  
  1         27  
6 1     1   4 use warnings;
  1         2  
  1         25  
7              
8             ##########################################################################
9             #
10             # Module: ............... eBay/API/XML
11             # File: ................. GetProductSearchPage.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::GetProductSearchPage
21              
22             =head1 DESCRIPTION
23              
24              
25              
26             =head1 SYNOPSIS
27              
28             =cut
29              
30              
31             =head1 INHERITANCE
32              
33             eBay::API::XML::Call::GetProductSearchPage inherits from the L class
34              
35             =cut
36              
37 1     1   32 use eBay::API::XML::BaseCall;
  0            
  0            
38             our @ISA = ("eBay::API::XML::BaseCall");
39              
40             use eBay::API::XML::Call::GetProductSearchPage::GetProductSearchPageRequestType;
41             use eBay::API::XML::Call::GetProductSearchPage::GetProductSearchPageResponseType;
42              
43              
44             =head1 Subroutines:
45              
46             =cut
47              
48             sub getApiCallName {
49             return 'GetProductSearchPage';
50             }
51             sub getRequestDataTypeFullPackage {
52             return 'eBay::API::XML::Call::GetProductSearchPage::GetProductSearchPageRequestType';
53             }
54             sub getResponseDataTypeFullPackage {
55             return 'eBay::API::XML::Call::GetProductSearchPage::GetProductSearchPageResponseType';
56             }
57              
58             #
59             # input properties
60             #
61              
62             =head2 setAttributeSetID()
63              
64             A characteristic set ID that is associated with a
65             catalog-enabled category that supports product search pages.
66             You can pass an array of these IDs in the request.
67             Each characteristic set corresponds to a level in the
68             eBay category hierarchy at which all items share common characteristics.
69             Multiple categories can be mapped to the same characteristic set.
70             Each ID is used as a filter to limit the response content to fewer
71             characteristic sets. When IDs are specified, the call only returns
72             search page data for the corresponding characteristic sets.
73             When no IDs are specified, the call returns all the current
74             search page data in the system.
75              
76             RequiredInput: No
77             # Argument: reference to an array
78             of 'xs:int'
79              
80             =cut
81            
82             sub setAttributeSetID {
83             my $self = shift;
84             my $sAttributeSetID = shift;
85             $self->getRequestDataType()->setAttributeSetID($sAttributeSetID);
86             }
87              
88             =head2 setAttributeSystemVersion()
89              
90             A version of the search page definitions for the site. Typically, an
91             application passes the version value that was returned the last time the
92             application executed this call. Filter that causes the call to return only
93             the search pages for which the attribute meta-data has changed since the
94             specified version. The latest version value is not necessarily greater
95             than the previous value that was returned. Therefore, when comparing
96             versions, only compare whether the value has changed.
97              
98             RequiredInput: No
99             # Argument: 'xs:string'
100              
101             =cut
102            
103             sub setAttributeSystemVersion {
104             my $self = shift;
105             my $sAttributeSystemVersion = shift;
106             $self->getRequestDataType()->setAttributeSystemVersion($sAttributeSystemVersion);
107             }
108              
109              
110              
111             #
112             # output properties
113             #
114              
115             =head2 getAttributeSystemVersion()
116              
117             Current version of the product search page data for the site.
118             This value changes each time changes are made to the search page data.
119             The current version value is not necessarily greater than the previous
120             value. Therefore, when comparing versions, only compare whether the
121             value has changed.
122              
123             Returned: Always
124             Details: DetailLevel: none, ReturnAll
125             # Returns: 'xs:string'
126              
127             =cut
128            
129             sub getAttributeSystemVersion {
130             my $self = shift;
131             return $self->getResponseDataType()->getAttributeSystemVersion();
132             }
133              
134             =head2 getProductSearchPage()
135              
136             A list of catalog search criteria and sort keys associated with a catalog-enabled category,
137             plus supplemental information to help the seller understand how to make selections.
138              
139             Returned: Always
140             Details: DetailLevel: ReturnAll
141             # Returns: reference to an array
142             of 'ns:ProductSearchPageType'
143              
144             =cut
145            
146             sub getProductSearchPage {
147             my $self = shift;
148             return $self->getResponseDataType()->getProductSearchPage();
149             }
150              
151              
152              
153              
154              
155             1;