File Coverage

lib/eBay/API/XML/Call/GetStore.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::Call::GetStore;
4              
5 1     1   2327 use strict;
  1         4  
  1         31  
6 1     1   5 use warnings;
  1         2  
  1         28  
7              
8             ##########################################################################
9             #
10             # Module: ............... eBay/API/XML
11             # File: ................. GetStore.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::Call::GetStore
21              
22             =head1 DESCRIPTION
23              
24              
25              
26             =head1 SYNOPSIS
27              
28             =cut
29              
30              
31             =head1 INHERITANCE
32              
33             eBay::API::XML::Call::GetStore inherits from the L class
34              
35             =cut
36              
37 1     1   34 use eBay::API::XML::BaseCall;
  0            
  0            
38             our @ISA = ("eBay::API::XML::BaseCall");
39              
40             use eBay::API::XML::Call::GetStore::GetStoreRequestType;
41             use eBay::API::XML::Call::GetStore::GetStoreResponseType;
42              
43              
44             =head1 Subroutines:
45              
46             =cut
47              
48             sub getApiCallName {
49             return 'GetStore';
50             }
51             sub getRequestDataTypeFullPackage {
52             return 'eBay::API::XML::Call::GetStore::GetStoreRequestType';
53             }
54             sub getResponseDataTypeFullPackage {
55             return 'eBay::API::XML::Call::GetStore::GetStoreResponseType';
56             }
57              
58             #
59             # input properties
60             #
61              
62             =head2 setCategoryStructureOnly()
63              
64             If this is set to True, only the category structure of the store is
65             returned. If this is not specified or set to False, the complete store
66             configuration is returned.
67              
68             RequiredInput: Conditionally
69             # Argument: 'xs:boolean'
70              
71             =cut
72            
73             sub setCategoryStructureOnly {
74             my $self = shift;
75             my $sCategoryStructureOnly = shift;
76             $self->getRequestDataType()->setCategoryStructureOnly($sCategoryStructureOnly);
77             }
78              
79             =head2 setLevelLimit()
80              
81             Specifies the limit for the number of levels of the category hierarchy
82             to return, where the given root category is level 1 and its children are
83             level 2. Only categories at or above the level specified are returned.
84             This tag is optional. If LevelLimit is not set, the complete category
85             hierarchy is returned. Stores support category hierarchies up to 3
86             levels only.
87              
88             RequiredInput: Conditionally
89             # Argument: 'xs:int'
90              
91             =cut
92            
93             sub setLevelLimit {
94             my $self = shift;
95             my $sLevelLimit = shift;
96             $self->getRequestDataType()->setLevelLimit($sLevelLimit);
97             }
98              
99             =head2 setRootCategoryID()
100              
101             Specifies the category ID for the topmost category to return (along with
102             the subcategories under it, the value of the LevelLimit property
103             determining how deep). This tag is optional. If RootCategoryID is not
104             specified, then the category tree starting at that root Category is
105             returned.
106              
107             RequiredInput: Conditionally
108             # Argument: 'xs:long'
109              
110             =cut
111            
112             sub setRootCategoryID {
113             my $self = shift;
114             my $sRootCategoryID = shift;
115             $self->getRequestDataType()->setRootCategoryID($sRootCategoryID);
116             }
117              
118             =head2 setUserID()
119              
120             Specifies the user whose store data is to be returned. If not specified,
121             then the store returned is that for the requesting user.
122              
123             RequiredInput: No
124             # Argument: 'ns:UserIDType'
125              
126             =cut
127            
128             sub setUserID {
129             my $self = shift;
130             my $pUserID = shift;
131             $self->getRequestDataType()->setUserID($pUserID);
132             }
133              
134              
135              
136             #
137             # output properties
138             #
139              
140             =head2 getStore()
141              
142             The data describing the store configuration.
143              
144             Returned: Always
145             # Returns: 'ns:StoreType'
146              
147             =cut
148            
149             sub getStore {
150             my $self = shift;
151             return $self->getResponseDataType()->getStore();
152             }
153              
154              
155              
156              
157              
158             1;