File Coverage

lib/eBay/API/XML/DataType/AmountType.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::AmountType;
4              
5 1     1   1118 use strict;
  1         2  
  1         36  
6 1     1   4 use warnings;
  1         2  
  1         33  
7              
8             ##########################################################################
9             #
10             # Module: ............... eBay/API/XML
11             # File: ................. AmountType.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::AmountType
21              
22             =head1 DESCRIPTION
23              
24             Basic type for specifying monetary amounts. A double value (e.g.,
25             1.00 or 1.0) is meaningful as a monetary amount when accompanied by a
26             specification of the currency, in which case the value specifies
27             the amount in that currency. An AmountType expresses both the value
28             (a double) and the currency. Details such as prices, fees, costs,
29             and payments are specified as amount types.
30              
31              
32              
33             =head1 SYNOPSIS
34              
35             =cut
36              
37              
38             =head1 INHERITANCE
39              
40             eBay::API::XML::DataType::AmountType inherits from the L class
41              
42             =cut
43              
44 1     1   43 use eBay::API::XML::BaseDataType;
  0            
  0            
45             our @ISA = ("eBay::API::XML::BaseDataType");
46              
47             use eBay::API::XML::DataType::Enum::CurrencyCodeType;
48              
49              
50             my @gaProperties = ( [ 'content', 'xs:double', '', '', '' ]
51             );
52             push @gaProperties, @{eBay::API::XML::BaseDataType::getPropertiesList()};
53              
54             my @gaAttributes = ( [ 'currencyID', 'ns:CurrencyCodeType', ''
55             ,'eBay::API::XML::DataType::Enum::CurrencyCodeType', '' ]
56             );
57             push @gaAttributes, @{eBay::API::XML::BaseDataType::getAttributesList()};
58              
59             =head1 Subroutines:
60              
61             =cut
62              
63             sub new {
64             my $classname = shift;
65             my %args = @_;
66             my $self = $classname->SUPER::new(%args);
67             return $self;
68             }
69              
70             sub isScalar {
71             return 0;
72             }
73              
74              
75              
76             =head2 setValue()
77              
78             # Argument: 'xs:double'
79              
80             =cut
81              
82             sub setValue {
83             my $self = shift;
84             $self->{'content'} = shift
85             }
86              
87             =head2 getValue()
88              
89             # Returns: 'xs:double'
90              
91             =cut
92              
93             sub getValue {
94             my $self = shift;
95             return $self->{'content'};
96             }
97              
98              
99              
100              
101             =head2 setCurrencyID()
102              
103             Currency in which the monetary amount is specified.
104            
105             In the AddItem family of calls, the currency can be specified in
106             the Item.Currency field instead. If you do specify this attribute
107             in the AddItem family of calls,
108             the value must match the site currency (i.e., it must be the same as the
109             value in Item.Currency) unless otherwise stated.
110              
111             Calls: AddOrder
112             RequiredInput: Yes
113             Context: Order.Total
114              
115             Calls: SetShippingDiscountProfiles
116             RequiredInput: Conditionally
117              
118             Calls: RespondToBestOffer
119             ReviseCheckoutStatus
120             RequiredInput: No
121              
122             Calls: AddItem
123             RelistItem
124             ReviseItem
125             VerifyAddItem
126             RequiredInput: No
127             Returned: Always
128              
129             Calls: AddLiveAuctionItem
130             ReviseLiveAuctionItem
131             RequiredInput: No
132             Returned: Always
133              
134             Calls: GetAllBidders
135             GetStoreOptions
136             RequiredInput: Yes
137             Returned: Always
138              
139             Calls: RelistItem
140             RequiredInput: No
141              
142             Calls: AddTransactionConfirmationItem
143             RequiredInput: Yes
144              
145             Calls: SendInvoice
146             RequiredInput: No
147             ExcludeFromContext: ShippingInsuranceCost, ShippingServiceCost,
148             ShippingServiceAdditionalCost, SalesTaxAmount, InsuranceFee
149            
150              
151             # Argument: 'ns:CurrencyCodeType'
152              
153             =cut
154              
155             sub setCurrencyID {
156             my $self = shift;
157             $self->{'currencyID'} = shift
158             }
159              
160             =head2 getCurrencyID()
161              
162             Calls: GetBidderList
163             GetItemRecommendations
164             GetItemShipping
165             GetMyeBaySelling
166             Returned: Conditionally
167              
168             Calls: GetSellerList
169             Returned: Conditionally
170             Details: DetailLevel: ItemReturnDescription, ReturnAll
171              
172             Calls: GetItem
173             Returned: Conditionally
174             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
175              
176             Calls: GetMyeBayBuying
177             Returned: Conditionally
178             Details: DetailLevel: none, ReturnSummary, ReturnAll
179              
180             Calls: GetShippingDiscountProfiles
181             Returned: Conditionally
182              
183             Calls: Returned: Always
184             ExcludeFromContext: InternationalShippingServiceOption
185             ShippingServiceOptions
186             ShippingServiceSelected
187              
188              
189             Calls: GetBestOffers
190             Returned: Always
191             Details: DetailLevel: none, ReturnAll
192              
193             Calls: GetOrders
194             Returned: Always
195             Details: DetailLevel: none
196             ExcludeFromContext: InternationalShippingServiceOption
197             ShippingServiceOptions
198             ShippingServiceSelected
199              
200              
201             Calls: GetOrders
202             Returned: Conditionally
203             Details: DetailLevel: none
204             Context: InternationalShippingServiceOption
205             ShippingServiceOptions
206             ShippingServiceSelected
207              
208             Calls: GetSellerTransactions
209             Returned: Conditionally
210             Details: DetailLevel: none
211             Context: InternationalShippingServiceOption
212             ShippingServiceOptions
213             ShippingServiceSelected
214              
215             Calls: GetOrderTransactions
216             Returned: Conditionally
217             Details: DetailLevel: none, ItemReturnDescription, ReturnAll
218             Context: InternationalShippingServiceOption
219             ShippingServiceOptions
220             ShippingServiceSelected
221              
222             Calls: PlaceOffer
223             Returned: Always
224             Context: ConvertedCurrentPrice
225             CurrentPrice
226              
227             Calls: PlaceOffer
228             Returned: Conditionally
229             Context: MinimumToBid
230              
231             Calls: AddItem
232             RelistItem
233             ReviseItem
234             VerifyAddItem
235             RequiredInput: No
236             Returned: Always
237              
238             Calls: AddLiveAuctionItem
239             ReviseLiveAuctionItem
240             RequiredInput: No
241             Returned: Always
242              
243             Calls: GetAllBidders
244             GetStoreOptions
245             RequiredInput: Yes
246             Returned: Always
247              
248             # Returns: 'ns:CurrencyCodeType'
249              
250             =cut
251              
252             sub getCurrencyID {
253             my $self = shift;
254             return $self->{'currencyID'};
255             }
256              
257              
258              
259             ## Attribute and Property lists
260             sub getPropertiesList {
261             my $self = shift;
262             return \@gaProperties;
263             }
264              
265             sub getAttributesList {
266             my $self = shift;
267             return \@gaAttributes;
268             }
269              
270              
271              
272             1;