File Coverage

lib/eBay/API/XML/Call/GetCategoryMappings.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::GetCategoryMappings;
4              
5 1     1   2340 use strict;
  1         3  
  1         32  
6 1     1   6 use warnings;
  1         2  
  1         33  
7              
8             ##########################################################################
9             #
10             # Module: ............... eBay/API/XML
11             # File: ................. GetCategoryMappings.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::GetCategoryMappings
21              
22             =head1 DESCRIPTION
23              
24              
25              
26             =head1 SYNOPSIS
27              
28             =cut
29              
30              
31             =head1 INHERITANCE
32              
33             eBay::API::XML::Call::GetCategoryMappings inherits from the L class
34              
35             =cut
36              
37 1     1   34 use eBay::API::XML::BaseCall;
  0            
  0            
38             our @ISA = ("eBay::API::XML::BaseCall");
39              
40             use eBay::API::XML::Call::GetCategoryMappings::GetCategoryMappingsRequestType;
41             use eBay::API::XML::Call::GetCategoryMappings::GetCategoryMappingsResponseType;
42              
43              
44             =head1 Subroutines:
45              
46             =cut
47              
48             sub getApiCallName {
49             return 'GetCategoryMappings';
50             }
51             sub getRequestDataTypeFullPackage {
52             return 'eBay::API::XML::Call::GetCategoryMappings::GetCategoryMappingsRequestType';
53             }
54             sub getResponseDataTypeFullPackage {
55             return 'eBay::API::XML::Call::GetCategoryMappings::GetCategoryMappingsResponseType';
56             }
57              
58             #
59             # input properties
60             #
61              
62             =head2 setCategoryVersion()
63              
64             A version of the category mapping for the site. Filters
65             out data from the call to return only the category
66             mappings for which the data has changed since the
67             specified version. If not specified, all category
68             mappings are returned. Typically, an application passes
69             the version value of the last set of category mappings
70             that the application stored locally. The latest version
71             value is not necessarily greater than the previous value
72             that was returned. Therefore, when comparing versions,
73             only compare whether the value has changed.
74              
75             RequiredInput: No
76             # Argument: 'xs:string'
77              
78             =cut
79            
80             sub setCategoryVersion {
81             my $self = shift;
82             my $sCategoryVersion = shift;
83             $self->getRequestDataType()->setCategoryVersion($sCategoryVersion);
84             }
85              
86              
87              
88             #
89             # output properties
90             #
91              
92             =head2 getCategoryMapping()
93              
94             Mapping between an old category ID and an active category ID. Returned when
95             category mappings exist and the value of CategoryVersion is different from
96             the current version on the site.
97              
98             Returned: Conditionally
99             Details: DetailLevel: ReturnAll
100             # Returns: reference to an array
101             of 'ns:CategoryMappingType'
102              
103             =cut
104            
105             sub getCategoryMapping {
106             my $self = shift;
107             return $self->getResponseDataType()->getCategoryMapping();
108             }
109              
110             =head2 getCategoryVersion()
111              
112             Version value assigned to the current category mapping data for the site.
113             Compare this value to the version value the application stored with the mappings
114             the last time the application executed the call. If the versions are the same,
115             the data has not changed since the last time the data was retrieved and stored.
116              
117             Returned: Always
118             Details: DetailLevel: none, ReturnAll
119             # Returns: 'xs:string'
120              
121             =cut
122            
123             sub getCategoryVersion {
124             my $self = shift;
125             return $self->getResponseDataType()->getCategoryVersion();
126             }
127              
128              
129              
130              
131              
132             1;