1 PACKAGE CN_SRP_PMT_PLANS_PUB AS
2 /* $Header: cnpsppas.pls 120.2 2005/10/27 16:03:20 mblum noship $ */
3 /*#
4 * This procedure is used to create, update, and delete payment plan assignments for salesreps individually or in mass.
5 * @rep:scope public
6 * @rep:product CN
7 * @rep:displayname Assign Payment Plans
8 * @rep:lifecycle active
9 * @rep:compatibility S
10 * @rep:category BUSINESS_ENTITY CN_COMP_PLANS
11 */
12 --
13 -- Record type for Srp Payment Plan
14 --
15 TYPE srp_pmt_plans_rec_type IS RECORD
16 (PMT_PLAN_NAME cn_pmt_plans.name%TYPE := CN_API.G_MISS_CHAR,
17 SALESREP_TYPE VARCHAR2(100) := CN_API.G_MISS_CHAR,
18 EMP_NUM VARCHAR2(30) := CN_API.G_MISS_CHAR,
19 START_DATE cn_srp_pmt_plans.start_date%TYPE
20 := CN_API.G_MISS_DATE,
21 END_DATE cn_srp_pmt_plans.end_date%TYPE
22 := CN_API.G_MISS_DATE,
23 MINIMUM_AMOUNT cn_srp_pmt_plans.minimum_amount%TYPE
24 := CN_API.G_MISS_NUM,
25 MAXIMUM_AMOUNT cn_srp_pmt_plans.maximum_amount%TYPE
26 := CN_API.G_MISS_NUM,
27 ORG_ID cn_srp_pmt_plans.org_id%TYPE := NULL,
28 OBJECT_VERSION_NUMBER cn_srp_pmt_plans.object_version_number%TYPE,
29 SRP_ROLE_ID cn_srp_pmt_plans.srp_role_id%TYPE,
30 ROLE_PMT_PLAN_ID cn_srp_pmt_plans.role_pmt_plan_id%TYPE,
31 LOCK_FLAG cn_srp_pmt_plans.lock_flag%TYPE);
32
33 g_miss_srp_pmt_plans_rec srp_pmt_plans_rec_type;
34
35 TYPE srp_pmt_plans_tbl_type IS TABLE OF srp_pmt_plans_rec_type
36 INDEX BY BINARY_INTEGER;
37
38 g_miss_srp_pmt_plans_tbl srp_pmt_plans_tbl_type;
39
40 -- Start of comments
41 -- API name : Create_Srp_Pmt_Plan
42 -- Type : Public.
43 -- Pre-reqs : None.
44 -- Usage : Used to create a new payment plan assignment to an salesrep
45 -- Desc : Procedure to create a new payment plan assignment to salesrep
46 -- Parameters :
47 -- IN : p_api_version IN NUMBER Require
48 -- p_init_msg_list IN VARCHAR2 Optional
49 -- Default = CN_API.G_FALSE
50 -- p_commit IN VARCHAR2 Optional
51 -- Default = CN_API.G_FALSE
52 -- p_validation_level IN NUMBER Optional
53 -- Default = CN_API.G_VALID_LEVEL_FULL
54 -- p_srp_pmt_plans_rec IN srp_pmt_plans_rec_type
55 -- Required input :
56 -- PMT_PLAN_NAME payment plan name
57 -- SALESREP_TYPE,EMP_NUM use to get salesrep info
58 -- ROLE_NAME which sales role to be assigned
59 -- OUT : x_return_status OUT VARCHAR2(1)
60 -- x_msg_count OUT NUMBER
61 -- x_msg_data OUT VARCHAR2(2000)
62 -- x_loading_status OUT VARCHAR2(30)
63 -- Version : Current version 1.0
64 -- Initial version 1.0
65 -- Notes :
66 -- Default Action for this procedure :
67 -- 1. If user didn't pass in info for the following field, this program will
68 -- inherit the data from the Payment Plan.
69 -- MINIMUM_AMOUNT,MAXIMUM_AMOUNT
70 -- 2. If user didn't pass in info for START_DATE,END_DATE, this program will
71 -- get the overlapped date range between the Payment Plan active range
72 -- and Salesrep's active range and use that date range
73 --
74 -- End of comments
75 /*#
76 * This procedure is used to create a new payment plan assignment to a salesrep.
77 * @param p_api_version API Version
78 * @param p_init_msg_list Initialize Message List
79 * @param p_commit Commit after create
80 * @param p_validation_level Validation Level
81 * @param x_return_status Status of the create operation
82 * @param x_msg_count Number of error messages returned
83 * @param x_msg_data Error messages
84 * @param x_srp_pmt_plan_id Return the unique identifier of this assignment
85 * @param x_loading_status Status
86 * @param p_srp_pmt_plans_rec Record of type srp_pmt_plans_rec_type that stores the data associated with payment plan assignments
87 * @rep:scope public
88 * @rep:lifecycle active
89 * @rep:displayname Create payment plan assignments
90 */
91 PROCEDURE Create_Srp_Pmt_Plan
92 (
93 p_api_version IN NUMBER,
94 p_init_msg_list IN VARCHAR2 := CN_API.G_FALSE,
95 p_commit IN VARCHAR2 := CN_API.G_FALSE,
96 p_validation_level IN NUMBER := CN_API.G_VALID_LEVEL_FULL,
97 x_return_status OUT NOCOPY VARCHAR2,
98 x_msg_count OUT NOCOPY NUMBER,
99 x_msg_data OUT NOCOPY VARCHAR2,
100 p_srp_pmt_plans_rec IN srp_pmt_plans_rec_type,
101 x_srp_pmt_plan_id OUT NOCOPY NUMBER,
102 x_loading_status OUT NOCOPY VARCHAR2
103 );
104
105 -- Start of comments
106 -- API name : Create_Mass_Asgn_Srp_Pmt_Plan
107 -- currently just a wrapper around the private method
108 PROCEDURE Create_Mass_Asgn_Srp_Pmt_Plan
109 (
110 p_api_version IN NUMBER,
111 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
112 p_commit IN VARCHAR2 := FND_API.G_FALSE,
113 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
114 x_return_status OUT NOCOPY VARCHAR2,
115 x_msg_count OUT NOCOPY NUMBER,
116 x_msg_data OUT NOCOPY VARCHAR2,
117 p_srp_role_id IN NUMBER,
118 p_role_pmt_plan_id IN NUMBER,
119 x_srp_pmt_plan_id OUT NOCOPY NUMBER,
120 x_loading_status OUT NOCOPY VARCHAR2
121 );
122
123 -- Start of comments
124 -- API name : Update_Srp_Pmt_Plan
125 -- Type : Public.
126 -- Pre-reqs : None.
127 -- Usage : Used to update pmt plan assignment of an salesrep
128 -- Desc : Procedure to update pmt plan assignment of an salesrep
129 -- Parameters :
130 -- IN : p_api_version IN NUMBER Require
131 -- p_init_msg_list IN VARCHAR2 Optional
132 -- Default = CN_API.G_FALSE
133 -- p_commit IN VARCHAR2 Optional
134 -- Default = CN_API.G_FALSE
135 -- p_validation_level IN NUMBER Optional
136 -- Default = CN_API.G_VALID_LEVEL_FULL
137 -- p_srp_pmt_plans_rec IN srp_pmt_plans_rec_type
138 -- Required input :
139 -- PMT_PLAN_NAME payment plan name
140 -- SALESREP_TYPE,EMP_NUM use to get salesrep info
141 -- ROLE_NAME which sales role to be assigned
142 -- OUT : x_return_status OUT VARCHAR2(1)
143 -- x_msg_count OUT NUMBER
144 -- x_msg_data OUT VARCHAR2(2000)
145 -- x_loading_status OUT VARCHAR2(30)
146 -- Version : Current version 1.0
147 -- Initial version 1.0
148 -- Notes :
149 -- Update Srp Payment Plan Assignment is not allowed for following cases :
150 -- 1. Change the START_DATE assignment :
151 -- If the payment plan already been used by a payment worksheet and the
152 -- payment has been paid during this assigment's date range, no update or
153 -- delete is allowed for this Srp Payment Plan assignment START_DATE.
154 -- Otherwise user can expand or shrink the START_DATE
155 -- 2. Shorten the END_DATE assignment
156 -- If the payment plan already been used by a payment worksheet and the
157 -- payment has been paid during this assigment's date range,the END_DATE of
158 -- this Srp Payment Plan assignment cannot be shorten but user can expand it
159 --
160 -- End of comments
161 /*#
162 * This procedure is used to update the payment plan assignment of a salesrep.
163 * @param p_api_version API Version
164 * @param p_init_msg_list Initialize Message List
165 * @param p_commit Commit after update
166 * @param p_validation_level Validation Level
167 * @param x_return_status Status of the update operation
168 * @param x_msg_count Number of error messages returned
169 * @param x_msg_data Error messages
170 * @param x_loading_status Status
171 * @param p_old_srp_pmt_plans_rec Record of type srp_pmt_plans_rec_type that stores the data associated with payment plan assignments
172 * @param p_srp_pmt_plans_rec Record of type srp_pmt_plans_rec_type that stores the old data associated with payment plan assignments
173 * @param p_check_lock locking customization flag
174 * @rep:scope public
175 * @rep:lifecycle active
176 * @rep:displayname Update payment plan assignments
177 */
178
179 PROCEDURE Update_Srp_Pmt_Plan
180 (
181 p_api_version IN NUMBER,
182 p_init_msg_list IN VARCHAR2 := CN_API.G_FALSE,
183 p_commit IN VARCHAR2 := CN_API.G_FALSE,
184 p_validation_level IN NUMBER := CN_API.G_VALID_LEVEL_FULL,
185 x_return_status OUT NOCOPY VARCHAR2,
186 x_msg_count OUT NOCOPY NUMBER,
187 x_msg_data OUT NOCOPY VARCHAR2,
188 p_old_srp_pmt_plans_rec IN srp_pmt_plans_rec_type,
189 p_srp_pmt_plans_rec IN srp_pmt_plans_rec_type,
190 x_loading_status OUT NOCOPY VARCHAR2,
191 p_check_lock IN VARCHAR2 := NULL
192 );
193
194 -- Start of comments
195 -- API name : Update_Mass_Asgn_Srp_Pmt_Plan
196 -- currently just a wrapper around the private method
197 PROCEDURE Update_Mass_Asgn_Srp_Pmt_plan
198 (
199 p_api_version IN NUMBER,
200 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
201 p_commit IN VARCHAR2 := FND_API.G_FALSE,
202 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
203 x_return_status OUT NOCOPY VARCHAR2,
204 x_msg_count OUT NOCOPY NUMBER,
205 x_msg_data OUT NOCOPY VARCHAR2,
206 p_srp_role_id IN NUMBER,
207 p_role_pmt_plan_id IN NUMBER,
208 x_loading_status OUT NOCOPY VARCHAR2
209 );
210
211
212 -- Start of comments
213 -- API name : Delete_Srp_Pmt_Plan
214 -- Type : Public.
215 -- Pre-reqs : None.
216 -- Usage : Used to delete a payment plan assignment to an salesrep
217 -- Desc : Procedure to delete a payment plan assignment to salesrep
218 -- Parameters :
219 -- IN : p_api_version IN NUMBER Require
220 -- p_init_msg_list IN VARCHAR2 Optional
221 -- Default = CN_API.G_FALSE
222 -- p_commit IN VARCHAR2 Optional
223 -- Default = CN_API.G_FALSE
224 -- p_validation_level IN NUMBER Optional
225 -- Default = CN_API.G_VALID_LEVEL_FULL
226 -- p_srp_pmt_plans_rec IN srp_pmt_plans_rec_type
227 -- Required input :
228 -- PMT_PLAN_NAME payment plan name
229 -- SALESREP_TYPE,EMP_NUM use to get salesrep info
230 -- ROLE_NAME which sales role to be assigned
231 -- OUT : x_return_status OUT VARCHAR2(1)
232 -- x_msg_count OUT NUMBER
233 -- x_msg_data OUT VARCHAR2(2000)
234 -- x_loading_status OUT VARCHAR2(30)
235 -- Version : Current version 1.0
236 -- Initial version 1.0
237 -- Notes :
238 -- Delete Srp Payment Plan Assignment is not allowed for following cases :
239 -- If the payment plan already been used by a payment worksheet and the
240 -- payment has been paid during this assigment's date range, no update or
241 -- delete is allowed for this Srp Payment Plan assignment.
242 -- End of comments
243 /*#
244 * This procedure is used to delete a payment plan assignment to a salesrep.
245 * @param p_api_version API Version
246 * @param p_init_msg_list Initialize Message List
247 * @param p_commit Commit after delete
248 * @param p_validation_level Validation Level
249 * @param x_return_status Status of the delete operation
250 * @param x_msg_count Number of error messages returned
251 * @param x_msg_data Error messages
252 * @param x_loading_status Status
253 * @param p_srp_pmt_plans_rec Record of type srp_pmt_plans_rec_type that stores the data associated with payment plan assignments
254 * @param p_check_lock locking customization flag
255 * @rep:scope public
256 * @rep:lifecycle active
257 * @rep:displayname Delete payment plan assignments
258 */
259 PROCEDURE Delete_Srp_Pmt_Plan
260 (
261 p_api_version IN NUMBER,
262 p_init_msg_list IN VARCHAR2 := CN_API.G_FALSE,
263 p_commit IN VARCHAR2 := CN_API.G_FALSE,
264 p_validation_level IN NUMBER := CN_API.G_VALID_LEVEL_FULL,
265 x_return_status OUT NOCOPY VARCHAR2,
266 x_msg_count OUT NOCOPY NUMBER,
267 x_msg_data OUT NOCOPY VARCHAR2,
268 p_srp_pmt_plans_rec IN srp_pmt_plans_rec_type,
269 x_loading_status OUT NOCOPY VARCHAR2,
270 p_check_lock IN VARCHAR2 := NULL
271 );
272
273 -- Start of comments
274 -- API name : Delete_Mass_Asgn_Srp_Pmt_Plan
275 -- currently just a wrapper around the private method
276 PROCEDURE Delete_Mass_Asgn_Srp_Pmt_Plan
277 (p_api_version IN NUMBER,
278 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
279 p_commit IN VARCHAR2 := FND_API.G_FALSE,
280 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
281 x_return_status OUT NOCOPY VARCHAR2,
282 x_msg_count OUT NOCOPY NUMBER,
283 x_msg_data OUT NOCOPY VARCHAR2,
284 p_srp_role_id IN NUMBER,
285 p_role_pmt_plan_id IN NUMBER,
286 x_loading_status OUT NOCOPY VARCHAR2
287 );
288
289 END CN_SRP_PMT_PLANS_PUB ;
290
[Home] [Help]