File Coverage

lib/eBay/API/XML/DataType/ExpressHistogramAisleType.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::ExpressHistogramAisleType;
4              
5 1     1   1604 use strict;
  1         2  
  1         37  
6 1     1   5 use warnings;
  1         3  
  1         75  
7              
8             ##########################################################################
9             #
10             # Module: ............... eBay/API/XML
11             # File: ................. ExpressHistogramAisleType.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::ExpressHistogramAisleType
21              
22             =head1 DESCRIPTION
23              
24             Details about an Express aisle and matching item and catalog product counts
25             in that aisle, if any.
26              
27              
28              
29             =head1 SYNOPSIS
30              
31             =cut
32              
33              
34             =head1 INHERITANCE
35              
36             eBay::API::XML::DataType::ExpressHistogramAisleType inherits from the L class
37              
38             =cut
39              
40 1     1   47 use eBay::API::XML::BaseDataType;
  0            
  0            
41             our @ISA = ("eBay::API::XML::BaseDataType");
42              
43             use eBay::API::XML::DataType::ExpressHistogramDomainDetailsType;
44             use eBay::API::XML::DataType::ExpressHistogramProductType;
45              
46              
47             my @gaProperties = ( [ 'DomainDetails', 'ns:ExpressHistogramDomainDetailsType', ''
48             ,'eBay::API::XML::DataType::ExpressHistogramDomainDetailsType', '1' ]
49             , [ 'ProductType', 'ns:ExpressHistogramProductType', '1'
50             ,'eBay::API::XML::DataType::ExpressHistogramProductType', '1' ]
51             );
52             push @gaProperties, @{eBay::API::XML::BaseDataType::getPropertiesList()};
53              
54             my @gaAttributes = (
55             );
56             push @gaAttributes, @{eBay::API::XML::BaseDataType::getAttributesList()};
57              
58             =head1 Subroutines:
59              
60             =cut
61              
62             sub new {
63             my $classname = shift;
64             my %args = @_;
65             my $self = $classname->SUPER::new(%args);
66             return $self;
67             }
68              
69             sub isScalar {
70             return 0;
71             }
72              
73              
74              
75             =head2 setDomainDetails()
76              
77             Identifies the aisle and provides matching item and eBay catalog product
78             counts in the specified aisle, if any. Only returned if an aisle matched the
79             request.
80            
81             If this node is missing but Aisle.ProductType is present, it means that the
82             product type specified in Aisle.ProductType is not grouped into an aisle. In
83             the Express Web site UI, such product types are elevated to (treated as)
84             aisles from the user's perspective (or as Departments, if
85             Department.DomainDetails is also missing). However, the API always maintains
86             the Department/Aisle/ProductType structure to help you distinguish between
87             actual departments, aisles, and stand-alone product types.
88              
89             # Argument: 'ns:ExpressHistogramDomainDetailsType'
90              
91             =cut
92              
93             sub setDomainDetails {
94             my $self = shift;
95             $self->{'DomainDetails'} = shift
96             }
97              
98             =head2 getDomainDetails()
99              
100             # Returns: 'ns:ExpressHistogramDomainDetailsType'
101              
102             =cut
103              
104             sub getDomainDetails {
105             my $self = shift;
106             return $self->_getDataTypeInstance( 'DomainDetails'
107             ,'eBay::API::XML::DataType::ExpressHistogramDomainDetailsType');
108             }
109              
110              
111             =head2 setProductType()
112              
113             Contains item and catalog product counts for an Express product type.
114             Only returned when HistogramDetails is configured to return product types.
115            
116             An Aisle node can contain multiple ProductType nodes.
117              
118             # Argument: reference to an array
119             of 'ns:ExpressHistogramProductType'
120              
121             =cut
122              
123             sub setProductType {
124             my $self = shift;
125             $self->{'ProductType'} =
126             $self->convertArray_To_RefToArrayIfNeeded(@_);
127             }
128              
129             =head2 getProductType()
130              
131             # Returns: reference to an array
132             of 'ns:ExpressHistogramProductType'
133              
134             =cut
135              
136             sub getProductType {
137             my $self = shift;
138             return $self->_getDataTypeArray('ProductType');
139             }
140              
141              
142              
143              
144              
145             ## Attribute and Property lists
146             sub getPropertiesList {
147             my $self = shift;
148             return \@gaProperties;
149             }
150              
151             sub getAttributesList {
152             my $self = shift;
153             return \@gaAttributes;
154             }
155              
156              
157              
158             1;