File Coverage

lib/eBay/API/XML/Call/GetHighBidders.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::GetHighBidders;
4              
5 1     1   2896 use strict;
  1         5  
  1         40  
6 1     1   5 use warnings;
  1         2  
  1         40  
7              
8             ##########################################################################
9             #
10             # Module: ............... eBay/API/XML
11             # File: ................. GetHighBidders.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::GetHighBidders
21              
22             =head1 DESCRIPTION
23              
24              
25              
26             =head1 SYNOPSIS
27              
28             =cut
29              
30              
31             =head1 INHERITANCE
32              
33             eBay::API::XML::Call::GetHighBidders inherits from the L class
34              
35             =cut
36              
37 1     1   53 use eBay::API::XML::BaseCall;
  0            
  0            
38             our @ISA = ("eBay::API::XML::BaseCall");
39              
40             use eBay::API::XML::Call::GetHighBidders::GetHighBiddersRequestType;
41             use eBay::API::XML::Call::GetHighBidders::GetHighBiddersResponseType;
42              
43              
44             =head1 Subroutines:
45              
46             =cut
47              
48             sub getApiCallName {
49             return 'GetHighBidders';
50             }
51             sub getRequestDataTypeFullPackage {
52             return 'eBay::API::XML::Call::GetHighBidders::GetHighBiddersRequestType';
53             }
54             sub getResponseDataTypeFullPackage {
55             return 'eBay::API::XML::Call::GetHighBidders::GetHighBiddersResponseType';
56             }
57              
58             #
59             # input properties
60             #
61              
62             =head2 setItemID()
63              
64             Unique item ID that identifies the Dutch auction listing for which to
65             retrieve a list of the high bidders.
66              
67             MaxLength: 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits)
68              
69             RequiredInput: Yes
70             # Argument: 'ns:ItemIDType'
71              
72             =cut
73            
74             sub setItemID {
75             my $self = shift;
76             my $pItemID = shift;
77             $self->getRequestDataType()->setItemID($pItemID);
78             }
79              
80              
81              
82             #
83             # output properties
84             #
85              
86             =head2 getBidArray()
87              
88             Contains a list of zero, one, or multiple OfferType objects. Each
89             OfferType object represents the data for one high bidder. See the schema
90             documentation for OfferType for details on its properties and their
91             meanings.
92              
93             Returned: Always
94             # Returns: 'ns:OfferArrayType'
95              
96             =cut
97            
98             sub getBidArray {
99             my $self = shift;
100             return $self->getResponseDataType()->getBidArray();
101             }
102              
103             =head2 getListingStatus()
104              
105             Specifies an active or ended listing's status in eBay's processing workflow.
106             If a listing ends with a sale (or sales), eBay needs to update the sale details
107             (e.g., winning bidder) and other information. This processing
108             can take several minutes. If you retrieve a sold item, use this listing status information
109             to determine whether eBay has finished processing the listing so that you can
110             be sure the winning bidder and other details are correct and complete.
111              
112             Returned: Always
113             # Returns: 'ns:ListingStatusCodeType'
114              
115             =cut
116            
117             sub getListingStatus {
118             my $self = shift;
119             return $self->getResponseDataType()->getListingStatus();
120             }
121              
122              
123              
124              
125              
126             1;