File Coverage

lib/eBay/API/XML/Call/GetVeROReasonCodeDetails/GetVeROReasonCodeDetailsRequestType.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::GetVeROReasonCodeDetails::GetVeROReasonCodeDetailsRequestType;
4              
5 1     1   1426 use strict;
  1         2  
  1         33  
6 1     1   5 use warnings;
  1         1  
  1         28  
7              
8             ##########################################################################
9             #
10             # Module: ............... eBay/API/XML
11             # File: ................. GetVeROReasonCodeDetailsRequestType.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::GetVeROReasonCodeDetails::GetVeROReasonCodeDetailsRequestType
21              
22             =head1 DESCRIPTION
23              
24             Retrieves details for VeRO reason codes and their descriptions. You can specify a
25             reason code ID to get details for a specific reason on the site specified in the
26             request header. If ReasonCodeID is not passed in the request, all reason codes are
27             returned. Set ReturnAllSites to true to retrieve reason codes for all sites.
28             You must be a member of the Verified Rights Owner (VeRO) Program to use this call.
29              
30              
31              
32             =head1 SYNOPSIS
33              
34             =cut
35              
36              
37             =head1 INHERITANCE
38              
39             eBay::API::XML::Call::GetVeROReasonCodeDetails::GetVeROReasonCodeDetailsRequestType inherits from the L class
40              
41             =cut
42              
43 1     1   42 use eBay::API::XML::RequestDataType;
  0            
  0            
44             our @ISA = ("eBay::API::XML::RequestDataType");
45              
46              
47              
48             my @gaProperties = ( [ 'ReasonCodeID', 'xs:long', '', '', '' ]
49             , [ 'ReturnAllSites', 'xs:boolean', '', '', '' ]
50             );
51             push @gaProperties, @{eBay::API::XML::RequestDataType::getPropertiesList()};
52              
53             my @gaAttributes = (
54             );
55             push @gaAttributes, @{eBay::API::XML::RequestDataType::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 setReasonCodeID()
75              
76             Unique identifier for a reason code. If this ReasonCodeID is passed then
77             only details of this ReasonCodeID will be returned. If no reason code is
78             specified, all reason codes are returned.
79              
80             Max: Default: Min:
81             RequiredInput: Conditionally
82             # Argument: 'xs:long'
83              
84             =cut
85              
86             sub setReasonCodeID {
87             my $self = shift;
88             $self->{'ReasonCodeID'} = shift
89             }
90              
91             =head2 getReasonCodeID()
92              
93             # Returns: 'xs:long'
94              
95             =cut
96              
97             sub getReasonCodeID {
98             my $self = shift;
99             return $self->{'ReasonCodeID'};
100             }
101              
102              
103             =head2 setReturnAllSites()
104              
105             Set to true to retrieve reason codes for all sites. If not specified,
106             reason codes are returned for the site specified in the request header
107             only.
108             If ReasonCodeID is specified, this parameter is ignored.
109              
110             Default: false
111              
112             RequiredInput: No
113             # Argument: 'xs:boolean'
114              
115             =cut
116              
117             sub setReturnAllSites {
118             my $self = shift;
119             $self->{'ReturnAllSites'} = shift
120             }
121              
122             =head2 isReturnAllSites()
123              
124             # Returns: 'xs:boolean'
125              
126             =cut
127              
128             sub isReturnAllSites {
129             my $self = shift;
130             return $self->{'ReturnAllSites'};
131             }
132              
133              
134              
135              
136              
137             ## Attribute and Property lists
138             sub getPropertiesList {
139             my $self = shift;
140             return \@gaProperties;
141             }
142              
143             sub getAttributesList {
144             my $self = shift;
145             return \@gaAttributes;
146             }
147              
148              
149              
150             1;