File Coverage

lib/eBay/API/XML/Call/RemoveFromWatchList.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::RemoveFromWatchList;
4              
5 1     1   3273 use strict;
  1         2  
  1         39  
6 1     1   6 use warnings;
  1         2  
  1         37  
7              
8             ##########################################################################
9             #
10             # Module: ............... eBay/API/XML
11             # File: ................. RemoveFromWatchList.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::RemoveFromWatchList
21              
22             =head1 DESCRIPTION
23              
24              
25              
26             =head1 SYNOPSIS
27              
28             =cut
29              
30              
31             =head1 INHERITANCE
32              
33             eBay::API::XML::Call::RemoveFromWatchList inherits from the L class
34              
35             =cut
36              
37 1     1   41 use eBay::API::XML::BaseCall;
  0            
  0            
38             our @ISA = ("eBay::API::XML::BaseCall");
39              
40             use eBay::API::XML::Call::RemoveFromWatchList::RemoveFromWatchListRequestType;
41             use eBay::API::XML::Call::RemoveFromWatchList::RemoveFromWatchListResponseType;
42              
43              
44             =head1 Subroutines:
45              
46             =cut
47              
48             sub getApiCallName {
49             return 'RemoveFromWatchList';
50             }
51             sub getRequestDataTypeFullPackage {
52             return 'eBay::API::XML::Call::RemoveFromWatchList::RemoveFromWatchListRequestType';
53             }
54             sub getResponseDataTypeFullPackage {
55             return 'eBay::API::XML::Call::RemoveFromWatchList::RemoveFromWatchListResponseType';
56             }
57              
58             #
59             # input properties
60             #
61              
62             =head2 setItemID()
63              
64             The ID of the item to be removed from the
65             watch list. Either ItemID or RemoveAllItems must
66             be specified, but NOT both. One or more Item IDs
67             can be specified, each in it's own ItemID container.
68              
69             MaxLength: 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits)
70              
71             RequiredInput: Conditionally
72             # Argument: reference to an array
73             of 'ns:ItemIDType'
74              
75             =cut
76            
77             sub setItemID {
78             my $self = shift;
79             my $pItemID = shift;
80             $self->getRequestDataType()->setItemID($pItemID);
81             }
82              
83             =head2 setRemoveAllItems()
84              
85             If true, then all the items in the user's
86             watch list are removed. Either ItemID or
87             RemoveAllItems must be specified, but NOT both.
88              
89             RequiredInput: Conditionally
90             # Argument: 'xs:boolean'
91              
92             =cut
93            
94             sub setRemoveAllItems {
95             my $self = shift;
96             my $sRemoveAllItems = shift;
97             $self->getRequestDataType()->setRemoveAllItems($sRemoveAllItems);
98             }
99              
100              
101              
102             #
103             # output properties
104             #
105              
106             =head2 getWatchListCount()
107              
108             The current number of items in the user's watch list (after those
109             specified in the call request have been removed)
110              
111             Returned: Always
112             # Returns: 'xs:int'
113              
114             =cut
115            
116             sub getWatchListCount {
117             my $self = shift;
118             return $self->getResponseDataType()->getWatchListCount();
119             }
120              
121             =head2 getWatchListMaximum()
122              
123             The maximum number of items allowed in watch lists. Currently this value
124             is 200, and is the same for all sites and all users.
125              
126             Returned: Always
127             # Returns: 'xs:int'
128              
129             =cut
130            
131             sub getWatchListMaximum {
132             my $self = shift;
133             return $self->getResponseDataType()->getWatchListMaximum();
134             }
135              
136              
137              
138              
139              
140             1;