File Coverage

lib/eBay/API/XML/Call/GetPromotionRules.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::GetPromotionRules;
4              
5 1     1   2439 use strict;
  1         2  
  1         29  
6 1     1   8 use warnings;
  1         3  
  1         31  
7              
8             ##########################################################################
9             #
10             # Module: ............... eBay/API/XML
11             # File: ................. GetPromotionRules.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::GetPromotionRules
21              
22             =head1 DESCRIPTION
23              
24              
25              
26             =head1 SYNOPSIS
27              
28             =cut
29              
30              
31             =head1 INHERITANCE
32              
33             eBay::API::XML::Call::GetPromotionRules inherits from the L class
34              
35             =cut
36              
37 1     1   44 use eBay::API::XML::BaseCall;
  0            
  0            
38             our @ISA = ("eBay::API::XML::BaseCall");
39              
40             use eBay::API::XML::Call::GetPromotionRules::GetPromotionRulesRequestType;
41             use eBay::API::XML::Call::GetPromotionRules::GetPromotionRulesResponseType;
42              
43              
44             =head1 Subroutines:
45              
46             =cut
47              
48             sub getApiCallName {
49             return 'GetPromotionRules';
50             }
51             sub getRequestDataTypeFullPackage {
52             return 'eBay::API::XML::Call::GetPromotionRules::GetPromotionRulesRequestType';
53             }
54             sub getResponseDataTypeFullPackage {
55             return 'eBay::API::XML::Call::GetPromotionRules::GetPromotionRulesResponseType';
56             }
57              
58             #
59             # input properties
60             #
61              
62             =head2 setItemID()
63              
64             The unique ID of the item for which to retrieve promotion rules.
65             Mutually exclusive with StoreCategoryID.
66              
67             MaxLength: 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits)
68              
69             RequiredInput: Conditionally
70             # Argument: 'ns:ItemIDType'
71              
72             =cut
73            
74             sub setItemID {
75             my $self = shift;
76             my $pItemID = shift;
77             $self->getRequestDataType()->setItemID($pItemID);
78             }
79              
80             =head2 setPromotionMethod()
81              
82             The type of promotion. (CrossSell: items that are related to or
83             useful in combination with this item. UpSell: items that are more
84             expensive than or of higher quality than this item.)
85              
86             RequiredInput: Yes
87             # Argument: 'ns:PromotionMethodCodeType'
88              
89             =cut
90            
91             sub setPromotionMethod {
92             my $self = shift;
93             my $sPromotionMethod = shift;
94             $self->getRequestDataType()->setPromotionMethod($sPromotionMethod);
95             }
96              
97             =head2 setStoreCategoryID()
98              
99             The unique ID of the store category for which to retrieve promotion rules.
100             Mutually exclusive with ItemID.
101              
102             RequiredInput: Conditionally
103             # Argument: 'xs:long'
104              
105             =cut
106            
107             sub setStoreCategoryID {
108             my $self = shift;
109             my $sStoreCategoryID = shift;
110             $self->getRequestDataType()->setStoreCategoryID($sStoreCategoryID);
111             }
112              
113              
114              
115             #
116             # output properties
117             #
118              
119             =head2 getPromotionRuleArray()
120              
121             An array of promotion rules associated with the item or store category
122             specified in the request.
123              
124             Returned: Always
125             # Returns: 'ns:PromotionRuleArrayType'
126              
127             =cut
128            
129             sub getPromotionRuleArray {
130             my $self = shift;
131             return $self->getResponseDataType()->getPromotionRuleArray();
132             }
133              
134              
135              
136              
137              
138             1;