File Coverage

lib/eBay/API/XML/Call/AddToWatchList.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::AddToWatchList;
4              
5 1     1   2351 use strict;
  1         2  
  1         24  
6 1     1   5 use warnings;
  1         1  
  1         29  
7              
8             ##########################################################################
9             #
10             # Module: ............... eBay/API/XML
11             # File: ................. AddToWatchList.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::AddToWatchList
21              
22             =head1 DESCRIPTION
23              
24              
25              
26             =head1 SYNOPSIS
27              
28             =cut
29              
30              
31             =head1 INHERITANCE
32              
33             eBay::API::XML::Call::AddToWatchList 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::AddToWatchList::AddToWatchListRequestType;
41             use eBay::API::XML::Call::AddToWatchList::AddToWatchListResponseType;
42              
43              
44             =head1 Subroutines:
45              
46             =cut
47              
48             sub getApiCallName {
49             return 'AddToWatchList';
50             }
51             sub getRequestDataTypeFullPackage {
52             return 'eBay::API::XML::Call::AddToWatchList::AddToWatchListRequestType';
53             }
54             sub getResponseDataTypeFullPackage {
55             return 'eBay::API::XML::Call::AddToWatchList::AddToWatchListResponseType';
56             }
57              
58             #
59             # input properties
60             #
61              
62             =head2 setItemID()
63              
64             The ItemID of the item that is to be added to the watch list. The item
65             must be a currently active item, and the total number of items in the
66             watchlist (after the items in the request have been added) cannot exceed
67             the maximum allowed number of watch list items. One or more ItemIDs can be
68             specified, each in its own ItemID container. A separate error node will be
69             returned for each item that fails.
70              
71             MaxLength: 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits)
72              
73             RequiredInput: Yes
74             # Argument: reference to an array
75             of 'ns:ItemIDType'
76              
77             =cut
78            
79             sub setItemID {
80             my $self = shift;
81             my $pItemID = shift;
82             $self->getRequestDataType()->setItemID($pItemID);
83             }
84              
85              
86              
87             #
88             # output properties
89             #
90              
91             =head2 getWatchListCount()
92              
93             The number of items in the user's watch list (after those specified
94             in the call request have been added)
95              
96             Returned: Always
97             # Returns: 'xs:int'
98              
99             =cut
100            
101             sub getWatchListCount {
102             my $self = shift;
103             return $self->getResponseDataType()->getWatchListCount();
104             }
105              
106             =head2 getWatchListMaximum()
107              
108             The maximum number of items allowed in watch lists. Currently this
109             value is the same for all sites and all users.
110              
111             Returned: Always
112             # Returns: 'xs:int'
113              
114             =cut
115            
116             sub getWatchListMaximum {
117             my $self = shift;
118             return $self->getResponseDataType()->getWatchListMaximum();
119             }
120              
121              
122              
123              
124              
125             1;