File Coverage

lib/eBay/API/XML/Call/GetSessionID.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::GetSessionID;
4              
5 1     1   2356 use strict;
  1         3  
  1         27  
6 1     1   4 use warnings;
  1         3  
  1         25  
7              
8             ##########################################################################
9             #
10             # Module: ............... eBay/API/XML
11             # File: ................. GetSessionID.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::GetSessionID
21              
22             =head1 DESCRIPTION
23              
24              
25              
26             =head1 SYNOPSIS
27              
28             =cut
29              
30              
31             =head1 INHERITANCE
32              
33             eBay::API::XML::Call::GetSessionID inherits from the L class
34              
35             =cut
36              
37 1     1   32 use eBay::API::XML::BaseCall;
  0            
  0            
38             our @ISA = ("eBay::API::XML::BaseCall");
39              
40             use eBay::API::XML::Call::GetSessionID::GetSessionIDRequestType;
41             use eBay::API::XML::Call::GetSessionID::GetSessionIDResponseType;
42              
43              
44             =head1 Subroutines:
45              
46             =cut
47              
48             sub getApiCallName {
49             return 'GetSessionID';
50             }
51             sub getRequestDataTypeFullPackage {
52             return 'eBay::API::XML::Call::GetSessionID::GetSessionIDRequestType';
53             }
54             sub getResponseDataTypeFullPackage {
55             return 'eBay::API::XML::Call::GetSessionID::GetSessionIDResponseType';
56             }
57              
58             #
59             # input properties
60             #
61              
62             =head2 setRuName()
63              
64             The runame provided must match the one that will be used for validation
65             during the creation of a user token.
66              
67             RequiredInput: Yes
68             # Argument: 'xs:string'
69              
70             =cut
71            
72             sub setRuName {
73             my $self = shift;
74             my $sRuName = shift;
75             $self->getRequestDataType()->setRuName($sRuName);
76             }
77              
78              
79              
80             #
81             # output properties
82             #
83              
84             =head2 getSessionID()
85              
86             A 32-character identifier supplied by eBay to an application. Used to confirm the
87             identities of the user and the application in a URL redirect during the
88             process in which the user agrees to let the application wield a user token that
89             grants the application the right to access eBay data on behalf of the user.
90             Subsequently also used as input for the FetchToken API call.
91              
92             Returned: Always
93             # Returns: 'xs:string'
94              
95             =cut
96            
97             sub getSessionID {
98             my $self = shift;
99             return $self->getResponseDataType()->getSessionID();
100             }
101              
102              
103              
104              
105              
106             1;