1 package AK_CUSTOM_PVT AUTHID CURRENT_USER as
2 /* $Header: akdvcres.pls 120.2 2005/09/15 22:26:48 tshort noship $ */
3
4 -- Global constants holding the package and file names to be used by
5 -- messaging routines in the case of an unexpected error.
6
7 G_PKG_NAME CONSTANT VARCHAR2(30) := 'AK_CUSTOM_PVT';
8
9 -- Procedure specs
10
11 --=======================================================
12 -- Procedure WRITE_CUSTOM_TO_BUFFER (local procedure)
13 --
14 -- TEMPORARY
15 --=======================================================
16 procedure WRITE_CUSTOM_TO_BUFFER (
17 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
18 p_return_status OUT NOCOPY VARCHAR2,
19 p_region_application_id IN NUMBER,
20 p_region_code IN VARCHAR2,
21 p_custom_application_id IN NUMBER,
22 p_custom_code IN VARCHAR2,
23 p_nls_language IN VARCHAR2
24 );
25
26 --=======================================================
27 -- Procedure WRITE_CUST_REGION_TO_BUFFER (local procedure)
28 --
29 -- TEMPORARY
30 --=======================================================
31 procedure WRITE_CUST_REGION_TO_BUFFER (
32 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
33 p_return_status OUT NOCOPY VARCHAR2,
34 p_region_application_id IN NUMBER,
35 p_region_code IN VARCHAR2,
36 p_custom_application_id IN NUMBER,
37 p_custom_code IN VARCHAR2,
38 p_nls_language IN VARCHAR2
39 );
40
41 --=======================================================
42 -- Procedure WRITE_CUST_REG_ITEM_TO_BUFFER (local procedure)
43 --
44 -- TEMPORARY
45 --=======================================================
46 procedure WRITE_CUST_REG_ITEM_TO_BUFFER (
47 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
48 p_return_status OUT NOCOPY VARCHAR2,
49 p_region_application_id IN NUMBER,
50 p_region_code IN VARCHAR2,
51 p_custom_application_id IN NUMBER,
52 p_custom_code IN VARCHAR2,
53 p_nls_language IN VARCHAR2
54 );
55
56 --=======================================================
57 -- Procedure WRITE_CRITERIA_TO_BUFFER (local procedure)
58 --
59 -- TEMPORARY
60 --=======================================================
61 procedure WRITE_CRITERIA_TO_BUFFER (
62 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
63 p_return_status OUT NOCOPY VARCHAR2,
64 p_region_application_id IN NUMBER,
65 p_region_code IN VARCHAR2,
66 p_custom_application_id IN NUMBER,
67 p_custom_code IN VARCHAR2,
68 p_nls_language IN VARCHAR2
69 );
70
71 --=======================================================
72 -- Procedure CREATE_CUSTOM
73 --
74 -- Usage Private API for creating a region graph. This
75 -- API should only be called by other APIs that are
76 -- owned by the Core Modules Team (AK).
77 --
78 -- Desc Creates a region graph using the given info.
79 -- This API should only be called by other APIs that are
80 -- owned by the Core Modules Team (AK).
81 --
82 -- Results The API returns the standard p_return_status parameter
83 -- indicating one of the standard return statuses :
84 -- * Unexpected error
85 -- * Error
86 -- * Success
87 -- Parameters Region Item columns
88 -- p_loader_timestamp : IN optional
89 -- If a timestamp is passed, the API will create the
90 -- record using this timestamp. Only the upload API
91 -- should call with this parameter loaded.
92 --
93 -- Version Initial version number = 1.0
94 -- History Current version number = 1.0
95 --=======================================================
96 procedure CREATE_CUSTOM (
97 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
98 p_api_version_number IN NUMBER,
99 p_init_msg_tbl IN BOOLEAN := FALSE,
100 p_msg_count OUT NOCOPY NUMBER,
101 p_msg_data OUT NOCOPY VARCHAR2,
102 p_return_status OUT NOCOPY VARCHAR2,
103 p_custom_appl_id IN NUMBER,
104 p_custom_code IN VARCHAR2,
105 p_region_appl_id IN NUMBER,
106 p_region_code IN VARCHAR2,
107 p_verticalization_id IN VARCHAR2 := FND_API.G_MISS_CHAR,
108 p_localization_code IN VARCHAR2 := FND_API.G_MISS_CHAR,
109 p_org_id IN NUMBER := FND_API.G_MISS_NUM,
110 p_site_id IN NUMBER := FND_API.G_MISS_NUM,
111 p_responsibility_id IN NUMBER := FND_API.G_MISS_NUM,
112 p_web_user_id IN NUMBER := FND_API.G_MISS_NUM,
113 p_default_customization_flag IN VARCHAR2 := FND_API.G_MISS_CHAR,
114 p_customization_level_id IN NUMBER := FND_API.G_MISS_NUM,
115 p_developer_mode IN VARCHAR2 := FND_API.G_MISS_CHAR,
116 p_reference_path IN VARCHAR2 := FND_API.G_MISS_CHAR,
117 p_function_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
118 p_start_date_active IN DATE := FND_API.G_MISS_DATE,
119 p_end_date_active IN DATE := FND_API.G_MISS_DATE,
120 p_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
121 p_description IN VARCHAR2 := FND_API.G_MISS_CHAR,
122 p_created_by IN NUMBER := FND_API.G_MISS_NUM,
123 p_creation_date IN DATE := FND_API.G_MISS_DATE,
124 p_last_updated_by IN NUMBER := FND_API.G_MISS_NUM,
125 p_last_update_date IN DATE := FND_API.G_MISS_DATE,
126 p_last_update_login IN NUMBER := FND_API.G_MISS_NUM,
127 p_loader_timestamp IN DATE := FND_API.G_MISS_DATE,
128 p_pass IN NUMBER,
129 p_copy_redo_flag IN OUT NOCOPY BOOLEAN
130 );
131
132 --=======================================================
133 -- Procedure CREATE_CUST_REGION
134 --
135 -- Usage Private API for creating a region graph. This
136 -- API should only be called by other APIs that are
137 -- owned by the Core Modules Team (AK).
138 --
139 -- Desc Creates a region graph using the given info.
140 -- This API should only be called by other APIs that are
141 -- owned by the Core Modules Team (AK).
142 --
143 -- Results The API returns the standard p_return_status parameter
144 -- indicating one of the standard return statuses :
145 -- * Unexpected error
146 -- * Error
147 -- * Success
148 -- Parameters Region Item columns
149 -- p_loader_timestamp : IN optional
150 -- If a timestamp is passed, the API will create the
151 -- record using this timestamp. Only the upload API
152 -- should call with this parameter loaded.
153 --
154 -- Version Initial version number = 1.0
155 -- History Current version number = 1.0
156 --=======================================================
157 procedure CREATE_CUST_REGION (
158 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
159 p_api_version_number IN NUMBER,
160 p_init_msg_tbl IN BOOLEAN := FALSE,
161 p_msg_count OUT NOCOPY NUMBER,
162 p_msg_data OUT NOCOPY VARCHAR2,
163 p_return_status OUT NOCOPY VARCHAR2,
164 p_custom_appl_id IN NUMBER,
165 p_custom_code IN VARCHAR2,
166 p_region_appl_id IN NUMBER,
167 p_region_code IN VARCHAR2,
168 p_property_name IN VARCHAR2,
169 p_property_varchar2_value IN VARCHAR2 := FND_API.G_MISS_CHAR,
170 p_property_number_value IN NUMBER := FND_API.G_MISS_NUM,
171 p_criteria_join_condition IN VARCHAR2 := FND_API.G_MISS_CHAR,
172 p_property_varchar2_value_tl IN VARCHAR2 := FND_API.G_MISS_CHAR,
173 p_created_by IN NUMBER := FND_API.G_MISS_NUM,
174 p_creation_date IN DATE := FND_API.G_MISS_DATE,
175 p_last_updated_by IN NUMBER := FND_API.G_MISS_NUM,
176 p_last_update_date IN DATE := FND_API.G_MISS_DATE,
177 p_last_update_login IN NUMBER := FND_API.G_MISS_NUM,
178 p_loader_timestamp IN DATE := FND_API.G_MISS_DATE,
179 p_pass IN NUMBER,
180 p_copy_redo_flag IN OUT NOCOPY BOOLEAN
181 );
182
183 --=======================================================
184 -- Procedure CREATE_CUST_REG_ITEM
185 --
186 -- Usage Private API for creating a region graph. This
187 -- API should only be called by other APIs that are
188 -- owned by the Core Modules Team (AK).
189 --
190 -- Desc Creates a region graph using the given info.
191 -- This API should only be called by other APIs that are
192 -- owned by the Core Modules Team (AK).
193 --
194 -- Results The API returns the standard p_return_status parameter
195 -- indicating one of the standard return statuses :
196 -- * Unexpected error
197 -- * Error
198 -- * Success
199 -- Parameters Region Item columns
200 -- p_loader_timestamp : IN optional
201 -- If a timestamp is passed, the API will create the
202 -- record using this timestamp. Only the upload API
203 -- should call with this parameter loaded.
204 --
205 -- Version Initial version number = 1.0
206 -- History Current version number = 1.0
207 --=======================================================
208 procedure CREATE_CUST_REG_ITEM (
209 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
210 p_api_version_number IN NUMBER,
211 p_init_msg_tbl IN BOOLEAN := FALSE,
212 p_msg_count OUT NOCOPY NUMBER,
213 p_msg_data OUT NOCOPY VARCHAR2,
214 p_return_status OUT NOCOPY VARCHAR2,
215 p_custom_appl_id IN NUMBER,
216 p_custom_code IN VARCHAR2,
217 p_region_appl_id IN NUMBER,
218 p_region_code IN VARCHAR2,
219 p_attr_appl_id IN NUMBER,
220 p_attr_code IN VARCHAR2,
221 p_property_name IN VARCHAR2,
222 p_property_varchar2_value IN VARCHAR2 := FND_API.G_MISS_CHAR,
223 p_property_number_value IN NUMBER := FND_API.G_MISS_NUM,
224 p_property_date_value IN VARCHAR2 := FND_API.G_MISS_CHAR,
225 p_property_varchar2_value_tl IN VARCHAR2 := FND_API.G_MISS_CHAR,
226 p_created_by IN NUMBER := FND_API.G_MISS_NUM,
227 p_creation_date IN DATE := FND_API.G_MISS_DATE,
228 p_last_updated_by IN NUMBER := FND_API.G_MISS_NUM,
229 p_last_update_date IN DATE := FND_API.G_MISS_DATE,
230 p_last_update_login IN NUMBER := FND_API.G_MISS_NUM,
231 p_loader_timestamp IN DATE := FND_API.G_MISS_DATE,
232 p_pass IN NUMBER,
233 p_copy_redo_flag IN OUT NOCOPY BOOLEAN
234 );
235
236 --=======================================================
237 -- Procedure CREATE_CRITERIA
238 --
239 -- Usage Private API for creating a region graph. This
240 -- API should only be called by other APIs that are
241 -- owned by the Core Modules Team (AK).
242 --
243 -- Desc Creates a region graph using the given info.
244 -- This API should only be called by other APIs that are
245 -- owned by the Core Modules Team (AK).
246 --
247 -- Results The API returns the standard p_return_status parameter
248 -- indicating one of the standard return statuses :
249 -- * Unexpected error
250 -- * Error
251 -- * Success
252 -- Parameters Region Item columns
253 -- p_loader_timestamp : IN optional
254 -- If a timestamp is passed, the API will create the
255 -- record using this timestamp. Only the upload API
256 -- should call with this parameter loaded.
257 --
258 -- Version Initial version number = 1.0
259 -- History Current version number = 1.0
260 --=======================================================
261 procedure CREATE_CRITERIA (
262 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
263 p_api_version_number IN NUMBER,
264 p_init_msg_tbl IN BOOLEAN := FALSE,
265 p_msg_count OUT NOCOPY NUMBER,
266 p_msg_data OUT NOCOPY VARCHAR2,
267 p_return_status OUT NOCOPY VARCHAR2,
268 p_custom_appl_id IN NUMBER,
269 p_custom_code IN VARCHAR2,
270 p_region_appl_id IN NUMBER,
271 p_region_code IN VARCHAR2,
272 p_attr_appl_id IN NUMBER,
273 p_attr_code IN VARCHAR2,
274 p_sequence_number IN NUMBER,
275 p_operation IN VARCHAR2 := FND_API.G_MISS_CHAR,
276 p_value_varchar2 IN VARCHAR2 := FND_API.G_MISS_CHAR,
277 p_value_number IN NUMBER := FND_API.G_MISS_NUM,
278 p_value_date IN DATE := FND_API.G_MISS_DATE,
279 p_start_date_Active IN DATE := FND_API.G_MISS_DATE,
280 p_end_date_active IN DATE := FND_API.G_MISS_DATE,
281 p_created_by IN NUMBER := FND_API.G_MISS_NUM,
282 p_creation_date IN DATE := FND_API.G_MISS_DATE,
283 p_last_updated_by IN NUMBER := FND_API.G_MISS_NUM,
284 p_last_update_date IN DATE := FND_API.G_MISS_DATE,
285 p_last_update_login IN NUMBER := FND_API.G_MISS_NUM,
286 p_loader_timestamp IN DATE := FND_API.G_MISS_DATE,
287 p_pass IN NUMBER,
288 p_copy_redo_flag IN OUT NOCOPY BOOLEAN
289 );
290
291 --=======================================================
292 -- Function CUSTOM_EXISTS
293 --
294 -- Usage Private API for checking for the existence of
295 -- a region graph with the given key values. This
296 -- API should only be called by other APIs that are
297 -- owned by the Core Modules Team (AK).
298 --
299 -- Desc This API check to see if a region graph record
300 -- exists with the given key values.
301 --
302 -- Results The API returns the standard p_return_status parameter
303 -- indicating one of the standard return statuses :
304 -- * Unexpected error
305 -- * Error
306 -- * Success
307 -- This function will return TRUE if such an object
308 -- attribute exists, or FALSE otherwise.
309 -- Parameters Region Graph key columns
310 --
311 -- Version Initial version number = 1.0
312 -- History Current version number = 1.0
313 --=======================================================
314 function CUSTOM_EXISTS (
315 p_api_version_number IN NUMBER,
316 p_return_status OUT NOCOPY VARCHAR2,
317 p_custom_appl_id IN NUMBER,
318 p_custom_code IN VARCHAR2,
319 p_region_application_id IN NUMBER,
320 p_region_code IN VARCHAR2
321 ) return BOOLEAN;
322
323 --=======================================================
324 -- Function CUST_REGION_EXISTS
325 --
326 -- Usage Private API for checking for the existence of
327 -- a region graph with the given key values. This
328 -- API should only be called by other APIs that are
329 -- owned by the Core Modules Team (AK).
330 --
331 -- Desc This API check to see if a region graph record
332 -- exists with the given key values.
333 --
334 -- Results The API returns the standard p_return_status parameter
335 -- indicating one of the standard return statuses :
336 -- * Unexpected error
337 -- * Error
338 -- * Success
339 -- This function will return TRUE if such an object
340 -- attribute exists, or FALSE otherwise.
341 -- Parameters Region Graph key columns
342 --
343 -- Version Initial version number = 1.0
344 -- History Current version number = 1.0
345 --=======================================================
346 function CUST_REGION_EXISTS (
347 p_api_version_number IN NUMBER,
348 p_return_status OUT NOCOPY VARCHAR2,
349 p_custom_appl_id IN NUMBER,
350 p_custom_code IN VARCHAR2,
351 p_region_application_id IN NUMBER,
352 p_region_code IN VARCHAR2,
353 p_property_name IN VARCHAR2
354 ) return BOOLEAN;
355
356 --=======================================================
357 -- Function CUST_REG_ITEM_EXISTS
358 --
359 -- Usage Private API for checking for the existence of
360 -- a region graph with the given key values. This
361 -- API should only be called by other APIs that are
362 -- owned by the Core Modules Team (AK).
363 --
364 -- Desc This API check to see if a region graph record
365 -- exists with the given key values.
366 --
367 -- Results The API returns the standard p_return_status parameter
368 -- indicating one of the standard return statuses :
369 -- * Unexpected error
370 -- * Error
371 -- * Success
372 -- This function will return TRUE if such an object
373 -- attribute exists, or FALSE otherwise.
374 -- Parameters Region Graph key columns
375 --
376 -- Version Initial version number = 1.0
377 -- History Current version number = 1.0
378 --=======================================================
379 function CUST_REG_ITEM_EXISTS (
380 p_api_version_number IN NUMBER,
381 p_return_status OUT NOCOPY VARCHAR2,
382 p_custom_appl_id IN NUMBER,
383 p_custom_code IN VARCHAR2,
384 p_region_application_id IN NUMBER,
385 p_region_code IN VARCHAR2,
386 p_attribute_appl_id IN NUMBER,
387 p_attribute_code IN VARCHAR2,
388 p_property_name IN VARCHAR2
389 ) return BOOLEAN;
390
391 --=======================================================
392 -- Function CRITERIA_EXISTS
393 --
394 -- Usage Private API for checking for the existence of
395 -- a region graph with the given key values. This
396 -- API should only be called by other APIs that are
397 -- owned by the Core Modules Team (AK).
398 --
399 -- Desc This API check to see if a region graph record
400 -- exists with the given key values.
401 --
402 -- Results The API returns the standard p_return_status parameter
403 -- indicating one of the standard return statuses :
404 -- * Unexpected error
405 -- * Error
406 -- * Success
407 -- This function will return TRUE if such an object
408 -- attribute exists, or FALSE otherwise.
409 -- Parameters Region Graph key columns
410 --
411 -- Version Initial version number = 1.0
412 -- History Current version number = 1.0
413 --=======================================================
414 function CRITERIA_EXISTS (
415 p_api_version_number IN NUMBER,
416 p_return_status OUT NOCOPY VARCHAR2,
417 p_custom_appl_id IN NUMBER,
418 p_custom_code IN VARCHAR2,
419 p_region_application_id IN NUMBER,
420 p_region_code IN VARCHAR2,
421 p_attribute_appl_id IN NUMBER,
422 p_attribute_code IN VARCHAR2,
423 p_sequence_number IN NUMBER
424 ) return BOOLEAN;
425
426 --=======================================================
427 -- Procedure UPDATE_CUSTOM
428 --
429 -- Usage Private API for updating a region graph.
430 -- This API should only be called by other APIs
431 -- that are owned by the Core Modules Team (AK).
432 --
433 -- Desc This API updates a region graph using the given info
434 --
435 -- Results The API returns the standard p_return_status parameter
436 -- indicating one of the standard return statuses :
437 -- * Unexpected error
438 -- * Error
439 -- * Success
440 -- Parameters Region Graph columns
441 -- p_loader_timestamp : IN optional
442 -- If a timestamp is passed, the API will update the
443 -- record using this timestamp. Only the upload API
444 -- should call with this parameter loaded.
445 --
446 -- Version Initial version number = 1.0
447 -- History Current version number = 1.0
448 --=======================================================
449 procedure UPDATE_CUSTOM (
450 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
451 p_api_version_number IN NUMBER,
452 p_init_msg_tbl IN BOOLEAN := FALSE,
453 p_msg_count OUT NOCOPY NUMBER,
454 p_msg_data OUT NOCOPY VARCHAR2,
455 p_return_status OUT NOCOPY VARCHAR2,
456 p_custom_appl_id IN NUMBER,
457 p_custom_code IN VARCHAR2,
458 p_region_application_id IN NUMBER,
459 p_region_code IN VARCHAR2,
460 p_verticalization_id IN VARCHAR2 := FND_API.G_MISS_CHAR,
461 p_localization_code IN VARCHAR2 := FND_API.G_MISS_CHAR,
462 p_org_id IN NUMBER := FND_API.G_MISS_NUM,
463 p_site_id IN NUMBER := FND_API.G_MISS_NUM,
464 p_responsibility_id IN NUMBER := FND_API.G_MISS_NUM,
465 p_web_user_id IN NUMBER := FND_API.G_MISS_NUM,
466 p_default_customization_flag IN VARCHAR2 := FND_API.G_MISS_CHAR,
467 p_customization_level_id IN NUMBER := FND_API.G_MISS_NUM,
468 p_developer_mode IN VARCHAR2 := FND_API.G_MISS_CHAR,
469 p_reference_path IN VARCHAR2 := FND_API.G_MISS_CHAR,
470 p_function_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
471 p_start_date_active IN DATE := FND_API.G_MISS_DATE,
472 p_end_date_active IN DATE := FND_API.G_MISS_DATE,
473 p_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
474 p_description IN VARCHAR2 := FND_API.G_MISS_CHAR,
475 p_created_by IN NUMBER := FND_API.G_MISS_NUM,
476 p_creation_date IN DATE := FND_API.G_MISS_DATE,
477 p_last_updated_by IN NUMBER := FND_API.G_MISS_NUM,
478 p_last_update_date IN DATE := FND_API.G_MISS_DATE,
479 p_last_update_login IN NUMBER := FND_API.G_MISS_NUM,
480 p_loader_timestamp IN DATE := FND_API.G_MISS_DATE,
481 p_pass IN NUMBER,
482 p_copy_redo_flag IN OUT NOCOPY BOOLEAN
483 );
484
485 --=======================================================
486 -- Procedure UPDATE_CUST_REGION
487 --
488 -- Usage Private API for updating a region graph.
489 -- This API should only be called by other APIs
490 -- that are owned by the Core Modules Team (AK).
491 --
492 -- Desc This API updates a region graph using the given info
493 --
494 -- Results The API returns the standard p_return_status parameter
495 -- indicating one of the standard return statuses :
496 -- * Unexpected error
497 -- * Error
498 -- * Success
499 -- Parameters Region Graph columns
500 -- p_loader_timestamp : IN optional
501 -- If a timestamp is passed, the API will update the
502 -- record using this timestamp. Only the upload API
503 -- should call with this parameter loaded.
504 --
505 -- Version Initial version number = 1.0
506 -- History Current version number = 1.0
507 --=======================================================
508 procedure UPDATE_CUST_REGION (
509 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
510 p_api_version_number IN NUMBER,
511 p_init_msg_tbl IN BOOLEAN := FALSE,
512 p_msg_count OUT NOCOPY NUMBER,
513 p_msg_data OUT NOCOPY VARCHAR2,
514 p_return_status OUT NOCOPY VARCHAR2,
515 p_custom_appl_id IN NUMBER,
516 p_custom_code IN VARCHAR2,
517 p_region_application_id IN NUMBER,
518 p_region_code IN VARCHAR2,
519 p_property_name IN VARCHAR2,
520 p_property_varchar2_value IN VARCHAR2 := FND_API.G_MISS_CHAR,
521 p_property_number_value IN NUMBER := FND_API.G_MISS_NUM,
522 p_criteria_join_condition IN VARCHAR2 := FND_API.G_MISS_CHAR,
523 p_property_varchar2_value_tl IN VARCHAR2 := FND_API.G_MISS_CHAR,
524 p_created_by IN NUMBER := FND_API.G_MISS_NUM,
525 p_creation_date IN DATE := FND_API.G_MISS_DATE,
526 p_last_updated_by IN NUMBER := FND_API.G_MISS_NUM,
527 p_last_update_date IN DATE := FND_API.G_MISS_DATE,
528 p_last_update_login IN NUMBER := FND_API.G_MISS_NUM,
529 p_loader_timestamp IN DATE := FND_API.G_MISS_DATE,
530 p_pass IN NUMBER,
531 p_copy_redo_flag IN OUT NOCOPY BOOLEAN
532 );
533
534 --=======================================================
535 -- Procedure UPDATE_CUST_REG_ITEM
536 --
537 -- Usage Private API for updating a region graph.
538 -- This API should only be called by other APIs
539 -- that are owned by the Core Modules Team (AK).
540 --
541 -- Desc This API updates a region graph using the given info
542 --
543 -- Results The API returns the standard p_return_status parameter
544 -- indicating one of the standard return statuses :
545 -- * Unexpected error
546 -- * Error
547 -- * Success
548 -- Parameters Region Graph columns
549 -- p_loader_timestamp : IN optional
550 -- If a timestamp is passed, the API will update the
551 -- record using this timestamp. Only the upload API
552 -- should call with this parameter loaded.
553 --
554 -- Version Initial version number = 1.0
555 -- History Current version number = 1.0
556 --=======================================================
557 procedure UPDATE_CUST_REG_ITEM (
558 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
559 p_api_version_number IN NUMBER,
560 p_init_msg_tbl IN BOOLEAN := FALSE,
561 p_msg_count OUT NOCOPY NUMBER,
562 p_msg_data OUT NOCOPY VARCHAR2,
563 p_return_status OUT NOCOPY VARCHAR2,
564 p_custom_appl_id IN NUMBER,
565 p_custom_code IN VARCHAR2,
566 p_region_application_id IN NUMBER,
567 p_region_code IN VARCHAR2,
568 p_attribute_appl_id IN NUMBER,
569 p_attribute_code IN VARCHAR2,
570 p_property_name IN VARCHAR2,
571 p_property_varchar2_value IN VARCHAR2 := FND_API.G_MISS_CHAR,
572 p_property_number_value IN NUMBER := FND_API.G_MISS_NUM,
573 p_property_date_value IN VARCHAR2 := FND_API.G_MISS_CHAR,
574 p_property_varchar2_value_tl IN VARCHAR2 := FND_API.G_MISS_CHAR,
575 p_created_by IN NUMBER := FND_API.G_MISS_NUM,
576 p_creation_date IN DATE := FND_API.G_MISS_DATE,
577 p_last_updated_by IN NUMBER := FND_API.G_MISS_NUM,
578 p_last_update_date IN DATE := FND_API.G_MISS_DATE,
579 p_last_update_login IN NUMBER := FND_API.G_MISS_NUM,
580 p_loader_timestamp IN DATE := FND_API.G_MISS_DATE,
581 p_pass IN NUMBER,
582 p_copy_redo_flag IN OUT NOCOPY BOOLEAN
583 );
584
585 --=======================================================
586 -- Procedure UPDATE_CRITERIA
587 --
588 -- Usage Private API for updating a region graph.
589 -- This API should only be called by other APIs
590 -- that are owned by the Core Modules Team (AK).
591 --
592 -- Desc This API updates a region graph using the given info
593 --
594 -- Results The API returns the standard p_return_status parameter
595 -- indicating one of the standard return statuses :
596 -- * Unexpected error
597 -- * Error
598 -- * Success
599 -- Parameters Region Graph columns
600 -- p_loader_timestamp : IN optional
601 -- If a timestamp is passed, the API will update the
602 -- record using this timestamp. Only the upload API
603 -- should call with this parameter loaded.
604 --
605 -- Version Initial version number = 1.0
606 -- History Current version number = 1.0
607 --=======================================================
608 procedure UPDATE_CRITERIA (
609 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
610 p_api_version_number IN NUMBER,
611 p_init_msg_tbl IN BOOLEAN := FALSE,
612 p_msg_count OUT NOCOPY NUMBER,
613 p_msg_data OUT NOCOPY VARCHAR2,
614 p_return_status OUT NOCOPY VARCHAR2,
615 p_custom_appl_id IN NUMBER,
616 p_custom_code IN VARCHAR2,
617 p_region_application_id IN NUMBER,
618 p_region_code IN VARCHAR2,
619 p_attribute_appl_id IN NUMBER,
620 p_attribute_code IN VARCHAR2,
621 p_sequence_number IN NUMBER,
622 p_operation IN VARCHAR2 := FND_API.G_MISS_CHAR,
623 p_value_varchar2 IN VARCHAR2 := FND_API.G_MISS_CHAR,
624 p_value_number IN NUMBER := FND_API.G_MISS_NUM,
625 p_value_date IN DATE := FND_API.G_MISS_DATE,
626 p_start_date_active IN DATE := FND_API.G_MISS_DATE,
627 p_end_date_active IN DATE := FND_API.G_MISS_DATE,
628 p_created_by IN NUMBER := FND_API.G_MISS_NUM,
629 p_creation_date IN DATE := FND_API.G_MISS_DATE,
630 p_last_updated_by IN NUMBER := FND_API.G_MISS_NUM,
631 p_last_update_date IN DATE := FND_API.G_MISS_DATE,
632 p_last_update_login IN NUMBER := FND_API.G_MISS_NUM,
633 p_loader_timestamp IN DATE := FND_API.G_MISS_DATE,
634 p_pass IN NUMBER,
635 p_copy_redo_flag IN OUT NOCOPY BOOLEAN
636 );
637
638 --=======================================================
639 -- Procedure DOWNLOAD_CUSTOM
640 --
641 -- Usage Private API for downloading customizations. This
642 -- API should only be called by other APIs that are
643 -- owned by the Core Modules Team (AK).
644 --
645 -- Desc This API will extract the customizations selected
646 -- by application ID or by key values from the
647 -- database to the output file.
648 -- If a customization is selected for writing to the loader
649 -- file, all its children records (including criteria)
650 -- will also be written.
651 --
652 -- Results The API returns the standard p_return_status parameter
653 -- indicating one of the standard return statuses :
654 -- * Unexpected error
655 -- * Error
656 -- * Success
657 -- Parameters
658 -- p_nls_language : IN optional
659 -- NLS language for database. If none if given,
660 -- the current NLS language will be used.
661 -- p_get_object_flag : IN required
662 -- Call DOWNLOAD_OBJECT API to extract objects that
663 -- are referenced by the regions that will be extracted
664 -- by this API if this parameter is 'Y'.
665 --
666 -- One of the following parameters must be provided:
667 --
668 -- p_application_id : IN optional
669 -- If given, all attributes for this application ID
670 -- will be written to the output file.
671 -- p_application_id will be ignored if a table is
672 -- given in p_region_pk_tbl.
673 -- p_region_pk_tbl : IN optional
674 -- If given, only regions whose key values are
675 -- included in this table will be written to the
676 -- output file.
677 --
678 --
679 -- Version Initial version number = 1.0
680 -- History Current version number = 1.0
681 --=======================================================
682 procedure DOWNLOAD_CUSTOM (
683 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
684 p_api_version_number IN NUMBER,
685 p_return_status OUT NOCOPY VARCHAR2,
686 p_application_id IN NUMBER := FND_API.G_MISS_NUM,
687 p_custom_pk_tbl IN AK_CUSTOM_PUB.Custom_PK_Tbl_Type := AK_CUSTOM_PUB.G_MISS_CUSTOM_PK_TBL,
688 p_nls_language IN VARCHAR2,
689 p_get_object_flag IN VARCHAR2,
690 p_level IN VARCHAR2 := FND_API.G_MISS_CHAR,
691 p_levelpk IN VARCHAR2 := FND_API.G_MISS_CHAR
692 );
693
694 --=======================================================
695 -- Procedure INSERT_CUSTOM_PK_TABLE
696 --
697 -- Usage Private API for inserting the given region's
698 -- primary key value into the given object
699 -- table.
700 -- This API should only be called by other APIs
701 -- that are owned by the Core Modules Team (AK).
702 --
703 -- Desc This API inserts the given region's primary
704 -- key value into a given region table
705 -- (of type Object_PK_Tbl_Type) only if the
706 -- primary key does not already exist in the table.
707 --
708 -- Results The API returns the standard p_return_status parameter
709 -- indicating one of the standard return statuses :
710 -- * Unexpected error
711 -- * Error
712 -- * Success
713 -- Parameters p_region_application_id : IN required
714 -- p_region_code : IN required
715 -- Key value of the region to be inserted to the
716 -- table.
717 -- p_custom_pk_tbl : IN OUT
718 -- Region table to be updated.
719 --
720 -- Version Initial version number = 1.0
721 -- History Current version number = 1.0
722 --=======================================================
723 procedure INSERT_CUSTOM_PK_TABLE (
724 p_return_status OUT NOCOPY VARCHAR2,
725 p_region_application_id IN NUMBER,
726 p_region_code IN VARCHAR2,
727 p_custom_appl_id IN NUMBER,
728 p_custom_code IN VARCHAR2,
729 p_custom_pk_tbl IN OUT NOCOPY AK_CUSTOM_PUB.Custom_PK_Tbl_Type
730 );
731
732 --=======================================================
733 -- Function VALIDATE_CUSTOM
734 --
735 -- Usage Private API for validating a customization. This
736 -- API should only be called by other APIs that are
737 -- owned by the Core Modules Team (AK).
738 --
739 -- Desc Perform validation on a customization record.
740 --
741 -- Results The API returns the standard p_return_status parameter
742 -- indicating one of the standard return statuses :
743 -- * Unexpected error
744 -- * Error
745 -- * Success
746 -- In addition, this function returns TRUE if all
747 -- validation tests are passed, or FALSE otherwise.
748 -- Parameters Customizations columns
749 -- p_caller : IN required
750 -- Must be one of the following values defined
751 -- in package AK_ON_OBJECTS_PVT:
752 -- - G_CREATE (if calling from the Create API)
753 -- - G_DOWNLOAD (if calling from the Download API)
754 -- - G_UPDATE (if calling from the Update API)
755 --
756 -- Note This API is intended for performing record-level
757 -- validation. It is not designed for item-level
758 -- validation.
759 --
760 -- Version Initial version number = 1.0
761 -- History Current version number = 1.0
762 --=======================================================
763 function VALIDATE_CUSTOM (
764 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
765 p_api_version_number IN NUMBER,
766 p_return_status OUT NOCOPY VARCHAR2,
767 p_region_application_id IN NUMBER := FND_API.G_MISS_NUM,
768 p_region_code IN VARCHAR2 := FND_API.G_MISS_CHAR,
769 p_custom_application_id IN NUMBER := FND_API.G_MISS_NUM,
770 p_custom_code IN VARCHAR2 := FND_API.G_MISS_CHAR,
771 p_verticalization_id IN VARCHAR2 := FND_API.G_MISS_CHAR,
772 p_localization_code IN VARCHAR2 := FND_API.G_MISS_CHAR,
773 p_org_id IN NUMBER := FND_API.G_MISS_NUM,
774 p_site_id IN NUMBER := FND_API.G_MISS_NUM,
775 p_responsibility_id IN NUMBER := FND_API.G_MISS_NUM,
776 p_web_user_id IN NUMBER := FND_API.G_MISS_NUM,
777 p_default_custom_flag IN VARCHAR2 := FND_API.G_MISS_CHAR,
778 p_customization_level_id IN NUMBER := FND_API.G_MISS_NUM,
779 p_developer_mode IN VARCHAR2 := FND_API.G_MISS_CHAR,
780 p_reference_path IN VARCHAR2 := FND_API.G_MISS_CHAR,
781 p_function_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
782 p_start_date_active IN DATE := FND_API.G_MISS_DATE,
783 p_end_date_Active IN DATE := FND_API.G_MISS_DATE,
784 p_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
785 p_description IN VARCHAR2 := FND_API.G_MISS_CHAR,
786 p_caller IN VARCHAR2,
787 p_pass IN NUMBER := 2
788 ) return boolean;
789
790 --=======================================================
791 -- Function VALIDATE_CUST_REGION
792 --
793 -- Usage Private API for validating a custom region. This
794 -- API should only be called by other APIs that are
795 -- owned by the Core Modules Team (AK).
796 --
797 -- Desc Perform validation on a custom region record.
798 --
799 -- Results The API returns the standard p_return_status parameter
800 -- indicating one of the standard return statuses :
801 -- * Unexpected error
802 -- * Error
803 -- * Success
804 -- In addition, this function returns TRUE if all
805 -- validation tests are passed, or FALSE otherwise.
806 -- Parameters Region graph columns
807 -- p_caller : IN required
808 -- Must be one of the following values defined
809 -- in package AK_ON_OBJECTS_PVT:
810 -- - G_CREATE (if calling from the Create API)
811 -- - G_DOWNLOAD (if calling from the Download API)
812 -- - G_UPDATE (if calling from the Update API)
813 --
814 -- Note This API is intended for performing record-level
815 -- validation. It is not designed for item-level
816 -- validation.
817 --
818 -- Version Initial version number = 1.0
819 -- History Current version number = 1.0
820 --=======================================================
821 function VALIDATE_CUST_REGION (
822 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
823 p_api_version_number IN NUMBER,
824 p_return_status OUT NOCOPY VARCHAR2,
825 p_region_application_id IN NUMBER,
826 p_region_code IN VARCHAR2,
827 p_custom_application_id IN NUMBER,
828 p_custom_code IN VARCHAR2,
829 p_property_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
830 p_property_varchar2_value IN VARCHAR2 := FND_API.G_MISS_CHAR,
831 p_property_number_value IN NUMBER := FND_API.G_MISS_NUM,
832 p_criteria_join_condition IN VARCHAR2 := FND_API.G_MISS_CHAR,
833 p_property_varchar2_value_tl IN VARCHAR2 := FND_API.G_MISS_CHAR,
834 p_caller IN VARCHAR2,
835 p_pass IN NUMBER := 2
836 ) return BOOLEAN;
837
838 --=======================================================
839 -- Function VALIDATE_CUST_REGION_ITEM
840 --
841 -- Usage Private API for validating a custom region item. This
842 -- API should only be called by other APIs that are
843 -- owned by the Core Modules Team (AK).
844 --
845 -- Desc Perform validation on a custom region item record.
846 --
847 -- Results The API returns the standard p_return_status parameter
848 -- indicating one of the standard return statuses :
849 -- * Unexpected error
850 -- * Error
851 -- * Success
852 -- In addition, this function returns TRUE if all
853 -- validation tests are passed, or FALSE otherwise.
854 -- Parameters Custom region item columns
855 -- p_caller : IN required
856 -- Must be one of the following values defined
857 -- in package AK_ON_OBJECTS_PVT:
858 -- - G_CREATE (if calling from the Create API)
859 -- - G_DOWNLOAD (if calling from the Download API)
860 -- - G_UPDATE (if calling from the Update API)
861 --
862 -- Note This API is intended for performing record-level
863 -- validation. It is not designed for item-level
864 -- validation.
865 --
866 -- Version Initial version number = 1.0
867 -- History Current version number = 1.0
868 --=======================================================
869 function VALIDATE_CUST_REGION_ITEM (
870 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
871 p_api_version_number IN NUMBER,
872 p_return_status OUT NOCOPY VARCHAR2,
873 p_region_application_id IN NUMBER,
874 p_region_code IN VARCHAR2,
875 p_custom_application_id IN NUMBER,
876 p_custom_code IN VARCHAR2,
877 p_attr_appl_id IN NUMBER := FND_API.G_MISS_NUM,
878 p_attr_code IN VARCHAR2 := FND_API.G_MISS_CHAR,
879 p_property_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
880 p_property_varchar2_value IN VARCHAR2 := FND_API.G_MISS_CHAR,
881 p_property_number_value IN NUMBER := FND_API.G_MISS_NUM,
882 p_property_date_value IN VARCHAR2 := FND_API.G_MISS_CHAR,
883 p_property_varchar2_value_tl IN VARCHAR2 := FND_API.G_MISS_CHAR,
884 p_caller IN VARCHAR2,
885 p_pass IN NUMBER := 2
886 ) return BOOLEAN;
887
888 --=======================================================
889 -- Function VALIDATE_CRITERIA
890 --
891 -- Usage Private API for validating a custom criteria. This
892 -- API should only be called by other APIs that are
893 -- owned by the Core Modules Team (AK).
894 --
895 -- Desc Perform validation on a custom criteria record.
896 --
897 -- Results The API returns the standard p_return_status parameter
898 -- indicating one of the standard return statuses :
899 -- * Unexpected error
900 -- * Error
901 -- * Success
902 -- In addition, this function returns TRUE if all
903 -- validation tests are passed, or FALSE otherwise.
904 -- Parameters Criteria columns
905 -- p_caller : IN required
906 -- Must be one of the following values defined
907 -- in package AK_ON_OBJECTS_PVT:
908 -- - G_CREATE (if calling from the Create API)
909 -- - G_DOWNLOAD (if calling from the Download API)
910 -- - G_UPDATE (if calling from the Update API)
911 --
912 -- Note This API is intended for performing record-level
913 -- validation. It is not designed for item-level
914 -- validation.
915 --
916 -- Version Initial version number = 1.0
917 -- History Current version number = 1.0
918 --=======================================================
919 function VALIDATE_CRITERIA (
920 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
921 p_api_version_number IN NUMBER,
922 p_return_status OUT NOCOPY VARCHAR2,
923 p_region_application_id IN NUMBER,
924 p_region_code IN VARCHAR2,
925 p_custom_application_id IN NUMBER,
926 p_custom_code IN VARCHAR2,
927 p_attr_appl_id IN NUMBER := FND_API.G_MISS_NUM,
928 p_attr_code IN VARCHAR2 := FND_API.G_MISS_CHAR,
929 p_sequence_number IN NUMBER := FND_API.G_MISS_NUM,
930 p_operation IN VARCHAR2 := FND_API.G_MISS_CHAR,
931 p_value_varchar2 IN VARCHAR2 := FND_API.G_MISS_CHAR,
932 p_value_number IN NUMBER := FND_API.G_MISS_NUM,
933 p_value_date IN DATE := FND_API.G_MISS_DATE,
934 p_start_date_active IN DATE := FND_API.G_MISS_DATE,
935 p_end_date_active IN DATE := FND_API.G_MISS_DATE,
936 p_caller IN VARCHAR2,
937 p_pass IN NUMBER := 2
938 ) return BOOLEAN;
939 end AK_CUSTOM_PVT;
[Home] [Help]