[Home] [Help]
PACKAGE: APPS.AMS_CATEGORY_PVT
Source
1 PACKAGE AMS_Category_PVT as
2 /* $Header: amsvctys.pls 120.1 2005/10/21 03:49:16 vmodur noship $ */
3
4 -- Start of Comments
5 --
6 -- NAME
7 -- AMS_Category_PVT
8 --
9 -- PURPOSE
10 -- This package is a Private API for managing Category information in
11 -- AMS. It contains specification for pl/sql records and tables
12 --
13 -- Procedures:
14 -- Create_Category (see below for specification)
15 -- Update_Category (see below for specification)
16 -- Delete_Category (see below for specification)
17 -- Lock_Category (see below for specification)
18 -- Validate_Category (see below for specification)
19 -- Validate_Cty_Items (see below for specification)
20 -- Validate_Cty_Record (see below for specification)
21 -- Validate_Cty_Child_Enty (see below for specification)
22 -- Check_REQ_Cty_Items (see below for specification)
23 --
24 -- NOTES
25 --
26 --
27 -- HISTORY
28 -- 01/04/2000 sugupta created
29 -- 06/01/2000 khung add two new columns accrued_liability_account
30 -- and ded_adjustment_account
31
32 -- End of Comments
33
34 -- global constants
35
36 TYPE category_rec_type
37 IS RECORD
38 (
39 CATEGORY_ID NUMBER,
40 LAST_UPDATE_DATE DATE,
41 LAST_UPDATED_BY NUMBER,
42 CREATION_DATE DATE,
43 CREATED_BY NUMBER,
44 LAST_UPDATE_LOGIN NUMBER,
45 OBJECT_VERSION_NUMBER NUMBER,
46 ARC_CATEGORY_CREATED_FOR VARCHAR2(30),
47 ENABLED_FLAG VARCHAR2(1),
48 PARENT_CATEGORY_ID NUMBER,
49 ATTRIBUTE_CATEGORY VARCHAR2(30),
50 ATTRIBUTE1 VARCHAR2(150),
51 ATTRIBUTE2 VARCHAR2(150),
52 ATTRIBUTE3 VARCHAR2(150),
53 ATTRIBUTE4 VARCHAR2(150),
54 ATTRIBUTE5 VARCHAR2(150),
55 ATTRIBUTE6 VARCHAR2(150),
56 ATTRIBUTE7 VARCHAR2(150),
57 ATTRIBUTE8 VARCHAR2(150),
58 ATTRIBUTE9 VARCHAR2(150),
59 ATTRIBUTE10 VARCHAR2(150),
60 ATTRIBUTE11 VARCHAR2(150),
61 ATTRIBUTE12 VARCHAR2(150),
62 ATTRIBUTE13 VARCHAR2(150),
63 ATTRIBUTE14 VARCHAR2(150),
64 ATTRIBUTE15 VARCHAR2(150),
65 SOURCE_LANG VARCHAR2(4),
66 CATEGORY_NAME VARCHAR2(120),
67 DESCRIPTION VARCHAR2(4000),
68 ACCRUED_LIABILITY_ACCOUNT NUMBER,
69 DED_ADJUSTMENT_ACCOUNT NUMBER,
70 BUDGET_CODE_SUFFIX VARCHAR2(30),
71 LEDGER_ID NUMBER
72 );
73
74 /*****************************************************************************************/
75 -- Start of Comments
76 --
77 -- API name : Create_Categories
78 -- Type : Private
79 -- Function : Create a row in ams_Categories table
80 --
81 -- Pre-reqs : None
82 -- Paramaeters :
83 -- IN :
84 -- standard IN parameters
85 -- p_api_version IN NUMBER := NULL Required
86 -- p_init_msg_list IN VARCHAR2 Optional
87 -- Default := FND_API.g_false,
88 -- p_commit IN VARCHAR2 := FND_API.g_false, Optional
89 -- p_validation_level IN NUMBER
90 -- := FND_API.g_valid_level_full,
91 --
92 -- API's IN parameters
93 -- p_Category_rec IN category_rec_type Required
94 -- OUT :
95 -- standard OUT parameters
96 -- x_return_status OUT VARCHAR2(1)
97 -- x_msg_count OUT NUMBER
98 -- x_msg_data OUT VARCHAR2(2000)
99 --
100 --
101 -- API's OUT parameters
102 -- x_Category_id OUT NUMBER
103 --
104 --
105 -- Version : Current version 1.0
106 -- Initial version 1.0
107 --
108 -- Note : 1. p_Category_rec.category_id is a required parameter
109 --
110 -- End Of Comments
111
112 PROCEDURE Create_Category
113 ( p_api_version IN NUMBER,
114 p_init_msg_list IN VARCHAR2 := FND_API.g_false,
115 p_commit IN VARCHAR2 := FND_API.g_false,
116 p_validation_level IN NUMBER := FND_API.g_valid_level_full,
117 x_return_status OUT NOCOPY VARCHAR2,
118 x_msg_count OUT NOCOPY NUMBER,
119 x_msg_data OUT NOCOPY VARCHAR2,
120 p_category_rec IN category_rec_type,
121 x_category_id OUT NOCOPY NUMBER
122 );
123
124 /*****************************************************************************************/
125 -- Start of Comments
126 --
127 -- API name : Update_Categories
128 -- Type : Private
129 -- Function : Update a row in ams_categories table
130 --
131 -- Pre-reqs : None
132 -- Paramaeters :
133 -- IN :
134 -- standard IN parameters
135 -- p_api_version IN NUMBER := NULL Required
136 -- p_init_msg_list IN VARCHAR2 Optional
137 -- Default := FND_API.g_false
138 -- p_commit IN VARCHAR2 := FND_API.g_false Optional
139 -- p_validation_level IN NUMBER := FND_API.g_valid_level_full,
140 -- API's IN parameters
141 -- p_Category_rec IN category_rec_type Required
142 --
143 -- OUT :
144 -- standard OUT parameters
145 -- x_return_status OUT VARCHAR2(1)
146 -- x_msg_count OUT NUMBER
147 -- x_msg_data OUT VARCHAR2(2000)
148 --
149 --
150 -- Version : Current version 1.0
151 -- Initial version 1.0
152 --
153 -- Note : 1. p_Category_rec.category_id is a required parameter
154 -- 2. p_Category_rec.category_id is not updatable
155 --
156 -- End Of Comments
157
158 PROCEDURE Update_Category
159 ( p_api_version IN NUMBER,
160 p_init_msg_list IN VARCHAR2 := FND_API.g_false,
161 p_commit IN VARCHAR2 := FND_API.g_false,
162 p_validation_level IN NUMBER := FND_API.g_valid_level_full,
163 x_return_status OUT NOCOPY VARCHAR2,
164 x_msg_count OUT NOCOPY NUMBER,
165 x_msg_data OUT NOCOPY VARCHAR2,
166
167 p_category_rec IN category_rec_type
168 );
169
170 /*****************************************************************************************/
171 -- Start of Comments
172 --
173 -- API name : Delete_Categories
174 -- Type : Private
175 -- Function : Delete a row in ams_Categories table
176 --
177 -- Pre-reqs : None
178 -- Paramaeters :
179 -- IN :
180 -- standard IN parameters
181 -- p_api_version IN NUMBER := NULL Required
182 -- p_init_msg_list IN VARCHAR2 Optional
183 -- Default := FND_API.g_false
184 -- p_commit IN VARCHAR2 := FND_API.g_false Optional
185 -- p_validation_level IN NUMBER
186 -- := FND_API.g_valid_level_full,
187 -- API's IN parameters
188 -- p_Category_rec IN category_rec_type Required
189 --
190 --
191 -- OUT :
192 -- standard OUT parameters
193 -- x_return_status OUT VARCHAR2(1)
194 -- x_msg_count OUT NUMBER
195 -- x_msg_data OUT VARCHAR2(2000)
196 --
197 -- Version : Current version 1.0
198 -- Initial version 1.0
199 --
200 -- Note : 1. p_Category_rec.category_id is a required parameter
201 --
202 -- End Of Comments
203
204 PROCEDURE Delete_Category
205 ( p_api_version IN NUMBER,
206 p_init_msg_list IN VARCHAR2 := FND_API.g_false,
207 p_commit IN VARCHAR2 := FND_API.g_false,
208 p_validation_level IN NUMBER := FND_API.g_valid_level_full,
209 x_return_status OUT NOCOPY VARCHAR2,
210 x_msg_count OUT NOCOPY NUMBER,
211 x_msg_data OUT NOCOPY VARCHAR2,
212
213 p_category_id IN NUMBER,
214 p_object_version IN NUMBER
215 );
216
217
218 /*****************************************************************************************/
219 -- Start of Comments
220 --
221 -- API name : Lock_Categories
222 -- Type : Private
223 -- Function : Lock a row in ams_Categories table
224 --
225 -- Pre-reqs : None
226 -- Paramaeters :
227 -- IN :
228 -- standard IN parameters
229 -- p_api_version IN NUMBER := NULL Required
230 -- p_init_msg_list IN VARCHAR2 Optional
231 -- Default := FND_API.g_false
232 -- p_validation_level IN NUMBER := FND_API.g_valid_level_full,
233 -- API's IN parameters
234 -- p_category_id IN NUMBER required
235 -- p_object_version IN NUMBER required
236 -- standard OUT parameters
237 -- x_return_status OUT VARCHAR2(1)
238 -- x_msg_count OUT NUMBER
239 -- x_msg_data OUT VARCHAR2(2000)
240 --
241 --
242 -- Version : Current version 1.0
243 -- Initial version 1.0
244 --
245 -- Note : p_Category_rec.category_id is a required parameter
246 --
247 -- End Of Comments
248
249 PROCEDURE Lock_Category
250 ( p_api_version IN NUMBER,
251 p_init_msg_list IN VARCHAR2 := FND_API.g_false,
252 p_validation_level IN NUMBER := FND_API.g_valid_level_full,
253 x_return_status OUT NOCOPY VARCHAR2,
254 x_msg_count OUT NOCOPY NUMBER,
255 x_msg_data OUT NOCOPY VARCHAR2,
256
257 p_category_id IN NUMBER,
258 p_object_version IN NUMBER
259 );
260
261 ---------------------------------------------------------------------
262 -- PROCEDURE
263 -- complete_category_rec
264 --
265 -- PURPOSE
266 -- For update_category, some attributes may be passed in as
267 -- FND_API.g_miss_char/num/date if the user doesn't want to
268 -- update those attributes. This procedure will replace the
269 -- "g_miss" attributes with current database values.
270 --
271 -- PARAMETERS
272 -- p_category_rec: the record which may contain attributes as
273 -- FND_API.g_miss_char/num/date
274 -- x_complete_rec: the complete record after all "g_miss" items
275 -- have been replaced by current database values
276 ---------------------------------------------------------------------
277 PROCEDURE complete_category_rec(
278 p_category_rec IN category_rec_type,
279 x_complete_rec OUT NOCOPY category_rec_type
280 );
281
282 /*****************************************************************************************/
283 -- Start of Comments
284 --
285 -- API name : Validate_Categories
286 -- Type : Private
287 -- Function : Validate a row in ams_Categories table
288 --
289 -- Pre-reqs : None
290 -- Paramaeters :
291 -- IN :
292 -- standard IN parameters
293 -- p_api_version IN NUMBER := NULL Required
294 -- p_init_msg_list IN VARCHAR2 Optional
295 -- Default := FND_API.g_false
296 -- p_validation_level IN NUMBER
297 -- := FND_API.g_valid_level_full,
298 -- API's IN parameters
299 -- p_Category_rec IN category_rec_type Required
300 --
301 -- OUT :
302 -- standard OUT parameters
303 -- x_return_status OUT VARCHAR2(1)
304 -- x_msg_count OUT NUMBER
305 -- x_msg_data OUT VARCHAR2(2000)
306 --
307 -- API's OUT parameters
308 -- x_Category_rec OUT category_rec_type
309 --
310 --
311 -- Version : Current version 1.0
312 -- Initial version 1.0
313 --
314 -- Note : 1. p_Category_rec.category_id is a required parameter
315 -- 2. x_return_status will be FND_API.G_RET_STS_SUCCESS, FND_API.G_RET_STS_ERROR, or
316 -- FND_API.G_RET_STS_UNEXP_ERROR
317 --
318 -- End Of Comments
319
320 PROCEDURE Validate_Category
321 ( p_api_version IN NUMBER,
322 p_init_msg_list IN VARCHAR2 := FND_API.g_false,
323 p_validation_level IN NUMBER := FND_API.g_valid_level_full,
324 x_return_status OUT NOCOPY VARCHAR2,
325 x_msg_count OUT NOCOPY NUMBER,
326 x_msg_data OUT NOCOPY VARCHAR2,
327
328 p_category_rec IN category_rec_type
329 );
330
331 /*****************************************************************************************/
332 -- Start of Comments
333 --
334 -- Name : Validate_Cty_Items
335 -- Type : Private
336 -- Function : Validate columns in ams_Categories table
337 --
338 -- Pre-reqs : None
339 -- Paramaeters :
340 -- IN :
341 -- p_Category_rec IN category_rec_type Required
342 --
343 -- OUT :
344 -- x_return_status OUT VARCHAR2
345 --
346 -- End Of Comments
347
348 PROCEDURE Validate_Cty_Items
349 ( p_category_rec IN category_rec_type,
350 x_return_status OUT NOCOPY VARCHAR2
351 );
352
353 /*****************************************************************************************/
354 -- Start of Comments
355 --
356 -- API name : Validate_Cty_Record
357 -- Type : Private
358 -- Function : Validate a row in ams_Categories table
359 --
360 -- Pre-reqs : None
361 -- Paramaeters :
362 -- IN :
363 -- standard IN parameters
364 -- p_api_version IN NUMBER := NULL Required
365 -- p_init_msg_list IN VARCHAR2 Optional
366 -- Default := FND_API.g_false
367 -- API's IN parameters
368 --
369 -- p_Category_rec IN category_rec_type Required
370 --
371 --
372 -- OUT :
373 -- standard OUT parameters
374 -- x_return_status OUT VARCHAR2(1)
375 -- x_msg_count OUT NUMBER
376 -- x_msg_data OUT VARCHAR2(2000)
377 --
378 -- Version : Current version 1.0
379 -- Initial version 1.0
380 --
381 -- Note : x_return_status will be FND_API.G_RET_STS_SUCCESS, FND_API.G_RET_STS_ERROR, or
382 -- FND_API.G_RET_STS_UNEXP_ERROR
383 --
384 -- End Of Comments
385
386 PROCEDURE Validate_Cty_Record
387 ( p_api_version IN NUMBER,
388 p_init_msg_list IN VARCHAR2 := FND_API.g_false,
389 x_return_status OUT NOCOPY VARCHAR2,
390 x_msg_count OUT NOCOPY NUMBER,
391 x_msg_data OUT NOCOPY VARCHAR2,
392
393 p_category_rec IN category_rec_type
394 );
395
396 /*****************************************************************************************/
397 -- Start of Comments
398 --
399 -- Name : Validate_Cty_Child_Enty
400 -- Type : Private
401 -- Function : Check to see if any child entity exists
402 --
403 -- Pre-reqs : None
404 -- Paramaeters :
405 -- IN :
406 -- p_Category_id IN NUMBER Required
407 --
408 -- OUT :
409 -- x_return_status OUT VARCHAR2
410 --
411 -- End Of Comments
412
413 PROCEDURE Validate_Cty_Child_Enty
414 ( p_category_id IN NUMBER,
415 x_return_status OUT NOCOPY VARCHAR2
416 );
417
418 /*****************************************************************************************/
419 -- Start of Comments
420 --
421 -- Name : Check_REQ_Cty_Items
422 -- Type : Private
423 -- Function : Check required parameters for caller needs
424 --
425 -- Pre-reqs : None
426 -- Paramaeters :
427 -- IN :
428 -- p_category_rec IN category_rec_type Required
429 --
430 -- OUT :
431 -- x_return_status OUT VARCHAR2
432 --
433 -- End Of Comments
434
435 PROCEDURE Check_REQ_Cty_Items
436 ( p_category_rec IN category_rec_type,
437 x_return_status OUT NOCOPY VARCHAR2
438 );
439
440 --
441 -- unit test procedure
445 PROCEDURE Unit_Test_Delete;
442 --
443 /*
444 PROCEDURE Unit_Test_Insert;
446 PROCEDURE Unit_Test_Update;
447 PROCEDURE Unit_Test_Lock;
448
449
450 PROCEDURE Unit_Test_Act_Insert;
451 PROCEDURE Unit_Test_Act_Delete;
452 PROCEDURE Unit_Test_Act_Update;
453 PROCEDURE Unit_Test_Act_Lock;
454 */
455
456 END AMS_Category_PVT;