line |
stmt |
bran |
cond |
sub |
pod |
time |
code |
1
|
|
|
|
|
|
|
#!/usr/bin/perl |
2
|
|
|
|
|
|
|
|
3
|
|
|
|
|
|
|
package eBay::API::XML::Call::GetCharities::GetCharitiesRequestType; |
4
|
|
|
|
|
|
|
|
5
|
1
|
|
|
1
|
|
1407
|
use strict; |
|
1
|
|
|
|
|
2
|
|
|
1
|
|
|
|
|
26
|
|
6
|
1
|
|
|
1
|
|
3
|
use warnings; |
|
1
|
|
|
|
|
2
|
|
|
1
|
|
|
|
|
26
|
|
7
|
|
|
|
|
|
|
|
8
|
|
|
|
|
|
|
########################################################################## |
9
|
|
|
|
|
|
|
# |
10
|
|
|
|
|
|
|
# Module: ............... eBay/API/XML |
11
|
|
|
|
|
|
|
# File: ................. GetCharitiesRequestType.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::GetCharities::GetCharitiesRequestType |
21
|
|
|
|
|
|
|
|
22
|
|
|
|
|
|
|
=head1 DESCRIPTION |
23
|
|
|
|
|
|
|
|
24
|
|
|
|
|
|
|
Searches for nonprofit charity organizations that meet the criteria specified in the request. |
25
|
|
|
|
|
|
|
|
26
|
|
|
|
|
|
|
|
27
|
|
|
|
|
|
|
|
28
|
|
|
|
|
|
|
=head1 SYNOPSIS |
29
|
|
|
|
|
|
|
|
30
|
|
|
|
|
|
|
=cut |
31
|
|
|
|
|
|
|
|
32
|
|
|
|
|
|
|
|
33
|
|
|
|
|
|
|
=head1 INHERITANCE |
34
|
|
|
|
|
|
|
|
35
|
|
|
|
|
|
|
eBay::API::XML::Call::GetCharities::GetCharitiesRequestType inherits from the L class |
36
|
|
|
|
|
|
|
|
37
|
|
|
|
|
|
|
=cut |
38
|
|
|
|
|
|
|
|
39
|
1
|
|
|
1
|
|
32
|
use eBay::API::XML::RequestDataType; |
|
0
|
|
|
|
|
|
|
|
0
|
|
|
|
|
|
|
40
|
|
|
|
|
|
|
our @ISA = ("eBay::API::XML::RequestDataType"); |
41
|
|
|
|
|
|
|
|
42
|
|
|
|
|
|
|
use eBay::API::XML::DataType::Enum::StringMatchCodeType; |
43
|
|
|
|
|
|
|
|
44
|
|
|
|
|
|
|
|
45
|
|
|
|
|
|
|
my @gaProperties = ( [ 'CharityDomain', 'xs:int', '', '', '' ] |
46
|
|
|
|
|
|
|
, [ 'CharityID', 'xs:string', '', '', '' ] |
47
|
|
|
|
|
|
|
, [ 'CharityName', 'xs:string', '', '', '' ] |
48
|
|
|
|
|
|
|
, [ 'CharityRegion', 'xs:int', '', '', '' ] |
49
|
|
|
|
|
|
|
, [ 'Featured', 'xs:boolean', '', '', '' ] |
50
|
|
|
|
|
|
|
, [ 'IncludeDescription', 'xs:boolean', '', '', '' ] |
51
|
|
|
|
|
|
|
, [ 'MatchType', 'ns:StringMatchCodeType', '' |
52
|
|
|
|
|
|
|
,'eBay::API::XML::DataType::Enum::StringMatchCodeType', '' ] |
53
|
|
|
|
|
|
|
, [ 'Query', 'xs:string', '', '', '' ] |
54
|
|
|
|
|
|
|
); |
55
|
|
|
|
|
|
|
push @gaProperties, @{eBay::API::XML::RequestDataType::getPropertiesList()}; |
56
|
|
|
|
|
|
|
|
57
|
|
|
|
|
|
|
my @gaAttributes = ( |
58
|
|
|
|
|
|
|
); |
59
|
|
|
|
|
|
|
push @gaAttributes, @{eBay::API::XML::RequestDataType::getAttributesList()}; |
60
|
|
|
|
|
|
|
|
61
|
|
|
|
|
|
|
=head1 Subroutines: |
62
|
|
|
|
|
|
|
|
63
|
|
|
|
|
|
|
=cut |
64
|
|
|
|
|
|
|
|
65
|
|
|
|
|
|
|
sub new { |
66
|
|
|
|
|
|
|
my $classname = shift; |
67
|
|
|
|
|
|
|
my %args = @_; |
68
|
|
|
|
|
|
|
my $self = $classname->SUPER::new(%args); |
69
|
|
|
|
|
|
|
return $self; |
70
|
|
|
|
|
|
|
} |
71
|
|
|
|
|
|
|
|
72
|
|
|
|
|
|
|
sub isScalar { |
73
|
|
|
|
|
|
|
return 0; |
74
|
|
|
|
|
|
|
} |
75
|
|
|
|
|
|
|
|
76
|
|
|
|
|
|
|
|
77
|
|
|
|
|
|
|
|
78
|
|
|
|
|
|
|
=head2 setCharityDomain() |
79
|
|
|
|
|
|
|
|
80
|
|
|
|
|
|
|
Domain (mission area) that a nonprofit charity organization |
81
|
|
|
|
|
|
|
belongs to. Nonprofit charity organizations may belong to multiple |
82
|
|
|
|
|
|
|
mission areas. Meaning of input values differs depending on the |
83
|
|
|
|
|
|
|
site. See GetCharities in the API Developer's Guide for the meaning |
84
|
|
|
|
|
|
|
of each input/output value. CharityDomain input value must be valid for |
85
|
|
|
|
|
|
|
that SiteID. |
86
|
|
|
|
|
|
|
|
87
|
|
|
|
|
|
|
RequiredInput: No |
88
|
|
|
|
|
|
|
# Argument: 'xs:int' |
89
|
|
|
|
|
|
|
|
90
|
|
|
|
|
|
|
=cut |
91
|
|
|
|
|
|
|
|
92
|
|
|
|
|
|
|
sub setCharityDomain { |
93
|
|
|
|
|
|
|
my $self = shift; |
94
|
|
|
|
|
|
|
$self->{'CharityDomain'} = shift |
95
|
|
|
|
|
|
|
} |
96
|
|
|
|
|
|
|
|
97
|
|
|
|
|
|
|
=head2 getCharityDomain() |
98
|
|
|
|
|
|
|
|
99
|
|
|
|
|
|
|
# Returns: 'xs:int' |
100
|
|
|
|
|
|
|
|
101
|
|
|
|
|
|
|
=cut |
102
|
|
|
|
|
|
|
|
103
|
|
|
|
|
|
|
sub getCharityDomain { |
104
|
|
|
|
|
|
|
my $self = shift; |
105
|
|
|
|
|
|
|
return $self->{'CharityDomain'}; |
106
|
|
|
|
|
|
|
} |
107
|
|
|
|
|
|
|
|
108
|
|
|
|
|
|
|
|
109
|
|
|
|
|
|
|
=head2 setCharityID() |
110
|
|
|
|
|
|
|
|
111
|
|
|
|
|
|
|
A unique identification number assigned by eBay to registered nonprofit |
112
|
|
|
|
|
|
|
charity organizations. |
113
|
|
|
|
|
|
|
|
114
|
|
|
|
|
|
|
RequiredInput: No |
115
|
|
|
|
|
|
|
# Argument: 'xs:string' |
116
|
|
|
|
|
|
|
|
117
|
|
|
|
|
|
|
=cut |
118
|
|
|
|
|
|
|
|
119
|
|
|
|
|
|
|
sub setCharityID { |
120
|
|
|
|
|
|
|
my $self = shift; |
121
|
|
|
|
|
|
|
$self->{'CharityID'} = shift |
122
|
|
|
|
|
|
|
} |
123
|
|
|
|
|
|
|
|
124
|
|
|
|
|
|
|
=head2 getCharityID() |
125
|
|
|
|
|
|
|
|
126
|
|
|
|
|
|
|
# Returns: 'xs:string' |
127
|
|
|
|
|
|
|
|
128
|
|
|
|
|
|
|
=cut |
129
|
|
|
|
|
|
|
|
130
|
|
|
|
|
|
|
sub getCharityID { |
131
|
|
|
|
|
|
|
my $self = shift; |
132
|
|
|
|
|
|
|
return $self->{'CharityID'}; |
133
|
|
|
|
|
|
|
} |
134
|
|
|
|
|
|
|
|
135
|
|
|
|
|
|
|
|
136
|
|
|
|
|
|
|
=head2 setCharityName() |
137
|
|
|
|
|
|
|
|
138
|
|
|
|
|
|
|
A name assigned to a specified nonprofit |
139
|
|
|
|
|
|
|
organization. Accepts full charity nonprofit name |
140
|
|
|
|
|
|
|
or partial name as input. For example, enter a |
141
|
|
|
|
|
|
|
CharityName of "heart" (case-insensitive) to |
142
|
|
|
|
|
|
|
return all charity nonprofits that start with |
143
|
|
|
|
|
|
|
"heart." Use with a MatchType value of "Contains" |
144
|
|
|
|
|
|
|
to return all charity nonprofits that contain the |
145
|
|
|
|
|
|
|
string "heart." |
146
|
|
|
|
|
|
|
|
147
|
|
|
|
|
|
|
MaxLength: 150 |
148
|
|
|
|
|
|
|
|
149
|
|
|
|
|
|
|
RequiredInput: No |
150
|
|
|
|
|
|
|
# Argument: 'xs:string' |
151
|
|
|
|
|
|
|
|
152
|
|
|
|
|
|
|
=cut |
153
|
|
|
|
|
|
|
|
154
|
|
|
|
|
|
|
sub setCharityName { |
155
|
|
|
|
|
|
|
my $self = shift; |
156
|
|
|
|
|
|
|
$self->{'CharityName'} = shift |
157
|
|
|
|
|
|
|
} |
158
|
|
|
|
|
|
|
|
159
|
|
|
|
|
|
|
=head2 getCharityName() |
160
|
|
|
|
|
|
|
|
161
|
|
|
|
|
|
|
# Returns: 'xs:string' |
162
|
|
|
|
|
|
|
|
163
|
|
|
|
|
|
|
=cut |
164
|
|
|
|
|
|
|
|
165
|
|
|
|
|
|
|
sub getCharityName { |
166
|
|
|
|
|
|
|
my $self = shift; |
167
|
|
|
|
|
|
|
return $self->{'CharityName'}; |
168
|
|
|
|
|
|
|
} |
169
|
|
|
|
|
|
|
|
170
|
|
|
|
|
|
|
|
171
|
|
|
|
|
|
|
=head2 setCharityRegion() |
172
|
|
|
|
|
|
|
|
173
|
|
|
|
|
|
|
Region that the nonprofit charity organization is associated |
174
|
|
|
|
|
|
|
with. A specific nonprofit charity organization may be associated |
175
|
|
|
|
|
|
|
with only one region. Meaning of input values differs depending on |
176
|
|
|
|
|
|
|
the site. See GetCharities in the API Developer's Guide for the meaning |
177
|
|
|
|
|
|
|
of each input/output value. CharityRegion input value must be |
178
|
|
|
|
|
|
|
valid for that SiteID. |
179
|
|
|
|
|
|
|
|
180
|
|
|
|
|
|
|
RequiredInput: No |
181
|
|
|
|
|
|
|
# Argument: 'xs:int' |
182
|
|
|
|
|
|
|
|
183
|
|
|
|
|
|
|
=cut |
184
|
|
|
|
|
|
|
|
185
|
|
|
|
|
|
|
sub setCharityRegion { |
186
|
|
|
|
|
|
|
my $self = shift; |
187
|
|
|
|
|
|
|
$self->{'CharityRegion'} = shift |
188
|
|
|
|
|
|
|
} |
189
|
|
|
|
|
|
|
|
190
|
|
|
|
|
|
|
=head2 getCharityRegion() |
191
|
|
|
|
|
|
|
|
192
|
|
|
|
|
|
|
# Returns: 'xs:int' |
193
|
|
|
|
|
|
|
|
194
|
|
|
|
|
|
|
=cut |
195
|
|
|
|
|
|
|
|
196
|
|
|
|
|
|
|
sub getCharityRegion { |
197
|
|
|
|
|
|
|
my $self = shift; |
198
|
|
|
|
|
|
|
return $self->{'CharityRegion'}; |
199
|
|
|
|
|
|
|
} |
200
|
|
|
|
|
|
|
|
201
|
|
|
|
|
|
|
|
202
|
|
|
|
|
|
|
=head2 setFeatured() |
203
|
|
|
|
|
|
|
|
204
|
|
|
|
|
|
|
Used to decide if the search is only for featured charities. |
205
|
|
|
|
|
|
|
A value of true will search for only featured charities. |
206
|
|
|
|
|
|
|
|
207
|
|
|
|
|
|
|
RequiredInput: No |
208
|
|
|
|
|
|
|
# Argument: 'xs:boolean' |
209
|
|
|
|
|
|
|
|
210
|
|
|
|
|
|
|
=cut |
211
|
|
|
|
|
|
|
|
212
|
|
|
|
|
|
|
sub setFeatured { |
213
|
|
|
|
|
|
|
my $self = shift; |
214
|
|
|
|
|
|
|
$self->{'Featured'} = shift |
215
|
|
|
|
|
|
|
} |
216
|
|
|
|
|
|
|
|
217
|
|
|
|
|
|
|
=head2 isFeatured() |
218
|
|
|
|
|
|
|
|
219
|
|
|
|
|
|
|
# Returns: 'xs:boolean' |
220
|
|
|
|
|
|
|
|
221
|
|
|
|
|
|
|
=cut |
222
|
|
|
|
|
|
|
|
223
|
|
|
|
|
|
|
sub isFeatured { |
224
|
|
|
|
|
|
|
my $self = shift; |
225
|
|
|
|
|
|
|
return $self->{'Featured'}; |
226
|
|
|
|
|
|
|
} |
227
|
|
|
|
|
|
|
|
228
|
|
|
|
|
|
|
|
229
|
|
|
|
|
|
|
=head2 setIncludeDescription() |
230
|
|
|
|
|
|
|
|
231
|
|
|
|
|
|
|
Used with Query to search for charity nonprofit |
232
|
|
|
|
|
|
|
organizations. A value of true will search the Mission field as |
233
|
|
|
|
|
|
|
well as the CharityName field for a string specified in Query. |
234
|
|
|
|
|
|
|
|
235
|
|
|
|
|
|
|
RequiredInput: No |
236
|
|
|
|
|
|
|
# Argument: 'xs:boolean' |
237
|
|
|
|
|
|
|
|
238
|
|
|
|
|
|
|
=cut |
239
|
|
|
|
|
|
|
|
240
|
|
|
|
|
|
|
sub setIncludeDescription { |
241
|
|
|
|
|
|
|
my $self = shift; |
242
|
|
|
|
|
|
|
$self->{'IncludeDescription'} = shift |
243
|
|
|
|
|
|
|
} |
244
|
|
|
|
|
|
|
|
245
|
|
|
|
|
|
|
=head2 isIncludeDescription() |
246
|
|
|
|
|
|
|
|
247
|
|
|
|
|
|
|
# Returns: 'xs:boolean' |
248
|
|
|
|
|
|
|
|
249
|
|
|
|
|
|
|
=cut |
250
|
|
|
|
|
|
|
|
251
|
|
|
|
|
|
|
sub isIncludeDescription { |
252
|
|
|
|
|
|
|
my $self = shift; |
253
|
|
|
|
|
|
|
return $self->{'IncludeDescription'}; |
254
|
|
|
|
|
|
|
} |
255
|
|
|
|
|
|
|
|
256
|
|
|
|
|
|
|
|
257
|
|
|
|
|
|
|
=head2 setMatchType() |
258
|
|
|
|
|
|
|
|
259
|
|
|
|
|
|
|
Indicates the type of string matching to use when a value is submitted in |
260
|
|
|
|
|
|
|
CharityName. If no value is specified, default behavior is "StartsWith." |
261
|
|
|
|
|
|
|
Does not apply to Query. |
262
|
|
|
|
|
|
|
|
263
|
|
|
|
|
|
|
RequiredInput: No |
264
|
|
|
|
|
|
|
# Argument: 'ns:StringMatchCodeType' |
265
|
|
|
|
|
|
|
|
266
|
|
|
|
|
|
|
=cut |
267
|
|
|
|
|
|
|
|
268
|
|
|
|
|
|
|
sub setMatchType { |
269
|
|
|
|
|
|
|
my $self = shift; |
270
|
|
|
|
|
|
|
$self->{'MatchType'} = shift |
271
|
|
|
|
|
|
|
} |
272
|
|
|
|
|
|
|
|
273
|
|
|
|
|
|
|
=head2 getMatchType() |
274
|
|
|
|
|
|
|
|
275
|
|
|
|
|
|
|
# Returns: 'ns:StringMatchCodeType' |
276
|
|
|
|
|
|
|
|
277
|
|
|
|
|
|
|
=cut |
278
|
|
|
|
|
|
|
|
279
|
|
|
|
|
|
|
sub getMatchType { |
280
|
|
|
|
|
|
|
my $self = shift; |
281
|
|
|
|
|
|
|
return $self->{'MatchType'}; |
282
|
|
|
|
|
|
|
} |
283
|
|
|
|
|
|
|
|
284
|
|
|
|
|
|
|
|
285
|
|
|
|
|
|
|
=head2 setQuery() |
286
|
|
|
|
|
|
|
|
287
|
|
|
|
|
|
|
Accepts a case-insensitive string used to |
288
|
|
|
|
|
|
|
find a nonprofit charity organization. Default |
289
|
|
|
|
|
|
|
behavior is to search the CharityName field. Use |
290
|
|
|
|
|
|
|
with an IncludeDescription value of true to |
291
|
|
|
|
|
|
|
include the Mission field in the search. |
292
|
|
|
|
|
|
|
|
293
|
|
|
|
|
|
|
MaxLength: 350 (characters) |
294
|
|
|
|
|
|
|
|
295
|
|
|
|
|
|
|
RequiredInput: No |
296
|
|
|
|
|
|
|
# Argument: 'xs:string' |
297
|
|
|
|
|
|
|
|
298
|
|
|
|
|
|
|
=cut |
299
|
|
|
|
|
|
|
|
300
|
|
|
|
|
|
|
sub setQuery { |
301
|
|
|
|
|
|
|
my $self = shift; |
302
|
|
|
|
|
|
|
$self->{'Query'} = shift |
303
|
|
|
|
|
|
|
} |
304
|
|
|
|
|
|
|
|
305
|
|
|
|
|
|
|
=head2 getQuery() |
306
|
|
|
|
|
|
|
|
307
|
|
|
|
|
|
|
# Returns: 'xs:string' |
308
|
|
|
|
|
|
|
|
309
|
|
|
|
|
|
|
=cut |
310
|
|
|
|
|
|
|
|
311
|
|
|
|
|
|
|
sub getQuery { |
312
|
|
|
|
|
|
|
my $self = shift; |
313
|
|
|
|
|
|
|
return $self->{'Query'}; |
314
|
|
|
|
|
|
|
} |
315
|
|
|
|
|
|
|
|
316
|
|
|
|
|
|
|
|
317
|
|
|
|
|
|
|
|
318
|
|
|
|
|
|
|
|
319
|
|
|
|
|
|
|
|
320
|
|
|
|
|
|
|
## Attribute and Property lists |
321
|
|
|
|
|
|
|
sub getPropertiesList { |
322
|
|
|
|
|
|
|
my $self = shift; |
323
|
|
|
|
|
|
|
return \@gaProperties; |
324
|
|
|
|
|
|
|
} |
325
|
|
|
|
|
|
|
|
326
|
|
|
|
|
|
|
sub getAttributesList { |
327
|
|
|
|
|
|
|
my $self = shift; |
328
|
|
|
|
|
|
|
return \@gaAttributes; |
329
|
|
|
|
|
|
|
} |
330
|
|
|
|
|
|
|
|
331
|
|
|
|
|
|
|
|
332
|
|
|
|
|
|
|
|
333
|
|
|
|
|
|
|
1; |