File Coverage

lib/eBay/API/XML/DataType/NotificationStatisticsType.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::NotificationStatisticsType;
4              
5 1     1   1144 use strict;
  1         3  
  1         35  
6 1     1   5 use warnings;
  1         4  
  1         32  
7              
8             ##########################################################################
9             #
10             # Module: ............... eBay/API/XML
11             # File: ................. NotificationStatisticsType.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::NotificationStatisticsType
21              
22             =head1 DESCRIPTION
23              
24             Summary information about notifications delivered, failed, errors, queued for
25             a given application ID and time period.
26              
27              
28              
29             =head1 SYNOPSIS
30              
31             =cut
32              
33              
34             =head1 INHERITANCE
35              
36             eBay::API::XML::DataType::NotificationStatisticsType inherits from the L class
37              
38             =cut
39              
40 1     1   40 use eBay::API::XML::BaseDataType;
  0            
  0            
41             our @ISA = ("eBay::API::XML::BaseDataType");
42              
43              
44              
45             my @gaProperties = ( [ 'DeliveredCount', 'xs:int', '', '', '' ]
46             , [ 'ErrorCount', 'xs:int', '', '', '' ]
47             , [ 'ExpiredCount', 'xs:int', '', '', '' ]
48             , [ 'QueuedNewCount', 'xs:int', '', '', '' ]
49             , [ 'QueuedPendingCount', 'xs:int', '', '', '' ]
50             );
51             push @gaProperties, @{eBay::API::XML::BaseDataType::getPropertiesList()};
52              
53             my @gaAttributes = (
54             );
55             push @gaAttributes, @{eBay::API::XML::BaseDataType::getAttributesList()};
56              
57             =head1 Subroutines:
58              
59             =cut
60              
61             sub new {
62             my $classname = shift;
63             my %args = @_;
64             my $self = $classname->SUPER::new(%args);
65             return $self;
66             }
67              
68             sub isScalar {
69             return 0;
70             }
71              
72              
73              
74             =head2 setDeliveredCount()
75              
76             Returns the number of notifications delivered successfully during the given
77             time period.
78              
79             # Argument: 'xs:int'
80              
81             =cut
82              
83             sub setDeliveredCount {
84             my $self = shift;
85             $self->{'DeliveredCount'} = shift
86             }
87              
88             =head2 getDeliveredCount()
89              
90             Calls: GetNotificationsUsage
91             Returned: Always
92              
93             # Returns: 'xs:int'
94              
95             =cut
96              
97             sub getDeliveredCount {
98             my $self = shift;
99             return $self->{'DeliveredCount'};
100             }
101              
102              
103             =head2 setErrorCount()
104              
105             Returns the number of notifications for which there were delivery errors
106             during the given time period.
107              
108             # Argument: 'xs:int'
109              
110             =cut
111              
112             sub setErrorCount {
113             my $self = shift;
114             $self->{'ErrorCount'} = shift
115             }
116              
117             =head2 getErrorCount()
118              
119             Calls: GetNotificationsUsage
120             Returned: Always
121              
122             # Returns: 'xs:int'
123              
124             =cut
125              
126             sub getErrorCount {
127             my $self = shift;
128             return $self->{'ErrorCount'};
129             }
130              
131              
132             =head2 setExpiredCount()
133              
134             Returns the number of notifications that permanently failed during
135             the given time period.
136              
137             # Argument: 'xs:int'
138              
139             =cut
140              
141             sub setExpiredCount {
142             my $self = shift;
143             $self->{'ExpiredCount'} = shift
144             }
145              
146             =head2 getExpiredCount()
147              
148             Calls: GetNotificationsUsage
149             Returned: Always
150              
151             # Returns: 'xs:int'
152              
153             =cut
154              
155             sub getExpiredCount {
156             my $self = shift;
157             return $self->{'ExpiredCount'};
158             }
159              
160              
161             =head2 setQueuedNewCount()
162              
163             Returns the number of new notifications that were queued during
164             the given time period.
165              
166             # Argument: 'xs:int'
167              
168             =cut
169              
170             sub setQueuedNewCount {
171             my $self = shift;
172             $self->{'QueuedNewCount'} = shift
173             }
174              
175             =head2 getQueuedNewCount()
176              
177             Calls: GetNotificationsUsage
178             Returned: Always
179              
180             # Returns: 'xs:int'
181              
182             =cut
183              
184             sub getQueuedNewCount {
185             my $self = shift;
186             return $self->{'QueuedNewCount'};
187             }
188              
189              
190             =head2 setQueuedPendingCount()
191              
192             Returns the number of pending notifications in the queue during
193             the given time period.
194              
195             # Argument: 'xs:int'
196              
197             =cut
198              
199             sub setQueuedPendingCount {
200             my $self = shift;
201             $self->{'QueuedPendingCount'} = shift
202             }
203              
204             =head2 getQueuedPendingCount()
205              
206             Calls: GetNotificationsUsage
207             Returned: Always
208              
209             # Returns: 'xs:int'
210              
211             =cut
212              
213             sub getQueuedPendingCount {
214             my $self = shift;
215             return $self->{'QueuedPendingCount'};
216             }
217              
218              
219              
220              
221              
222             ## Attribute and Property lists
223             sub getPropertiesList {
224             my $self = shift;
225             return \@gaProperties;
226             }
227              
228             sub getAttributesList {
229             my $self = shift;
230             return \@gaAttributes;
231             }
232              
233              
234              
235             1;