File Coverage

lib/eBay/API/XML/DataType/PriceRangeFilterType.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::PriceRangeFilterType;
4              
5 1     1   1173 use strict;
  1         2  
  1         34  
6 1     1   5 use warnings;
  1         3  
  1         41  
7              
8             ##########################################################################
9             #
10             # Module: ............... eBay/API/XML
11             # File: ................. PriceRangeFilterType.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::PriceRangeFilterType
21              
22             =head1 DESCRIPTION
23              
24             One of the data filters used when searching for items using
25             GetSearchResults. Allows filtering based on the current price of items.
26             Properties allow for defining a range within prices must fall to be
27             returned in the result set, a minimum price for items returned, or a
28             maximum price for items returned.
29              
30              
31              
32             =head1 SYNOPSIS
33              
34             =cut
35              
36              
37             =head1 INHERITANCE
38              
39             eBay::API::XML::DataType::PriceRangeFilterType inherits from the L class
40              
41             =cut
42              
43 1     1   42 use eBay::API::XML::BaseDataType;
  0            
  0            
44             our @ISA = ("eBay::API::XML::BaseDataType");
45              
46             use eBay::API::XML::DataType::AmountType;
47              
48              
49             my @gaProperties = ( [ 'MaxPrice', 'ns:AmountType', ''
50             ,'eBay::API::XML::DataType::AmountType', '1' ]
51             , [ 'MinPrice', 'ns:AmountType', ''
52             ,'eBay::API::XML::DataType::AmountType', '1' ]
53             );
54             push @gaProperties, @{eBay::API::XML::BaseDataType::getPropertiesList()};
55              
56             my @gaAttributes = (
57             );
58             push @gaAttributes, @{eBay::API::XML::BaseDataType::getAttributesList()};
59              
60             =head1 Subroutines:
61              
62             =cut
63              
64             sub new {
65             my $classname = shift;
66             my %args = @_;
67             my $self = $classname->SUPER::new(%args);
68             return $self;
69             }
70              
71             sub isScalar {
72             return 0;
73             }
74              
75              
76              
77             =head2 setMaxPrice()
78              
79             Specifies the maximum current price an item listing can have to be included in
80             the searches result set. Use alone to specify a maximum price or with MinPrice
81             to define a range the items' prices must be.
82             See "Data Types" in the eBay Web Services Guide for information about specifying
83             double values.
84              
85             Calls: GetSearchResults
86             RequiredInput: No
87              
88             # Argument: 'ns:AmountType'
89              
90             =cut
91              
92             sub setMaxPrice {
93             my $self = shift;
94             $self->{'MaxPrice'} = shift
95             }
96              
97             =head2 getMaxPrice()
98              
99             # Returns: 'ns:AmountType'
100              
101             =cut
102              
103             sub getMaxPrice {
104             my $self = shift;
105             return $self->_getDataTypeInstance( 'MaxPrice'
106             ,'eBay::API::XML::DataType::AmountType');
107             }
108              
109              
110             =head2 setMinPrice()
111              
112             Specifies the minimum current price an item listing can have to be included in
113             the searches result set. Use alone to specify a minimum price or with MaxPrice
114             to define a range the items' prices must be.
115             See "Data Types" in the eBay Web Services Guide for information about specifying
116             double values.
117              
118             Calls: GetSearchResults
119             RequiredInput: No
120              
121             # Argument: 'ns:AmountType'
122              
123             =cut
124              
125             sub setMinPrice {
126             my $self = shift;
127             $self->{'MinPrice'} = shift
128             }
129              
130             =head2 getMinPrice()
131              
132             # Returns: 'ns:AmountType'
133              
134             =cut
135              
136             sub getMinPrice {
137             my $self = shift;
138             return $self->_getDataTypeInstance( 'MinPrice'
139             ,'eBay::API::XML::DataType::AmountType');
140             }
141              
142              
143              
144              
145              
146             ## Attribute and Property lists
147             sub getPropertiesList {
148             my $self = shift;
149             return \@gaProperties;
150             }
151              
152             sub getAttributesList {
153             my $self = shift;
154             return \@gaAttributes;
155             }
156              
157              
158              
159             1;