File Coverage

lib/eBay/API/XML/Call/GetCategory2CS/GetCategory2CSRequestType.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::GetCategory2CS::GetCategory2CSRequestType;
4              
5 1     1   1559 use strict;
  1         1  
  1         33  
6 1     1   7 use warnings;
  1         3  
  1         32  
7              
8             ##########################################################################
9             #
10             # Module: ............... eBay/API/XML
11             # File: ................. GetCategory2CSRequestType.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::GetCategory2CS::GetCategory2CSRequestType
21              
22             =head1 DESCRIPTION
23              
24             Retrieves mappings between categories and characteristics sets that are available for an eBay site.
25             Retrieves all mappings or just those that match category IDs passed in the call.
26              
27              
28              
29             =head1 SYNOPSIS
30              
31             =cut
32              
33              
34             =head1 INHERITANCE
35              
36             eBay::API::XML::Call::GetCategory2CS::GetCategory2CSRequestType inherits from the L class
37              
38             =cut
39              
40 1     1   35 use eBay::API::XML::RequestDataType;
  0            
  0            
41             our @ISA = ("eBay::API::XML::RequestDataType");
42              
43              
44              
45             my @gaProperties = ( [ 'AttributeSystemVersion', 'xs:string', '', '', '' ]
46             , [ 'CategoryID', 'xs:string', '', '', '' ]
47             );
48             push @gaProperties, @{eBay::API::XML::RequestDataType::getPropertiesList()};
49              
50             my @gaAttributes = (
51             );
52             push @gaAttributes, @{eBay::API::XML::RequestDataType::getAttributesList()};
53              
54             =head1 Subroutines:
55              
56             =cut
57              
58             sub new {
59             my $classname = shift;
60             my %args = @_;
61             my $self = $classname->SUPER::new(%args);
62             return $self;
63             }
64              
65             sub isScalar {
66             return 0;
67             }
68              
69              
70              
71             =head2 setAttributeSystemVersion()
72              
73             A version of the mappings for the site.
74             Typically, an application passes the version value that was returned the last
75             time the application executed this call.
76             Filter that causes the call to return only the categories
77             for which the mappings have changed since the specified version.
78             If not specified, all category-to-characteristics set mappings are returned.
79             This value changes each time changes are made to the mappings.
80             The current version value is not necessarily greater than the previous
81             value. Therefore, when comparing versions, only compare whether the
82             value has changed.
83              
84             SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrGC2CS
85             Title: Retrieving Category-to-Meta-Data Mappings
86              
87             RequiredInput: No
88             # Argument: 'xs:string'
89              
90             =cut
91              
92             sub setAttributeSystemVersion {
93             my $self = shift;
94             $self->{'AttributeSystemVersion'} = shift
95             }
96              
97             =head2 getAttributeSystemVersion()
98              
99             # Returns: 'xs:string'
100              
101             =cut
102              
103             sub getAttributeSystemVersion {
104             my $self = shift;
105             return $self->{'AttributeSystemVersion'};
106             }
107              
108              
109             =head2 setCategoryID()
110              
111             ID of a category for which to retrieve mappings.
112             If not specified, the call
113             retrieves a map for all categories.
114              
115             MaxLength: 10
116              
117             RequiredInput: No
118             # Argument: 'xs:string'
119              
120             =cut
121              
122             sub setCategoryID {
123             my $self = shift;
124             $self->{'CategoryID'} = shift
125             }
126              
127             =head2 getCategoryID()
128              
129             # Returns: 'xs:string'
130              
131             =cut
132              
133             sub getCategoryID {
134             my $self = shift;
135             return $self->{'CategoryID'};
136             }
137              
138              
139              
140              
141              
142             ## Attribute and Property lists
143             sub getPropertiesList {
144             my $self = shift;
145             return \@gaProperties;
146             }
147              
148             sub getAttributesList {
149             my $self = shift;
150             return \@gaAttributes;
151             }
152              
153              
154              
155             1;