File Coverage

lib/eBay/API/XML/Call/GetCart.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::GetCart;
4              
5 1     1   2288 use strict;
  1         1  
  1         25  
6 1     1   4 use warnings;
  1         3  
  1         25  
7              
8             ##########################################################################
9             #
10             # Module: ............... eBay/API/XML
11             # File: ................. GetCart.pm
12             # Generated by: ......... genEBayApiDataTypes.pl
13             # Last Generated: ....... 07/07/2008 17:42
14             # API Release Number: ... 571
15             #
16             ##########################################################################
17              
18             =head1 NAME
19              
20             eBay::API::XML::Call::GetCart
21              
22             =head1 DESCRIPTION
23              
24              
25              
26             =head1 SYNOPSIS
27              
28             =cut
29              
30              
31             =head1 INHERITANCE
32              
33             eBay::API::XML::Call::GetCart inherits from the L class
34              
35             =cut
36              
37 1     1   31 use eBay::API::XML::BaseCall;
  0            
  0            
38             our @ISA = ("eBay::API::XML::BaseCall");
39              
40             use eBay::API::XML::Call::GetCart::GetCartRequestType;
41             use eBay::API::XML::Call::GetCart::GetCartResponseType;
42              
43              
44             =head1 Subroutines:
45              
46             =cut
47              
48             sub getApiCallName {
49             return 'GetCart';
50             }
51             sub getRequestDataTypeFullPackage {
52             return 'eBay::API::XML::Call::GetCart::GetCartRequestType';
53             }
54             sub getResponseDataTypeFullPackage {
55             return 'eBay::API::XML::Call::GetCart::GetCartResponseType';
56             }
57              
58             #
59             # input properties
60             #
61              
62             =head2 setAffiliateTrackingDetails()
63              
64             Container for affiliate tags.
65             If you use affiliate tags, it is possible to get affiliate commissions
66             based on calls made by your application.
67             (See the eBay Partner Network
68             for information about commissions.)
69             Affiliate tags enable the tracking of user activity.
70             You can use child tags of AffiliateTrackingDetails if you want
71             call output to include a string, in
72             Item.ListingDetails.ViewItemURL, that includes
73             affiliate tracking information.
74             Affiliate details that you provide appear in the CheckoutURL that is returned by GetCart.
75             Child elements of this element that are marked as conditionally required are required
76             only if this container is present.
77              
78             SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AffiliateTrackingConcepts
79             Title: Affiliate Tracking Concepts
80              
81             RequiredInput: No
82             # Argument: 'ns:AffiliateTrackingDetailsType'
83              
84             =cut
85            
86             sub setAffiliateTrackingDetails {
87             my $self = shift;
88             my $pAffiliateTrackingDetails = shift;
89             $self->getRequestDataType()->setAffiliateTrackingDetails($pAffiliateTrackingDetails);
90             }
91              
92             =head2 setCartID()
93              
94             The ID of the shopping cart to inspect, obtained from a prior run of SetCart.
95              
96             RequiredInput: Yes
97             # Argument: 'xs:long'
98              
99             =cut
100            
101             sub setCartID {
102             my $self = shift;
103             my $sCartID = shift;
104             $self->getRequestDataType()->setCartID($sCartID);
105             }
106              
107             =head2 setShippingAddress()
108              
109             The country and postal code to which the items in the cart are to be shipped. Required only
110             if you want shipping costs calculated for those items for which calculated
111             shipping applies. Of no value if there are no items in the cart with calculated shipping.
112              
113             RequiredInput: No
114             # Argument: 'ns:AddressType'
115              
116             =cut
117            
118             sub setShippingAddress {
119             my $self = shift;
120             my $pShippingAddress = shift;
121             $self->getRequestDataType()->setShippingAddress($pShippingAddress);
122             }
123              
124              
125              
126             #
127             # output properties
128             #
129              
130             =head2 getCart()
131              
132             Overall cart details.
133              
134             Returned: Always
135             # Returns: 'ns:CartType'
136              
137             =cut
138            
139             sub getCart {
140             my $self = shift;
141             return $self->getResponseDataType()->getCart();
142             }
143              
144              
145              
146              
147              
148             1;