File Coverage

lib/eBay/API/XML/Call/EndItem.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::EndItem;
4              
5 1     1   2281 use strict;
  1         1  
  1         32  
6 1     1   4 use warnings;
  1         2  
  1         37  
7              
8             ##########################################################################
9             #
10             # Module: ............... eBay/API/XML
11             # File: ................. EndItem.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::EndItem
21              
22             =head1 DESCRIPTION
23              
24              
25              
26             =head1 SYNOPSIS
27              
28             =cut
29              
30              
31             =head1 INHERITANCE
32              
33             eBay::API::XML::Call::EndItem inherits from the L class
34              
35             =cut
36              
37 1     1   38 use eBay::API::XML::BaseCall;
  0            
  0            
38             our @ISA = ("eBay::API::XML::BaseCall");
39              
40             use eBay::API::XML::Call::EndItem::EndItemRequestType;
41             use eBay::API::XML::Call::EndItem::EndItemResponseType;
42              
43              
44             =head1 Subroutines:
45              
46             =cut
47              
48             sub getApiCallName {
49             return 'EndItem';
50             }
51             sub getRequestDataTypeFullPackage {
52             return 'eBay::API::XML::Call::EndItem::EndItemRequestType';
53             }
54             sub getResponseDataTypeFullPackage {
55             return 'eBay::API::XML::Call::EndItem::EndItemResponseType';
56             }
57              
58             #
59             # input properties
60             #
61              
62             =head2 setEndingReason()
63              
64             Indicates the seller's reason for ending the listing early.
65             This field is required if the seller is ending the item early and
66             the item did not successfully sell.
67             Also applicable to Half.com.
68              
69             RequiredInput: Yes
70             # Argument: 'ns:EndReasonCodeType'
71              
72             =cut
73            
74             sub setEndingReason {
75             my $self = shift;
76             my $sEndingReason = shift;
77             $self->getRequestDataType()->setEndingReason($sEndingReason);
78             }
79              
80             =head2 setItemID()
81              
82             Unique item ID that identifies the item listing to end.
83             Also applicable to Half.com. For Half.com listings, you can either
84             specify ItemID or SellerInventoryID.
85             For eBay Live Auctions, you cannot delete items that have been closed
86             or that are part of a Live Auction event that has started.
87              
88             MaxLength: 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits)
89              
90             RequiredInput: Yes
91             # Argument: 'ns:ItemIDType'
92              
93             =cut
94            
95             sub setItemID {
96             my $self = shift;
97             my $pItemID = shift;
98             $self->getRequestDataType()->setItemID($pItemID);
99             }
100              
101             =head2 setSellerInventoryID()
102              
103             Unique identifier that the seller specified when they listed the
104             Half.com item. For Half.com items, you can either specify ItemID or
105             SellerInventoryID. If you specify both ItemID and SellerInventoryID,
106             they must be for the same item (otherwise an error will occur).
107             Only applicable to Half.com.
108              
109             RequiredInput: Conditionally
110             # Argument: 'xs:string'
111              
112             =cut
113            
114             sub setSellerInventoryID {
115             my $self = shift;
116             my $sSellerInventoryID = shift;
117             $self->getRequestDataType()->setSellerInventoryID($sSellerInventoryID);
118             }
119              
120              
121              
122             #
123             # output properties
124             #
125              
126             =head2 getEndTime()
127              
128             Indicates the date and time (returned in GMT) the specified item listing
129             was ended.
130             Also applicable to Half.com.
131              
132             Returned: Always
133             # Returns: 'xs:dateTime'
134              
135             =cut
136            
137             sub getEndTime {
138             my $self = shift;
139             return $self->getResponseDataType()->getEndTime();
140             }
141              
142              
143              
144              
145              
146             1;