File Coverage

lib/eBay/API/XML/Call/GetBestOffers.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::GetBestOffers;
4              
5 1     1   2290 use strict;
  1         1  
  1         34  
6 1     1   91 use warnings;
  1         2  
  1         26  
7              
8             ##########################################################################
9             #
10             # Module: ............... eBay/API/XML
11             # File: ................. GetBestOffers.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::GetBestOffers
21              
22             =head1 DESCRIPTION
23              
24              
25              
26             =head1 SYNOPSIS
27              
28             =cut
29              
30              
31             =head1 INHERITANCE
32              
33             eBay::API::XML::Call::GetBestOffers inherits from the L class
34              
35             =cut
36              
37 1     1   33 use eBay::API::XML::BaseCall;
  0            
  0            
38             our @ISA = ("eBay::API::XML::BaseCall");
39              
40             use eBay::API::XML::Call::GetBestOffers::GetBestOffersRequestType;
41             use eBay::API::XML::Call::GetBestOffers::GetBestOffersResponseType;
42              
43              
44             =head1 Subroutines:
45              
46             =cut
47              
48             sub getApiCallName {
49             return 'GetBestOffers';
50             }
51             sub getRequestDataTypeFullPackage {
52             return 'eBay::API::XML::Call::GetBestOffers::GetBestOffersRequestType';
53             }
54             sub getResponseDataTypeFullPackage {
55             return 'eBay::API::XML::Call::GetBestOffers::GetBestOffersResponseType';
56             }
57              
58             #
59             # input properties
60             #
61              
62             =head2 setBestOfferID()
63              
64             Need not be specified by a buyer or a seller.
65             The BestOfferID is the specific Best Offer you want information about.
66             If you are the seller, you can get a list of all best offers
67             (according to BestOfferStatus) by omitting this field.
68              
69             RequiredInput: No
70             # Argument: 'ns:BestOfferIDType'
71              
72             =cut
73            
74             sub setBestOfferID {
75             my $self = shift;
76             my $pBestOfferID = shift;
77             $self->getRequestDataType()->setBestOfferID($pBestOfferID);
78             }
79              
80             =head2 setBestOfferStatus()
81              
82             A filter determining which Best Offers to return for an item. Active is the default.
83              
84             RequiredInput: No
85             OnlyTheseValues: All, Active
86             # Argument: 'ns:BestOfferStatusCodeType'
87              
88             =cut
89            
90             sub setBestOfferStatus {
91             my $self = shift;
92             my $sBestOfferStatus = shift;
93             $self->getRequestDataType()->setBestOfferStatus($sBestOfferStatus);
94             }
95              
96             =head2 setItemID()
97              
98             The item for which Best Offer information is to be returned.
99             If you are a buyer and you have a valid best offer,
100             then your best-offer information will be returned for the item you specify.
101              
102             MaxLength: 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits)
103              
104             RequiredInput: Yes
105             # Argument: 'ns:ItemIDType'
106              
107             =cut
108            
109             sub setItemID {
110             my $self = shift;
111             my $pItemID = shift;
112             $self->getRequestDataType()->setItemID($pItemID);
113             }
114              
115              
116              
117             #
118             # output properties
119             #
120              
121             =head2 getBestOfferArray()
122              
123             All best offers for the item according to the filter or
124             best offer id (or both) used in the input. The buyer and
125             seller messages are returned only if the detail level is
126             defined. Includes the buyer and seller message only if
127             detail level ReturnAll is used.
128             Only returned if best offers have been made.
129              
130             Returned: Always
131             Details: DetailLevel: none, ReturnAll
132             # Returns: 'ns:BestOfferArrayType'
133              
134             =cut
135            
136             sub getBestOfferArray {
137             my $self = shift;
138             return $self->getResponseDataType()->getBestOfferArray();
139             }
140              
141             =head2 getItem()
142              
143             The item for which Best Offers are being returned.
144             Only returned if best offers have been made.
145              
146             Returned: Always
147             Details: DetailLevel: none, ReturnAll
148             # Returns: 'ns:ItemType'
149              
150             =cut
151            
152             sub getItem {
153             my $self = shift;
154             return $self->getResponseDataType()->getItem();
155             }
156              
157              
158              
159              
160              
161             1;