File Coverage

lib/eBay/API/XML/DataType/BiddingSummaryType.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::BiddingSummaryType;
4              
5 1     1   1139 use strict;
  1         2  
  1         26  
6 1     1   5 use warnings;
  1         2  
  1         24  
7              
8             ##########################################################################
9             #
10             # Module: ............... eBay/API/XML
11             # File: ................. BiddingSummaryType.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::BiddingSummaryType
21              
22             =head1 DESCRIPTION
23              
24             Contains bidding summary information for the bidder of an item.
25              
26              
27              
28             =head1 SYNOPSIS
29              
30             =cut
31              
32              
33             =head1 INHERITANCE
34              
35             eBay::API::XML::DataType::BiddingSummaryType inherits from the L class
36              
37             =cut
38              
39 1     1   32 use eBay::API::XML::BaseDataType;
  0            
  0            
40             our @ISA = ("eBay::API::XML::BaseDataType");
41              
42             use eBay::API::XML::DataType::ItemBidDetailsType;
43              
44              
45             my @gaProperties = ( [ 'BidActivityWithSeller', 'xs:int', '', '', '' ]
46             , [ 'BidRetractions', 'xs:int', '', '', '' ]
47             , [ 'BidsToUniqueCategories', 'xs:int', '', '', '' ]
48             , [ 'BidsToUniqueSellers', 'xs:int', '', '', '' ]
49             , [ 'ItemBidDetails', 'ns:ItemBidDetailsType', '1'
50             ,'eBay::API::XML::DataType::ItemBidDetailsType', '1' ]
51             , [ 'SummaryDays', 'xs:int', '', '', '' ]
52             , [ 'TotalBids', 'xs:int', '', '', '' ]
53             );
54             push @gaProperties, @{eBay::API::XML::BaseDataType::getPropertiesList()};
55              
56             my @gaAttributes = (
57             );
58             push @gaAttributes, @{eBay::API::XML::BaseDataType::getAttributesList()};
59              
60             =head1 Subroutines:
61              
62             =cut
63              
64             sub new {
65             my $classname = shift;
66             my %args = @_;
67             my $self = $classname->SUPER::new(%args);
68             return $self;
69             }
70              
71             sub isScalar {
72             return 0;
73             }
74              
75              
76              
77             =head2 setBidActivityWithSeller()
78              
79             Percentage of the bidder's total bids that the bidder
80             placed on items that the seller is offering.
81              
82             # Argument: 'xs:int'
83              
84             =cut
85              
86             sub setBidActivityWithSeller {
87             my $self = shift;
88             $self->{'BidActivityWithSeller'} = shift
89             }
90              
91             =head2 getBidActivityWithSeller()
92              
93             Calls: GetAllBidders
94             Returned: Conditionally
95              
96             # Returns: 'xs:int'
97              
98             =cut
99              
100             sub getBidActivityWithSeller {
101             my $self = shift;
102             return $self->{'BidActivityWithSeller'};
103             }
104              
105              
106             =head2 setBidRetractions()
107              
108             The total number of bids that the bidder has retracted.
109              
110             # Argument: 'xs:int'
111              
112             =cut
113              
114             sub setBidRetractions {
115             my $self = shift;
116             $self->{'BidRetractions'} = shift
117             }
118              
119             =head2 getBidRetractions()
120              
121             Calls: GetAllBidders
122             Returned: Conditionally
123              
124             # Returns: 'xs:int'
125              
126             =cut
127              
128             sub getBidRetractions {
129             my $self = shift;
130             return $self->{'BidRetractions'};
131             }
132              
133              
134             =head2 setBidsToUniqueCategories()
135              
136             For items that the bidder has bid on, the number of unique
137             categories that they belong to.
138              
139             # Argument: 'xs:int'
140              
141             =cut
142              
143             sub setBidsToUniqueCategories {
144             my $self = shift;
145             $self->{'BidsToUniqueCategories'} = shift
146             }
147              
148             =head2 getBidsToUniqueCategories()
149              
150             Calls: GetAllBidders
151             Returned: Conditionally
152              
153             # Returns: 'xs:int'
154              
155             =cut
156              
157             sub getBidsToUniqueCategories {
158             my $self = shift;
159             return $self->{'BidsToUniqueCategories'};
160             }
161              
162              
163             =head2 setBidsToUniqueSellers()
164              
165             Number of unique sellers whose items the bidder has placed
166             bids on.
167              
168             # Argument: 'xs:int'
169              
170             =cut
171              
172             sub setBidsToUniqueSellers {
173             my $self = shift;
174             $self->{'BidsToUniqueSellers'} = shift
175             }
176              
177             =head2 getBidsToUniqueSellers()
178              
179             Calls: GetAllBidders
180             Returned: Conditionally
181              
182             # Returns: 'xs:int'
183              
184             =cut
185              
186             sub getBidsToUniqueSellers {
187             my $self = shift;
188             return $self->{'BidsToUniqueSellers'};
189             }
190              
191              
192             =head2 setItemBidDetails()
193              
194             Detail bidding information on the items that the bidder has
195             bid on.
196              
197             # Argument: reference to an array
198             of 'ns:ItemBidDetailsType'
199              
200             =cut
201              
202             sub setItemBidDetails {
203             my $self = shift;
204             $self->{'ItemBidDetails'} =
205             $self->convertArray_To_RefToArrayIfNeeded(@_);
206             }
207              
208             =head2 getItemBidDetails()
209              
210             Calls: GetAllBidders
211             Returned: Conditionally
212              
213             # Returns: reference to an array
214             of 'ns:ItemBidDetailsType'
215              
216             =cut
217              
218             sub getItemBidDetails {
219             my $self = shift;
220             return $self->_getDataTypeArray('ItemBidDetails');
221             }
222              
223              
224             =head2 setSummaryDays()
225              
226             The number of days included in the summary. Currently always
227             set to 30 days.
228              
229             # Argument: 'xs:int'
230              
231             =cut
232              
233             sub setSummaryDays {
234             my $self = shift;
235             $self->{'SummaryDays'} = shift
236             }
237              
238             =head2 getSummaryDays()
239              
240             Calls: GetAllBidders
241             Returned: Conditionally
242              
243             # Returns: 'xs:int'
244              
245             =cut
246              
247             sub getSummaryDays {
248             my $self = shift;
249             return $self->{'SummaryDays'};
250             }
251              
252              
253             =head2 setTotalBids()
254              
255             The total number of bids that the bidder has placed.
256              
257             # Argument: 'xs:int'
258              
259             =cut
260              
261             sub setTotalBids {
262             my $self = shift;
263             $self->{'TotalBids'} = shift
264             }
265              
266             =head2 getTotalBids()
267              
268             Calls: GetAllBidders
269             Returned: Conditionally
270              
271             # Returns: 'xs:int'
272              
273             =cut
274              
275             sub getTotalBids {
276             my $self = shift;
277             return $self->{'TotalBids'};
278             }
279              
280              
281              
282              
283              
284             ## Attribute and Property lists
285             sub getPropertiesList {
286             my $self = shift;
287             return \@gaProperties;
288             }
289              
290             sub getAttributesList {
291             my $self = shift;
292             return \@gaAttributes;
293             }
294              
295              
296              
297             1;