File Coverage

lib/eBay/API/XML/Call/VerifyAddItem/VerifyAddItemRequestType.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::VerifyAddItem::VerifyAddItemRequestType;
4              
5 1     1   1105 use strict;
  1         2  
  1         26  
6 1     1   5 use warnings;
  1         2  
  1         30  
7              
8             ##########################################################################
9             #
10             # Module: ............... eBay/API/XML
11             # File: ................. VerifyAddItemRequestType.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::VerifyAddItem::VerifyAddItemRequestType
21              
22             =head1 DESCRIPTION
23              
24             Enables a seller to specify the definition of a new
25             item and submit the definition to eBay without creating a
26             listing. This enables the seller to test
27             the item definition and get
28             listing fees before actually listing the item.
29             The listing fees may be different
30             from the listing fees returned by AddItem.
31            
32            
33             The call validates your input fields against the schema. However, some
34             business-logic checks performed for an AddItem call are not executed.
35             For more information, please see the following
36             Knowledge Base article:
37            
38            
39             VerifyAddItem returns Success with no Errors, but AddItem returns Failure with Errors
40            
41            
42             There are cases in which VerifyAddItem
43             behaves differently from AddItem and returns a different result.
44              
45              
46              
47             =head1 SYNOPSIS
48              
49             =cut
50              
51              
52             =head1 INHERITANCE
53              
54             eBay::API::XML::Call::VerifyAddItem::VerifyAddItemRequestType inherits from the L class
55              
56             =cut
57              
58 1     1   37 use eBay::API::XML::RequestDataType;
  0            
  0            
59             our @ISA = ("eBay::API::XML::RequestDataType");
60              
61             use eBay::API::XML::DataType::ExternalProductIDType;
62             use eBay::API::XML::DataType::ItemType;
63              
64              
65             my @gaProperties = ( [ 'ExternalProductID', 'ns:ExternalProductIDType', ''
66             ,'eBay::API::XML::DataType::ExternalProductIDType', '1' ]
67             , [ 'IncludeExpressRequirements', 'xs:boolean', '', '', '' ]
68             , [ 'Item', 'ns:ItemType', ''
69             ,'eBay::API::XML::DataType::ItemType', '1' ]
70             );
71             push @gaProperties, @{eBay::API::XML::RequestDataType::getPropertiesList()};
72              
73             my @gaAttributes = (
74             );
75             push @gaAttributes, @{eBay::API::XML::RequestDataType::getAttributesList()};
76              
77             =head1 Subroutines:
78              
79             =cut
80              
81             sub new {
82             my $classname = shift;
83             my %args = @_;
84             my $self = $classname->SUPER::new(%args);
85             return $self;
86             }
87              
88             sub isScalar {
89             return 0;
90             }
91              
92              
93              
94             =head2 setExternalProductID()
95              
96             Deprecated. This field will be removed from the schema
97             in a future release. Recommended usage as of release 439 varies for
98             eBay.com listings and Half.com listings.
99            

100             For eBay.com listings:
101             As of release 439, this field can still be passed in, but we recommend
102             that you update your applications to use the ExternalProductID field
103             defined on the item instead (i.e., Item.ExternalProductID). If you
104             specify both Item.ExternalProductID and this field in the same request,
105             eBay uses the value in Item.ExternalProductID and ignores the value in
106             this field. See Item.ExternalProductID for information on using an
107             external ID for eBay.com listings.
108            

109             For Half.com listings:
110             As of release 439, this field is required for Half.com listings.
111             Causes Half.com to list the item with Pre-filled Item Information based on
112             an ISBN value or other supported external ID, plus other meta-data that
113             you specify. See the eBay Web Services guide for information about
114             listing to Half.com.
115              
116             RequiredInput: Conditionally
117             # Argument: 'ns:ExternalProductIDType'
118              
119             =cut
120              
121             sub setExternalProductID {
122             my $self = shift;
123             $self->{'ExternalProductID'} = shift
124             }
125              
126             =head2 getExternalProductID()
127              
128             # Returns: 'ns:ExternalProductIDType'
129              
130             =cut
131              
132             sub getExternalProductID {
133             my $self = shift;
134             return $self->_getDataTypeInstance( 'ExternalProductID'
135             ,'eBay::API::XML::DataType::ExternalProductIDType');
136             }
137              
138              
139             =head2 setIncludeExpressRequirements()
140              
141             Indicates if the response should include detailed data relating to
142             whether an item would qualify as an Express listing. For
143             information about the Express-related data that can be returned
144             when IncludeExpressRequirements is set to true,
145             see the response of VerifyAddItem and see the
146             eBay Web Services Guide.
147              
148             Default: false
149             SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ExpressListingCriteria
150             Title: Listing Criteria for eBay Express
151              
152             RequiredInput: No
153             # Argument: 'xs:boolean'
154              
155             =cut
156              
157             sub setIncludeExpressRequirements {
158             my $self = shift;
159             $self->{'IncludeExpressRequirements'} = shift
160             }
161              
162             =head2 isIncludeExpressRequirements()
163              
164             # Returns: 'xs:boolean'
165              
166             =cut
167              
168             sub isIncludeExpressRequirements {
169             my $self = shift;
170             return $self->{'IncludeExpressRequirements'};
171             }
172              
173              
174             =head2 setItem()
175              
176             ItemType object, the properties of which define the new item listing.
177              
178             RequiredInput: Yes
179             # Argument: 'ns:ItemType'
180              
181             =cut
182              
183             sub setItem {
184             my $self = shift;
185             $self->{'Item'} = shift
186             }
187              
188             =head2 getItem()
189              
190             # Returns: 'ns:ItemType'
191              
192             =cut
193              
194             sub getItem {
195             my $self = shift;
196             return $self->_getDataTypeInstance( 'Item'
197             ,'eBay::API::XML::DataType::ItemType');
198             }
199              
200              
201              
202              
203              
204             ## Attribute and Property lists
205             sub getPropertiesList {
206             my $self = shift;
207             return \@gaProperties;
208             }
209              
210             sub getAttributesList {
211             my $self = shift;
212             return \@gaAttributes;
213             }
214              
215              
216              
217             1;