File Coverage

lib/eBay/API/XML/Call/GetUserDisputes/GetUserDisputesRequestType.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::GetUserDisputes::GetUserDisputesRequestType;
4              
5 1     1   1475 use strict;
  1         2  
  1         27  
6 1     1   4 use warnings;
  1         2  
  1         25  
7              
8             ##########################################################################
9             #
10             # Module: ............... eBay/API/XML
11             # File: ................. GetUserDisputesRequestType.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::GetUserDisputes::GetUserDisputesRequestType
21              
22             =head1 DESCRIPTION
23              
24             Requests a list of disputes the requester is involved in as buyer or seller.
25             The list includes both Unpaid Item and Item Not Received disputes and can
26             be filtered according to DisputeFilterType. Use a DetailLevel of ReturnAll to
27             return all data about each dispute, including DisputeResolution and DisputeMessage
28             elements.
29              
30              
31              
32             =head1 SYNOPSIS
33              
34             =cut
35              
36              
37             =head1 INHERITANCE
38              
39             eBay::API::XML::Call::GetUserDisputes::GetUserDisputesRequestType inherits from the L class
40              
41             =cut
42              
43 1     1   33 use eBay::API::XML::RequestDataType;
  0            
  0            
44             our @ISA = ("eBay::API::XML::RequestDataType");
45              
46             use eBay::API::XML::DataType::PaginationType;
47             use eBay::API::XML::DataType::Enum::DisputeFilterTypeCodeType;
48             use eBay::API::XML::DataType::Enum::DisputeSortTypeCodeType;
49              
50              
51             my @gaProperties = ( [ 'DisputeFilterType', 'ns:DisputeFilterTypeCodeType', ''
52             ,'eBay::API::XML::DataType::Enum::DisputeFilterTypeCodeType', '' ]
53             , [ 'DisputeSortType', 'ns:DisputeSortTypeCodeType', ''
54             ,'eBay::API::XML::DataType::Enum::DisputeSortTypeCodeType', '' ]
55             , [ 'ModTimeFrom', 'xs:dateTime', '', '', '' ]
56             , [ 'ModTimeTo', 'xs:dateTime', '', '', '' ]
57             , [ 'Pagination', 'ns:PaginationType', ''
58             ,'eBay::API::XML::DataType::PaginationType', '1' ]
59             );
60             push @gaProperties, @{eBay::API::XML::RequestDataType::getPropertiesList()};
61              
62             my @gaAttributes = (
63             );
64             push @gaAttributes, @{eBay::API::XML::RequestDataType::getAttributesList()};
65              
66             =head1 Subroutines:
67              
68             =cut
69              
70             sub new {
71             my $classname = shift;
72             my %args = @_;
73             my $self = $classname->SUPER::new(%args);
74             return $self;
75             }
76              
77             sub isScalar {
78             return 0;
79             }
80              
81              
82              
83             =head2 setDisputeFilterType()
84              
85             A filter that specifies a subset of disputes to return. The return list
86             includes both Item Not Received and Unpaid Item disputes.
87              
88             RequiredInput: No
89             # Argument: 'ns:DisputeFilterTypeCodeType'
90              
91             =cut
92              
93             sub setDisputeFilterType {
94             my $self = shift;
95             $self->{'DisputeFilterType'} = shift
96             }
97              
98             =head2 getDisputeFilterType()
99              
100             # Returns: 'ns:DisputeFilterTypeCodeType'
101              
102             =cut
103              
104             sub getDisputeFilterType {
105             my $self = shift;
106             return $self->{'DisputeFilterType'};
107             }
108              
109              
110             =head2 setDisputeSortType()
111              
112             The value and sequence to use to sort the returned disputes.
113              
114             RequiredInput: No
115             # Argument: 'ns:DisputeSortTypeCodeType'
116              
117             =cut
118              
119             sub setDisputeSortType {
120             my $self = shift;
121             $self->{'DisputeSortType'} = shift
122             }
123              
124             =head2 getDisputeSortType()
125              
126             # Returns: 'ns:DisputeSortTypeCodeType'
127              
128             =cut
129              
130             sub getDisputeSortType {
131             my $self = shift;
132             return $self->{'DisputeSortType'};
133             }
134              
135              
136             =head2 setModTimeFrom()
137              
138             A filter that retrieves disputes whose DisputeModifiedTime is later
139             than or equal to this value. Specify the time value in GMT.
140             See the eBay Web Services documentation for information about specifying time values.
141             For more precise control of the date range filter, it is a good practice to also
142             specify ModTimeTo. Otherwise, the end of the date range is the present time.
143             Filtering by date range is optional. You can use date range filters in combination
144             with other filters like DisputeFilterType to control the amount of data returned.
145              
146             RequiredInput: No
147             # Argument: 'xs:dateTime'
148              
149             =cut
150              
151             sub setModTimeFrom {
152             my $self = shift;
153             $self->{'ModTimeFrom'} = shift
154             }
155              
156             =head2 getModTimeFrom()
157              
158             # Returns: 'xs:dateTime'
159              
160             =cut
161              
162             sub getModTimeFrom {
163             my $self = shift;
164             return $self->{'ModTimeFrom'};
165             }
166              
167              
168             =head2 setModTimeTo()
169              
170             A filter that retrieves disputes whose DisputeModifiedTime is earlier
171             than or equal to this value. Specify the time value in GMT.
172             See the eBay Web Services documentation for information about specifying time values.
173             For more precise control of the date range filter, it is a good practice to also
174             specify ModTimeFrom. Otherwise, all available disputes modified prior to the ModTimeTo value are returned.
175             Filtering by date range is optional. You can use date range filters in combination
176             with other filters like DisputeFilterType to control the amount of data returned.
177              
178             RequiredInput: No
179             # Argument: 'xs:dateTime'
180              
181             =cut
182              
183             sub setModTimeTo {
184             my $self = shift;
185             $self->{'ModTimeTo'} = shift
186             }
187              
188             =head2 getModTimeTo()
189              
190             # Returns: 'xs:dateTime'
191              
192             =cut
193              
194             sub getModTimeTo {
195             my $self = shift;
196             return $self->{'ModTimeTo'};
197             }
198              
199              
200             =head2 setPagination()
201              
202             The virtual page number of the result set to display. A result set has a number of disputes
203             divided into virtual pages, with 200 disputes per page. The response can only display one page.
204             The first page in the result set is number 1. Required. If not specified, a warning is returned
205             and Pagination.PageNumber is set to 1 by default.
206              
207             RequiredInput: Yes
208             # Argument: 'ns:PaginationType'
209              
210             =cut
211              
212             sub setPagination {
213             my $self = shift;
214             $self->{'Pagination'} = shift
215             }
216              
217             =head2 getPagination()
218              
219             # Returns: 'ns:PaginationType'
220              
221             =cut
222              
223             sub getPagination {
224             my $self = shift;
225             return $self->_getDataTypeInstance( 'Pagination'
226             ,'eBay::API::XML::DataType::PaginationType');
227             }
228              
229              
230              
231              
232              
233             ## Attribute and Property lists
234             sub getPropertiesList {
235             my $self = shift;
236             return \@gaProperties;
237             }
238              
239             sub getAttributesList {
240             my $self = shift;
241             return \@gaAttributes;
242             }
243              
244              
245              
246             1;