File Coverage

lib/eBay/API/XML/DataType/TimeZoneDetailsType.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::TimeZoneDetailsType;
4              
5 1     1   1460 use strict;
  1         3  
  1         59  
6 1     1   6 use warnings;
  1         3  
  1         37  
7              
8             ##########################################################################
9             #
10             # Module: ............... eBay/API/XML
11             # File: ................. TimeZoneDetailsType.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::TimeZoneDetailsType
21              
22             =head1 DESCRIPTION
23              
24             Time zone details about a region or location to which the seller is willing to
25             ship.
26              
27              
28              
29             =head1 SYNOPSIS
30              
31             =cut
32              
33              
34             =head1 INHERITANCE
35              
36             eBay::API::XML::DataType::TimeZoneDetailsType inherits from the L class
37              
38             =cut
39              
40 1     1   45 use eBay::API::XML::BaseDataType;
  0            
  0            
41             our @ISA = ("eBay::API::XML::BaseDataType");
42              
43              
44              
45             my @gaProperties = ( [ 'DaylightSavingsInEffect', 'xs:boolean', '', '', '' ]
46             , [ 'DaylightSavingsLabel', 'xs:string', '', '', '' ]
47             , [ 'DaylightSavingsOffset', 'xs:string', '', '', '' ]
48             , [ 'StandardLabel', 'xs:string', '', '', '' ]
49             , [ 'StandardOffset', 'xs:string', '', '', '' ]
50             , [ 'TimeZoneID', 'xs:string', '', '', '' ]
51             );
52             push @gaProperties, @{eBay::API::XML::BaseDataType::getPropertiesList()};
53              
54             my @gaAttributes = (
55             );
56             push @gaAttributes, @{eBay::API::XML::BaseDataType::getAttributesList()};
57              
58             =head1 Subroutines:
59              
60             =cut
61              
62             sub new {
63             my $classname = shift;
64             my %args = @_;
65             my $self = $classname->SUPER::new(%args);
66             return $self;
67             }
68              
69             sub isScalar {
70             return 0;
71             }
72              
73              
74              
75             =head2 setDaylightSavingsInEffect()
76              
77             Indicates whether or not the time zone is currently on daylight saving time.
78             A value of true indicates that the time zone is on daylights savings time.
79             This element is emitted for time zones that support daylight saving time only.
80              
81             # Argument: 'xs:boolean'
82              
83             =cut
84              
85             sub setDaylightSavingsInEffect {
86             my $self = shift;
87             $self->{'DaylightSavingsInEffect'} = shift
88             }
89              
90             =head2 isDaylightSavingsInEffect()
91              
92             Calls: GeteBayDetails
93             Returned: Conditionally
94              
95             # Returns: 'xs:boolean'
96              
97             =cut
98              
99             sub isDaylightSavingsInEffect {
100             my $self = shift;
101             return $self->{'DaylightSavingsInEffect'};
102             }
103              
104              
105             =head2 setDaylightSavingsLabel()
106              
107             Display name of a time zone in its daylight saving time representation.
108             This element is emitted for time zones that support daylight saving time
109             only. The value is localized and returned in the language for the site
110             specified in the request.
111              
112             # Argument: 'xs:string'
113              
114             =cut
115              
116             sub setDaylightSavingsLabel {
117             my $self = shift;
118             $self->{'DaylightSavingsLabel'} = shift
119             }
120              
121             =head2 getDaylightSavingsLabel()
122              
123             Calls: GeteBayDetails
124             Returned: Conditionally
125              
126             # Returns: 'xs:string'
127              
128             =cut
129              
130             sub getDaylightSavingsLabel {
131             my $self = shift;
132             return $self->{'DaylightSavingsLabel'};
133             }
134              
135              
136             =head2 setDaylightSavingsOffset()
137              
138             The offset in hours from GMT for a time zone when it is on daylight saving
139             time. This element is emitted for time zones that support daylight
140             saving time only.
141              
142             # Argument: 'xs:string'
143              
144             =cut
145              
146             sub setDaylightSavingsOffset {
147             my $self = shift;
148             $self->{'DaylightSavingsOffset'} = shift
149             }
150              
151             =head2 getDaylightSavingsOffset()
152              
153             Calls: GeteBayDetails
154             Returned: Conditionally
155              
156             # Returns: 'xs:string'
157              
158             =cut
159              
160             sub getDaylightSavingsOffset {
161             my $self = shift;
162             return $self->{'DaylightSavingsOffset'};
163             }
164              
165              
166             =head2 setStandardLabel()
167              
168             Display name of a time zone in its standard (non-daylight saving) time
169             representation. This value is localized and returned in the language for the
170             site specified in the request (i.e., the numeric site ID that you specify in
171             the request URL for the SOAP API or the X-EBAY-API-SITEID header for the XML
172             API).
173              
174             # Argument: 'xs:string'
175              
176             =cut
177              
178             sub setStandardLabel {
179             my $self = shift;
180             $self->{'StandardLabel'} = shift
181             }
182              
183             =head2 getStandardLabel()
184              
185             Calls: GeteBayDetails
186             Returned: Conditionally
187              
188             # Returns: 'xs:string'
189              
190             =cut
191              
192             sub getStandardLabel {
193             my $self = shift;
194             return $self->{'StandardLabel'};
195             }
196              
197              
198             =head2 setStandardOffset()
199              
200             The offset in hours from GMT for a time zone when it is not adjusted for
201             daylight saving time.
202              
203             # Argument: 'xs:string'
204              
205             =cut
206              
207             sub setStandardOffset {
208             my $self = shift;
209             $self->{'StandardOffset'} = shift
210             }
211              
212             =head2 getStandardOffset()
213              
214             Calls: GeteBayDetails
215             Returned: Conditionally
216              
217             # Returns: 'xs:string'
218              
219             =cut
220              
221             sub getStandardOffset {
222             my $self = shift;
223             return $self->{'StandardOffset'};
224             }
225              
226              
227             =head2 setTimeZoneID()
228              
229             A unique identifier for a given time zone. This ID does not change for a
230             given time zone, even if the time zone supports both standard and daylight
231             saving time variants. Valid values for TimeZoneID correspond to OLSON IDs.
232             These IDs provide not only the information as to the offset from GMT (UTC),
233             but also daylight saving time information. Thus, for example, America/Phoenix
234             is distinct from America/Denver because they have different daylight saving
235             time behavior. This value is not localized.
236              
237             SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=TimeValues
238             Title: Time Values
239             , URL: http://unicode.org/cldr/data/docs/design/formatting/zone_log.html
240             Title: Olson ID Comparison
241              
242              
243             # Argument: 'xs:string'
244              
245             =cut
246              
247             sub setTimeZoneID {
248             my $self = shift;
249             $self->{'TimeZoneID'} = shift
250             }
251              
252             =head2 getTimeZoneID()
253              
254             Calls: GeteBayDetails
255             Returned: Conditionally
256              
257             # Returns: 'xs:string'
258              
259             =cut
260              
261             sub getTimeZoneID {
262             my $self = shift;
263             return $self->{'TimeZoneID'};
264             }
265              
266              
267              
268              
269              
270             ## Attribute and Property lists
271             sub getPropertiesList {
272             my $self = shift;
273             return \@gaProperties;
274             }
275              
276             sub getAttributesList {
277             my $self = shift;
278             return \@gaAttributes;
279             }
280              
281              
282              
283             1;