File Coverage

lib/eBay/API/XML/Call/SetUserNotes.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::SetUserNotes;
4              
5 1     1   2534 use strict;
  1         2  
  1         29  
6 1     1   6 use warnings;
  1         1  
  1         31  
7              
8             ##########################################################################
9             #
10             # Module: ............... eBay/API/XML
11             # File: ................. SetUserNotes.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::SetUserNotes
21              
22             =head1 DESCRIPTION
23              
24              
25              
26             =head1 SYNOPSIS
27              
28             =cut
29              
30              
31             =head1 INHERITANCE
32              
33             eBay::API::XML::Call::SetUserNotes inherits from the L class
34              
35             =cut
36              
37 1     1   47 use eBay::API::XML::BaseCall;
  0            
  0            
38             our @ISA = ("eBay::API::XML::BaseCall");
39              
40             use eBay::API::XML::Call::SetUserNotes::SetUserNotesRequestType;
41             use eBay::API::XML::Call::SetUserNotes::SetUserNotesResponseType;
42              
43              
44             =head1 Subroutines:
45              
46             =cut
47              
48             sub getApiCallName {
49             return 'SetUserNotes';
50             }
51             sub getRequestDataTypeFullPackage {
52             return 'eBay::API::XML::Call::SetUserNotes::SetUserNotesRequestType';
53             }
54             sub getResponseDataTypeFullPackage {
55             return 'eBay::API::XML::Call::SetUserNotes::SetUserNotesResponseType';
56             }
57              
58             #
59             # input properties
60             #
61              
62             =head2 setAction()
63              
64             Specifies whether to add/update the note or delete.
65              
66             RequiredInput: Yes
67             # Argument: 'ns:SetUserNotesActionCodeType'
68              
69             =cut
70            
71             sub setAction {
72             my $self = shift;
73             my $sAction = shift;
74             $self->getRequestDataType()->setAction($sAction);
75             }
76              
77             =head2 setItemID()
78              
79             ID of the item to which the My eBay note will be
80             attached. Notes can only be added to items that are
81             currently being tracked in My eBay.
82              
83             MaxLength: 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits)
84              
85             RequiredInput: Yes
86             # Argument: 'ns:ItemIDType'
87              
88             =cut
89            
90             sub setItemID {
91             my $self = shift;
92             my $pItemID = shift;
93             $self->getRequestDataType()->setItemID($pItemID);
94             }
95              
96             =head2 setNoteText()
97              
98             Text of the note. Maximum 250 characters. Required only
99             if the Action is AddOrUpdate. This note text will
100             completely replace any existing My eBay note for the
101             specified item.
102              
103             MaxLength: 250
104              
105             RequiredInput: Conditionally
106             # Argument: 'xs:string'
107              
108             =cut
109            
110             sub setNoteText {
111             my $self = shift;
112             my $sNoteText = shift;
113             $self->getRequestDataType()->setNoteText($sNoteText);
114             }
115              
116             =head2 setTransactionID()
117              
118             ID of the transaction to which the My eBay note will be
119             attached. Notes can only be added to transactions that are
120             currently being tracked in My eBay.
121             You can see it in the Won list of GetMyeBayBuying if you are the buyer.
122             You can see it from Sold list of GetMyeBaySelling if you are the seller.
123              
124             RequiredInput: No
125             # Argument: 'xs:string'
126              
127             =cut
128            
129             sub setTransactionID {
130             my $self = shift;
131             my $sTransactionID = shift;
132             $self->getRequestDataType()->setTransactionID($sTransactionID);
133             }
134              
135              
136              
137             #
138             # output properties
139             #
140              
141              
142              
143              
144              
145             1;