File Coverage

lib/eBay/API/XML/Call/ValidateChallengeInput/ValidateChallengeInputRequestType.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::ValidateChallengeInput::ValidateChallengeInputRequestType;
4              
5 1     1   1197 use strict;
  1         2  
  1         24  
6 1     1   5 use warnings;
  1         2  
  1         25  
7              
8             ##########################################################################
9             #
10             # Module: ............... eBay/API/XML
11             # File: ................. ValidateChallengeInputRequestType.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::ValidateChallengeInput::ValidateChallengeInputRequestType
21              
22             =head1 DESCRIPTION
23              
24             Validates the user response to a GetChallengeToken botblock challenge.
25              
26              
27              
28             =head1 SYNOPSIS
29              
30             =cut
31              
32              
33             =head1 INHERITANCE
34              
35             eBay::API::XML::Call::ValidateChallengeInput::ValidateChallengeInputRequestType inherits from the L class
36              
37             =cut
38              
39 1     1   490 use eBay::API::XML::RequestDataType;
  0            
  0            
40             our @ISA = ("eBay::API::XML::RequestDataType");
41              
42              
43              
44             my @gaProperties = ( [ 'ChallengeToken', 'xs:string', '', '', '' ]
45             , [ 'KeepTokenValid', 'xs:boolean', '', '', '' ]
46             , [ 'UserInput', 'xs:string', '', '', '' ]
47             );
48             push @gaProperties, @{eBay::API::XML::RequestDataType::getPropertiesList()};
49              
50             my @gaAttributes = (
51             );
52             push @gaAttributes, @{eBay::API::XML::RequestDataType::getAttributesList()};
53              
54             =head1 Subroutines:
55              
56             =cut
57              
58             sub new {
59             my $classname = shift;
60             my %args = @_;
61             my $self = $classname->SUPER::new(%args);
62             return $self;
63             }
64              
65             sub isScalar {
66             return 0;
67             }
68              
69              
70              
71             =head2 setChallengeToken()
72              
73             Botblock token that was returned by GetChallengeToken.
74              
75             RequiredInput: Yes
76             # Argument: 'xs:string'
77              
78             =cut
79              
80             sub setChallengeToken {
81             my $self = shift;
82             $self->{'ChallengeToken'} = shift
83             }
84              
85             =head2 getChallengeToken()
86              
87             # Returns: 'xs:string'
88              
89             =cut
90              
91             sub getChallengeToken {
92             my $self = shift;
93             return $self->{'ChallengeToken'};
94             }
95              
96              
97             =head2 setKeepTokenValid()
98              
99             Whether the challenge token should remain valid for up to two minutes.
100              
101             Default: false
102              
103             RequiredInput: No
104             # Argument: 'xs:boolean'
105              
106             =cut
107              
108             sub setKeepTokenValid {
109             my $self = shift;
110             $self->{'KeepTokenValid'} = shift
111             }
112              
113             =head2 isKeepTokenValid()
114              
115             # Returns: 'xs:boolean'
116              
117             =cut
118              
119             sub isKeepTokenValid {
120             my $self = shift;
121             return $self->{'KeepTokenValid'};
122             }
123              
124              
125             =head2 setUserInput()
126              
127             User response to a botblock challenge.
128              
129             RequiredInput: Yes
130             # Argument: 'xs:string'
131              
132             =cut
133              
134             sub setUserInput {
135             my $self = shift;
136             $self->{'UserInput'} = shift
137             }
138              
139             =head2 getUserInput()
140              
141             # Returns: 'xs:string'
142              
143             =cut
144              
145             sub getUserInput {
146             my $self = shift;
147             return $self->{'UserInput'};
148             }
149              
150              
151              
152              
153              
154             ## Attribute and Property lists
155             sub getPropertiesList {
156             my $self = shift;
157             return \@gaProperties;
158             }
159              
160             sub getAttributesList {
161             my $self = shift;
162             return \@gaAttributes;
163             }
164              
165              
166              
167             1;