File Coverage

lib/eBay/API/XML/DataType/HistogramEntryType.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::DataType::HistogramEntryType;
4              
5 1     1   1316 use strict;
  1         4  
  1         30  
6 1     1   6 use warnings;
  1         2  
  1         32  
7              
8             ##########################################################################
9             #
10             # Module: ............... eBay/API/XML
11             # File: ................. HistogramEntryType.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::DataType::HistogramEntryType
21              
22             =head1 DESCRIPTION
23              
24             A generic histogram entry type.
25              
26              
27              
28             =head1 SYNOPSIS
29              
30             =cut
31              
32              
33             =head1 INHERITANCE
34              
35             eBay::API::XML::DataType::HistogramEntryType inherits from the L class
36              
37             =cut
38              
39 1     1   41 use eBay::API::XML::BaseDataType;
  0            
  0            
40             our @ISA = ("eBay::API::XML::BaseDataType");
41              
42              
43              
44             my @gaProperties = ( [ 'Count', 'xs:int', '', '', '' ]
45             );
46             push @gaProperties, @{eBay::API::XML::BaseDataType::getPropertiesList()};
47              
48             my @gaAttributes = ( [ 'id', 'xs:string', '', '', '' ]
49             , [ 'name', 'xs:string', '', '', '' ]
50             );
51             push @gaAttributes, @{eBay::API::XML::BaseDataType::getAttributesList()};
52              
53             =head1 Subroutines:
54              
55             =cut
56              
57             sub new {
58             my $classname = shift;
59             my %args = @_;
60             my $self = $classname->SUPER::new(%args);
61             return $self;
62             }
63              
64             sub isScalar {
65             return 0;
66             }
67              
68              
69              
70             =head2 setCount()
71              
72             For GetProducts, the number of products found in the domain
73             (characteristic set or attribute set). If a product is mapped
74             to more than one domain, it will be counted separately for each
75             domain. (For example, if the same product can be found in both
76             Children's Books and Fiction Books, the count for both of these
77             domains will include that product.)
78             Furthermore, when a product is mapped to more than one domain,
79             Product.AttributeSetID only returns the most applicable domain,
80             as determined by eBay.
81              
82             # Argument: 'xs:int'
83              
84             =cut
85              
86             sub setCount {
87             my $self = shift;
88             $self->{'Count'} = shift
89             }
90              
91             =head2 getCount()
92              
93             Calls: GetProducts
94             Returned: Conditionally
95              
96             # Returns: 'xs:int'
97              
98             =cut
99              
100             sub getCount {
101             my $self = shift;
102             return $self->{'Count'};
103             }
104              
105              
106              
107              
108             =head2 setId()
109              
110             For GetProducts, this is the domain ID (attribute set ID or
111             characteristic set ID).
112              
113             # Argument: 'xs:string'
114              
115             =cut
116              
117             sub setId {
118             my $self = shift;
119             $self->{'id'} = shift
120             }
121              
122             =head2 getId()
123              
124             Calls: GetProducts
125             Returned: Conditionally
126              
127             # Returns: 'xs:string'
128              
129             =cut
130              
131             sub getId {
132             my $self = shift;
133             return $self->{'id'};
134             }
135              
136              
137             =head2 setName()
138              
139             For GetProducts, this is the domain name (attribute set name
140             or characteristic set name). A domain is like a high-level category.
141              
142             # Argument: 'xs:string'
143              
144             =cut
145              
146             sub setName {
147             my $self = shift;
148             $self->{'name'} = shift
149             }
150              
151             =head2 getName()
152              
153             Calls: GetProducts
154             Returned: Conditionally
155              
156             # Returns: 'xs:string'
157              
158             =cut
159              
160             sub getName {
161             my $self = shift;
162             return $self->{'name'};
163             }
164              
165              
166              
167             ## Attribute and Property lists
168             sub getPropertiesList {
169             my $self = shift;
170             return \@gaProperties;
171             }
172              
173             sub getAttributesList {
174             my $self = shift;
175             return \@gaAttributes;
176             }
177              
178              
179              
180             1;