File Coverage

lib/eBay/API/XML/Call/GetUser.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::GetUser;
4              
5 1     1   2309 use strict;
  1         2  
  1         31  
6 1     1   4 use warnings;
  1         3  
  1         27  
7              
8             ##########################################################################
9             #
10             # Module: ............... eBay/API/XML
11             # File: ................. GetUser.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::GetUser
21              
22             =head1 DESCRIPTION
23              
24              
25              
26             =head1 SYNOPSIS
27              
28             =cut
29              
30              
31             =head1 INHERITANCE
32              
33             eBay::API::XML::Call::GetUser inherits from the L class
34              
35             =cut
36              
37 1     1   33 use eBay::API::XML::BaseCall;
  0            
  0            
38             our @ISA = ("eBay::API::XML::BaseCall");
39              
40             use eBay::API::XML::Call::GetUser::GetUserRequestType;
41             use eBay::API::XML::Call::GetUser::GetUserResponseType;
42              
43              
44             =head1 Subroutines:
45              
46             =cut
47              
48             sub getApiCallName {
49             return 'GetUser';
50             }
51             sub getRequestDataTypeFullPackage {
52             return 'eBay::API::XML::Call::GetUser::GetUserRequestType';
53             }
54             sub getResponseDataTypeFullPackage {
55             return 'eBay::API::XML::Call::GetUser::GetUserResponseType';
56             }
57              
58             #
59             # input properties
60             #
61              
62             =head2 setIncludeExpressRequirements()
63              
64             Indicates if the response should include detailed information relating to
65             whether a user qualifies to list an item on Express. To list an item on Express, a user must qualify based on conditions described in the eBay Web Services Guide.
66              
67             Default: false
68             SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ExpressSellerCriteria
69             Title: Seller Criteria for eBay Express
70              
71             RequiredInput: No
72             # Argument: 'xs:boolean'
73              
74             =cut
75            
76             sub setIncludeExpressRequirements {
77             my $self = shift;
78             my $sIncludeExpressRequirements = shift;
79             $self->getRequestDataType()->setIncludeExpressRequirements($sIncludeExpressRequirements);
80             }
81              
82             =head2 setItemID()
83              
84             Specifies the item ID for a successfully concluded listing in which
85             the requestor and target user were participants (one as seller and
86             the other as buyer). Necessary to return certain data (like an email
87             address). Not necessary if the requestor is retrieving their own data.
88             ItemID is an optional input.
89              
90             MaxLength: 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits)
91              
92             RequiredInput: No
93             # Argument: 'ns:ItemIDType'
94              
95             =cut
96            
97             sub setItemID {
98             my $self = shift;
99             my $pItemID = shift;
100             $self->getRequestDataType()->setItemID($pItemID);
101             }
102              
103             =head2 setUserID()
104              
105             Specifies the user whose data will be returned by the call. UserID is
106             optional. If not specified, the user data returned is for
107             the requesting user (as specified with the eBayAuthToken).
108              
109             RequiredInput: No
110             # Argument: 'xs:string'
111              
112             =cut
113            
114             sub setUserID {
115             my $self = shift;
116             my $sUserID = shift;
117             $self->getRequestDataType()->setUserID($sUserID);
118             }
119              
120              
121              
122             #
123             # output properties
124             #
125              
126             =head2 getUser()
127              
128             Contains the returned user data for the specified eBay user.
129              
130             Returned: Always
131             Details: DetailLevel: none, ReturnSummary, ReturnAll
132             # Returns: 'ns:UserType'
133              
134             =cut
135            
136             sub getUser {
137             my $self = shift;
138             return $self->getResponseDataType()->getUser();
139             }
140              
141              
142              
143              
144              
145             1;