File Coverage

lib/eBay/API/XML/DataType/XMLRequesterCredentialsType.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::XMLRequesterCredentialsType;
4              
5 1     1   1462 use strict;
  1         2  
  1         33  
6 1     1   6 use warnings;
  1         1  
  1         39  
7              
8             ##########################################################################
9             #
10             # Module: ............... eBay/API/XML
11             # File: ................. XMLRequesterCredentialsType.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::XMLRequesterCredentialsType
21              
22             =head1 DESCRIPTION
23              
24              
25              
26             =head1 SYNOPSIS
27              
28             =cut
29              
30              
31             =head1 INHERITANCE
32              
33             eBay::API::XML::DataType::XMLRequesterCredentialsType inherits from the L class
34              
35             =cut
36              
37 1     1   41 use eBay::API::XML::BaseDataType;
  0            
  0            
38             our @ISA = ("eBay::API::XML::BaseDataType");
39              
40              
41              
42             my @gaProperties = ( [ 'Password', 'xs:string', '', '', '' ]
43             , [ 'Username', 'xs:string', '', '', '' ]
44             , [ 'eBayAuthToken', 'xs:string', '', '', '' ]
45             );
46             push @gaProperties, @{eBay::API::XML::BaseDataType::getPropertiesList()};
47              
48             my @gaAttributes = (
49             );
50             push @gaAttributes, @{eBay::API::XML::BaseDataType::getAttributesList()};
51              
52             =head1 Subroutines:
53              
54             =cut
55              
56             sub new {
57             my $classname = shift;
58             my %args = @_;
59             my $self = $classname->SUPER::new(%args);
60             return $self;
61             }
62              
63             sub isScalar {
64             return 0;
65             }
66              
67              
68              
69             =head2 setPassword()
70              
71             Password for the user specified in Username.
72              
73             # Argument: 'xs:string'
74              
75             =cut
76              
77             sub setPassword {
78             my $self = shift;
79             $self->{'Password'} = shift
80             }
81              
82             =head2 getPassword()
83              
84             # Returns: 'xs:string'
85              
86             =cut
87              
88             sub getPassword {
89             my $self = shift;
90             return $self->{'Password'};
91             }
92              
93              
94             =head2 setUsername()
95              
96             eBay user ID (i.e., eBay.com Web site login name) for the user the application
97             is retrieving a token for. This is typically the application's end-user (not
98             the developer).
99              
100             MaxLength: 64
101              
102             Calls: FetchToken
103             RequiredInput: Yes
104              
105             # Argument: 'xs:string'
106              
107             =cut
108              
109             sub setUsername {
110             my $self = shift;
111             $self->{'Username'} = shift
112             }
113              
114             =head2 getUsername()
115              
116             # Returns: 'xs:string'
117              
118             =cut
119              
120             sub getUsername {
121             my $self = shift;
122             return $self->{'Username'};
123             }
124              
125              
126             =head2 setEBayAuthToken()
127              
128             Authentication token representing the user who is making the request. The
129             user's token must be retrieved from eBay. To determine a user's authentication
130             token, see the Authentication and Authorization information in the eBay Web
131             Services guide. For calls that list or retrieve item or transaction data, the
132             user usually needs to be the seller of the item in question or, in some cases,
133             the buyer. Similarly, calls that retrieve user or account data may be
134             restricted to the user whose data is being requested. The documentation for
135             each call includes information about such restrictions.
136              
137             SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AuthNAuth
138             Title: Authentication & Authorization
139             MaxLength: 2000
140              
141             Calls: RequiredInput: Yes
142             AllCallsExcept: FetchToken
143              
144             # Argument: 'xs:string'
145              
146             =cut
147              
148             sub setEBayAuthToken {
149             my $self = shift;
150             $self->{'eBayAuthToken'} = shift
151             }
152              
153             =head2 getEBayAuthToken()
154              
155             # Returns: 'xs:string'
156              
157             =cut
158              
159             sub getEBayAuthToken {
160             my $self = shift;
161             return $self->{'eBayAuthToken'};
162             }
163              
164              
165              
166              
167              
168             ## Attribute and Property lists
169             sub getPropertiesList {
170             my $self = shift;
171             return \@gaProperties;
172             }
173              
174             sub getAttributesList {
175             my $self = shift;
176             return \@gaAttributes;
177             }
178              
179              
180              
181             1;