File Coverage

lib/eBay/API/XML/DataType/ExtendedProductFinderIDType.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::ExtendedProductFinderIDType;
4              
5 1     1   1913 use strict;
  1         2  
  1         31  
6 1     1   7 use warnings;
  1         3  
  1         43  
7              
8             ##########################################################################
9             #
10             # Module: ............... eBay/API/XML
11             # File: ................. ExtendedProductFinderIDType.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::ExtendedProductFinderIDType
21              
22             =head1 DESCRIPTION
23              
24              
25              
26             =head1 SYNOPSIS
27              
28             =cut
29              
30              
31             =head1 INHERITANCE
32              
33             eBay::API::XML::DataType::ExtendedProductFinderIDType inherits from the L class
34              
35             =cut
36              
37 1     1   50 use eBay::API::XML::BaseDataType;
  0            
  0            
38             our @ISA = ("eBay::API::XML::BaseDataType");
39              
40              
41              
42             my @gaProperties = ( [ 'ProductFinderBuySide', 'xs:boolean', '', '', '' ]
43             , [ 'ProductFinderID', 'xs:int', '', '', '' ]
44             );
45             push @gaProperties, @{eBay::API::XML::BaseDataType::getPropertiesList()};
46              
47             my @gaAttributes = (
48             );
49             push @gaAttributes, @{eBay::API::XML::BaseDataType::getAttributesList()};
50              
51             =head1 Subroutines:
52              
53             =cut
54              
55             sub new {
56             my $classname = shift;
57             my %args = @_;
58             my $self = $classname->SUPER::new(%args);
59             return $self;
60             }
61              
62             sub isScalar {
63             return 0;
64             }
65              
66              
67              
68             =head2 setProductFinderBuySide()
69              
70             If false or not present, the product finder can be used as input to
71             GetProductSearchResults to search for catalog data (Pre-filled Item Information)
72             that a seller might want to include in a listing.
73            
74             If true, the product finder can be used as input to GetSearchResults
75             to search for listings with Item Specifics on the eBay site. However,
76             if you have trouble using the specified product finder with GetSearchResults,
77             or if you can't find a product finder ID that you saw on the Web site,
78             here is a workaround: Use the pfid parameter from the URL of the
79             Product Finder search page on the site you're interested in.
80             See the Knowledge Base article referenced below for more details.
81              
82             SeeLink: URL: https://ebay.custhelp.com/cgi-bin/ebay.cfg/php/enduser/std_adp.php?p_faqid=560
83             Title: Knowledge Base: ProductFinderID for Buy-Side Searches
84              
85             # Argument: 'xs:boolean'
86              
87             =cut
88              
89             sub setProductFinderBuySide {
90             my $self = shift;
91             $self->{'ProductFinderBuySide'} = shift
92             }
93              
94             =head2 isProductFinderBuySide()
95              
96             Calls: GetCategory2CS
97             Returned: Conditionally
98             Details: DetailLevel: ReturnAll
99             Context: MappedCategoryArray
100              
101             # Returns: 'xs:boolean'
102              
103             =cut
104              
105             sub isProductFinderBuySide {
106             my $self = shift;
107             return $self->{'ProductFinderBuySide'};
108             }
109              
110              
111             =head2 setProductFinderID()
112              
113             A product finder ID. GetCategory2CS always (and only) returns this
114             when Category.ProductFinderIDs is returned.
115              
116             # Argument: 'xs:int'
117              
118             =cut
119              
120             sub setProductFinderID {
121             my $self = shift;
122             $self->{'ProductFinderID'} = shift
123             }
124              
125             =head2 getProductFinderID()
126              
127             Calls: GetCategory2CS
128             Returned: Conditionally
129             Details: DetailLevel: ReturnAll
130             Context: MappedCategoryArray
131              
132             # Returns: 'xs:int'
133              
134             =cut
135              
136             sub getProductFinderID {
137             my $self = shift;
138             return $self->{'ProductFinderID'};
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;