File Coverage

lib/eBay/API/XML/DataType/ReviewDetailsType.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::ReviewDetailsType;
4              
5 1     1   1248 use strict;
  1         3  
  1         50  
6 1     1   5 use warnings;
  1         2  
  1         31  
7              
8             ##########################################################################
9             #
10             # Module: ............... eBay/API/XML
11             # File: ................. ReviewDetailsType.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::ReviewDetailsType
21              
22             =head1 DESCRIPTION
23              
24             Contains product reviews written by eBay members.
25              
26              
27              
28             =head1 SYNOPSIS
29              
30             =cut
31              
32              
33             =head1 INHERITANCE
34              
35             eBay::API::XML::DataType::ReviewDetailsType inherits from the L class
36              
37             =cut
38              
39 1     1   43 use eBay::API::XML::BaseDataType;
  0            
  0            
40             our @ISA = ("eBay::API::XML::BaseDataType");
41              
42             use eBay::API::XML::DataType::ReviewType;
43              
44              
45             my @gaProperties = ( [ 'AverageRating', 'xs:float', '', '', '' ]
46             , [ 'Review', 'ns:ReviewType', '1'
47             ,'eBay::API::XML::DataType::ReviewType', '1' ]
48             );
49             push @gaProperties, @{eBay::API::XML::BaseDataType::getPropertiesList()};
50              
51             my @gaAttributes = (
52             );
53             push @gaAttributes, @{eBay::API::XML::BaseDataType::getAttributesList()};
54              
55             =head1 Subroutines:
56              
57             =cut
58              
59             sub new {
60             my $classname = shift;
61             my %args = @_;
62             my $self = $classname->SUPER::new(%args);
63             return $self;
64             }
65              
66             sub isScalar {
67             return 0;
68             }
69              
70              
71              
72             =head2 setAverageRating()
73              
74             The product's average rating (out of 5) based on all reviews.
75             For example, a value like 4.5 would mean the average rating
76             is 4.5 out of 5. (See ReviewCount for the total number of reviews.)
77              
78             Max: 5
79             Min: 0
80              
81             # Argument: 'xs:float'
82              
83             =cut
84              
85             sub setAverageRating {
86             my $self = shift;
87             $self->{'AverageRating'} = shift
88             }
89              
90             =head2 getAverageRating()
91              
92             Calls: GetProducts
93             Returned: Conditionally
94              
95             # Returns: 'xs:float'
96              
97             =cut
98              
99             sub getAverageRating {
100             my $self = shift;
101             return $self->{'AverageRating'};
102             }
103              
104              
105             =head2 setReview()
106              
107             An eBay member's review of the product.
108              
109             MaxOccurs: 20
110              
111             # Argument: reference to an array
112             of 'ns:ReviewType'
113              
114             =cut
115              
116             sub setReview {
117             my $self = shift;
118             $self->{'Review'} =
119             $self->convertArray_To_RefToArrayIfNeeded(@_);
120             }
121              
122             =head2 getReview()
123              
124             Calls: GetProducts
125             Returned: Conditionally
126              
127             # Returns: reference to an array
128             of 'ns:ReviewType'
129              
130             =cut
131              
132             sub getReview {
133             my $self = shift;
134             return $self->_getDataTypeArray('Review');
135             }
136              
137              
138              
139              
140              
141             ## Attribute and Property lists
142             sub getPropertiesList {
143             my $self = shift;
144             return \@gaProperties;
145             }
146              
147             sub getAttributesList {
148             my $self = shift;
149             return \@gaAttributes;
150             }
151              
152              
153              
154             1;