File Coverage

lib/eBay/API/XML/DataType/CrossPromotionPreferencesType.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::CrossPromotionPreferencesType;
4              
5 1     1   1359 use strict;
  1         2  
  1         36  
6 1     1   6 use warnings;
  1         2  
  1         33  
7              
8             ##########################################################################
9             #
10             # Module: ............... eBay/API/XML
11             # File: ................. CrossPromotionPreferencesType.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::CrossPromotionPreferencesType
21              
22             =head1 DESCRIPTION
23              
24             Contains preferences describing how items similar to the one the user is
25             presently viewing are promoted.
26              
27              
28              
29             =head1 SYNOPSIS
30              
31             =cut
32              
33              
34             =head1 INHERITANCE
35              
36             eBay::API::XML::DataType::CrossPromotionPreferencesType inherits from the L class
37              
38             =cut
39              
40 1     1   79 use eBay::API::XML::BaseDataType;
  0            
  0            
41             our @ISA = ("eBay::API::XML::BaseDataType");
42              
43             use eBay::API::XML::DataType::Enum::GallerySortFilterCodeType;
44             use eBay::API::XML::DataType::Enum::ItemFormatSortFilterCodeType;
45             use eBay::API::XML::DataType::Enum::ItemSortFilterCodeType;
46              
47              
48             my @gaProperties = ( [ 'CrossPromotionEnabled', 'xs:boolean', '', '', '' ]
49             , [ 'CrossSellGallerySortFilter', 'ns:GallerySortFilterCodeType', ''
50             ,'eBay::API::XML::DataType::Enum::GallerySortFilterCodeType', '' ]
51             , [ 'CrossSellItemFormatSortFilter', 'ns:ItemFormatSortFilterCodeType', ''
52             ,'eBay::API::XML::DataType::Enum::ItemFormatSortFilterCodeType', '' ]
53             , [ 'CrossSellItemSortFilter', 'ns:ItemSortFilterCodeType', ''
54             ,'eBay::API::XML::DataType::Enum::ItemSortFilterCodeType', '' ]
55             , [ 'UpSellGallerySortFilter', 'ns:GallerySortFilterCodeType', ''
56             ,'eBay::API::XML::DataType::Enum::GallerySortFilterCodeType', '' ]
57             , [ 'UpSellItemFormatSortFilter', 'ns:ItemFormatSortFilterCodeType', ''
58             ,'eBay::API::XML::DataType::Enum::ItemFormatSortFilterCodeType', '' ]
59             , [ 'UpSellItemSortFilter', 'ns:ItemSortFilterCodeType', ''
60             ,'eBay::API::XML::DataType::Enum::ItemSortFilterCodeType', '' ]
61             );
62             push @gaProperties, @{eBay::API::XML::BaseDataType::getPropertiesList()};
63              
64             my @gaAttributes = (
65             );
66             push @gaAttributes, @{eBay::API::XML::BaseDataType::getAttributesList()};
67              
68             =head1 Subroutines:
69              
70             =cut
71              
72             sub new {
73             my $classname = shift;
74             my %args = @_;
75             my $self = $classname->SUPER::new(%args);
76             return $self;
77             }
78              
79             sub isScalar {
80             return 0;
81             }
82              
83              
84              
85             =head2 setCrossPromotionEnabled()
86              
87             (For eBay store owners only)
88             Specifies whether cross-promotions are enabled for the seller's listings.
89              
90             Calls: SetUserPreferences
91             RequiredInput: No
92              
93             # Argument: 'xs:boolean'
94              
95             =cut
96              
97             sub setCrossPromotionEnabled {
98             my $self = shift;
99             $self->{'CrossPromotionEnabled'} = shift
100             }
101              
102             =head2 isCrossPromotionEnabled()
103              
104             Calls: GetUserPreferences
105             Returned: Conditionally
106              
107             # Returns: 'xs:boolean'
108              
109             =cut
110              
111             sub isCrossPromotionEnabled {
112             my $self = shift;
113             return $self->{'CrossPromotionEnabled'};
114             }
115              
116              
117             =head2 setCrossSellGallerySortFilter()
118              
119             (For eBay store owners only) Specifies whether to display only items with
120             gallery images and whether they should precede other items in cross-sell
121             promotions.
122              
123             Calls: SetUserPreferences
124             RequiredInput: No
125              
126             # Argument: 'ns:GallerySortFilterCodeType'
127              
128             =cut
129              
130             sub setCrossSellGallerySortFilter {
131             my $self = shift;
132             $self->{'CrossSellGallerySortFilter'} = shift
133             }
134              
135             =head2 getCrossSellGallerySortFilter()
136              
137             Calls: GetUserPreferences
138             Returned: Conditionally
139              
140             # Returns: 'ns:GallerySortFilterCodeType'
141              
142             =cut
143              
144             sub getCrossSellGallerySortFilter {
145             my $self = shift;
146             return $self->{'CrossSellGallerySortFilter'};
147             }
148              
149              
150             =head2 setCrossSellItemFormatSortFilter()
151              
152             (For eBay store owners only) Specifies which items should be shown
153             in cross-sell promotions (such as Buy It Now or Store Inventory items) and
154             in which sequence.
155              
156             Calls: SetUserPreferences
157             RequiredInput: No
158              
159             # Argument: 'ns:ItemFormatSortFilterCodeType'
160              
161             =cut
162              
163             sub setCrossSellItemFormatSortFilter {
164             my $self = shift;
165             $self->{'CrossSellItemFormatSortFilter'} = shift
166             }
167              
168             =head2 getCrossSellItemFormatSortFilter()
169              
170             Calls: GetUserPreferences
171             Returned: Conditionally
172              
173             # Returns: 'ns:ItemFormatSortFilterCodeType'
174              
175             =cut
176              
177             sub getCrossSellItemFormatSortFilter {
178             my $self = shift;
179             return $self->{'CrossSellItemFormatSortFilter'};
180             }
181              
182              
183             =head2 setCrossSellItemSortFilter()
184              
185             (For eBay store owners only) Specifies how to sort items displayed in
186             a cross-sell promotion.
187              
188             Calls: SetUserPreferences
189             RequiredInput: No
190              
191             # Argument: 'ns:ItemSortFilterCodeType'
192              
193             =cut
194              
195             sub setCrossSellItemSortFilter {
196             my $self = shift;
197             $self->{'CrossSellItemSortFilter'} = shift
198             }
199              
200             =head2 getCrossSellItemSortFilter()
201              
202             Calls: GetUserPreferences
203             Returned: Conditionally
204              
205             # Returns: 'ns:ItemSortFilterCodeType'
206              
207             =cut
208              
209             sub getCrossSellItemSortFilter {
210             my $self = shift;
211             return $self->{'CrossSellItemSortFilter'};
212             }
213              
214              
215             =head2 setUpSellGallerySortFilter()
216              
217             (For eBay store owners only) Specifies whether to display only items with
218             gallery images in upsell promotions and whether they should precede other items.
219              
220             Calls: SetUserPreferences
221             RequiredInput: No
222              
223             # Argument: 'ns:GallerySortFilterCodeType'
224              
225             =cut
226              
227             sub setUpSellGallerySortFilter {
228             my $self = shift;
229             $self->{'UpSellGallerySortFilter'} = shift
230             }
231              
232             =head2 getUpSellGallerySortFilter()
233              
234             Calls: GetUserPreferences
235             Returned: Conditionally
236              
237             # Returns: 'ns:GallerySortFilterCodeType'
238              
239             =cut
240              
241             sub getUpSellGallerySortFilter {
242             my $self = shift;
243             return $self->{'UpSellGallerySortFilter'};
244             }
245              
246              
247             =head2 setUpSellItemFormatSortFilter()
248              
249             (For eBay store owners only) Specifies which items (such as Buy It Now or
250             Store Inventory items) should be shown in upsell promotions and in which
251             sequence.
252              
253             Calls: SetUserPreferences
254             RequiredInput: No
255              
256             # Argument: 'ns:ItemFormatSortFilterCodeType'
257              
258             =cut
259              
260             sub setUpSellItemFormatSortFilter {
261             my $self = shift;
262             $self->{'UpSellItemFormatSortFilter'} = shift
263             }
264              
265             =head2 getUpSellItemFormatSortFilter()
266              
267             Calls: GetUserPreferences
268             Returned: Conditionally
269              
270             # Returns: 'ns:ItemFormatSortFilterCodeType'
271              
272             =cut
273              
274             sub getUpSellItemFormatSortFilter {
275             my $self = shift;
276             return $self->{'UpSellItemFormatSortFilter'};
277             }
278              
279              
280             =head2 setUpSellItemSortFilter()
281              
282             (For eBay store owners only) Specifies how to sort items used in an upsell promotion.
283              
284             Calls: SetUserPreferences
285             RequiredInput: No
286              
287             # Argument: 'ns:ItemSortFilterCodeType'
288              
289             =cut
290              
291             sub setUpSellItemSortFilter {
292             my $self = shift;
293             $self->{'UpSellItemSortFilter'} = shift
294             }
295              
296             =head2 getUpSellItemSortFilter()
297              
298             Calls: GetUserPreferences
299             Returned: Conditionally
300              
301             # Returns: 'ns:ItemSortFilterCodeType'
302              
303             =cut
304              
305             sub getUpSellItemSortFilter {
306             my $self = shift;
307             return $self->{'UpSellItemSortFilter'};
308             }
309              
310              
311              
312              
313              
314             ## Attribute and Property lists
315             sub getPropertiesList {
316             my $self = shift;
317             return \@gaProperties;
318             }
319              
320             sub getAttributesList {
321             my $self = shift;
322             return \@gaAttributes;
323             }
324              
325              
326              
327             1;