1 package AK_OBJECT_PVT as
2 /* $Header: akdvobjs.pls 120.2 2005/09/15 22:26:58 tshort ship $ */
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_OBJECT_PVT';
8
9 -- Procedure specs
10
11 --=======================================================
12 -- Procedure APPEND_OBJECT_PK_TABLE
13 --
14 -- Usage Private API for merging two object tables.
15 -- This API should only be called by other APIs
16 -- that are owned by the Core Modules Team (AK).
17 --
18 -- Desc This API inserts each object in the from table
19 -- to the end of the to table if the object does
20 -- not exist in the to table.
21 --
22 -- Results The API returns the standard p_return_status parameter
23 -- indicating one of the standard return statuses :
24 -- * Unexpected error
25 -- * Error
26 -- * Success
27 -- Parameters p_from_table : IN required
28 -- Object table to be merged into the to table
29 -- p_to_table : IN OUT
30 -- Object table to which objects in the from table
31 -- will be inserted into
32 --
33 -- Version Initial version number = 1.0
34 -- History Current version number = 1.0
35 --=======================================================
36 procedure APPEND_OBJECT_PK_TABLES (
37 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
38 p_api_version_number IN NUMBER,
39 p_return_status OUT NOCOPY VARCHAR2,
40 p_from_table IN AK_OBJECT_PUB.Object_PK_Tbl_Type,
41 p_to_table IN OUT NOCOPY AK_OBJECT_PUB.Object_PK_Tbl_Type
42 );
43
44 --=======================================================
45 -- Function ATTRIBUTE_EXISTS
46 --
47 -- Usage Private API for checking for the existence of
48 -- an object attribute with the given key values. This
49 -- API should only be called by other APIs that are
50 -- owned by the Core Modules Team (AK).
51 --
52 -- Desc This API check to see if an object attribute record
53 -- exists with the given key values.
54 --
55 -- Results The API returns the standard p_return_status parameter
56 -- indicating one of the standard return statuses :
57 -- * Unexpected error
58 -- * Error
59 -- * Success
60 -- This function will return TRUE if such an object
61 -- attribute exists, or FALSE otherwise.
62 -- Parameters Object Attribute key columns
63 --
64 -- Version Initial version number = 1.0
65 -- History Current version number = 1.0
66 --=======================================================
67 function ATTRIBUTE_EXISTS (
68 p_api_version_number IN NUMBER,
69 p_return_status OUT NOCOPY VARCHAR2,
70 p_database_object_name IN VARCHAR2,
71 p_attribute_application_id IN NUMBER,
72 p_attribute_code IN VARCHAR2
73 ) return BOOLEAN;
74
75 --=======================================================
76 -- Function ATTRIBUTE_NAVIGATION_EXISTS
77 --
78 -- Usage Private API for checking for the existence of
79 -- an attribute navigation record with the given key values.
80 -- This API should only be called by other APIs that are
81 -- owned by the Core Modules Team (AK).
82 --
83 -- Desc This API check to see if an attribute navigation record
84 -- exists with the given key values.
85 --
86 -- Results The API returns the standard p_return_status parameter
87 -- indicating one of the standard return statuses :
88 -- * Unexpected error
89 -- * Error
90 -- * Success
91 -- This function will return TRUE if such an attribute
92 -- navigation record exists, or FALSE otherwise.
93 -- Parameters Attribute Navigation key columns
94 --
95 -- Version Initial version number = 1.0
96 -- History Current version number = 1.0
97 --=======================================================
98 function ATTRIBUTE_NAVIGATION_EXISTS (
99 p_api_version_number IN NUMBER,
100 p_return_status OUT NOCOPY VARCHAR2,
101 p_database_object_name IN VARCHAR2,
102 p_attribute_application_id IN NUMBER,
103 p_attribute_code IN VARCHAR2,
104 p_value_varchar2 IN VARCHAR2,
105 p_value_date IN DATE,
106 p_value_number IN NUMBER
107 ) return BOOLEAN;
108
109 --=======================================================
110 -- Function ATTRIBUTE_VALUE_EXISTS
111 --
112 -- Usage Private API for checking for the existence of
113 -- an attribute value record with the given key values.
114 -- This API should only be called by other APIs that are
115 -- owned by the Core Modules Team (AK).
116 --
117 -- Desc This API check to see if an attribute value record
118 -- exists with the given key values.
119 --
120 -- Results The API returns the standard p_return_status parameter
121 -- indicating one of the standard return statuses :
122 -- * Unexpected error
123 -- * Error
124 -- * Success
125 -- This function will return TRUE if such an attribute
126 -- value record exists, or FALSE otherwise.
127 -- Parameters Attribute Value key columns
128 --
129 -- Version Initial version number = 1.0
130 -- History Current version number = 1.0
131 --=======================================================
132 function ATTRIBUTE_VALUE_EXISTS (
133 p_api_version_number IN NUMBER,
134 p_return_status OUT NOCOPY VARCHAR2,
135 p_database_object_name IN VARCHAR2,
136 p_attribute_application_id IN NUMBER,
137 p_attribute_code IN VARCHAR2,
138 p_key_value1 IN VARCHAR2,
139 p_key_value2 IN VARCHAR2 := FND_API.G_MISS_CHAR,
140 p_key_value3 IN VARCHAR2 := FND_API.G_MISS_CHAR,
141 p_key_value4 IN VARCHAR2 := FND_API.G_MISS_CHAR,
142 p_key_value5 IN VARCHAR2 := FND_API.G_MISS_CHAR,
143 p_key_value6 IN VARCHAR2 := FND_API.G_MISS_CHAR,
144 p_key_value7 IN VARCHAR2 := FND_API.G_MISS_CHAR,
145 p_key_value8 IN VARCHAR2 := FND_API.G_MISS_CHAR,
146 p_key_value9 IN VARCHAR2 := FND_API.G_MISS_CHAR,
147 p_key_value10 IN VARCHAR2 := FND_API.G_MISS_CHAR
148 ) return BOOLEAN;
149
150 -- CREATE came back to here
151 --
152 --=======================================================
153 -- Procedure INSERT_OBJECT_PK_TABLE
154 --
155 -- Usage Private API for inserting the given object's
156 -- primary key value into the given object
157 -- table.
158 -- This API should only be called by other APIs
159 -- that are owned by the Core Modules Team (AK).
160 --
161 -- Desc This API inserts the given object primary
162 -- key value into a given object table
163 -- (of type Object_PK_Tbl_Type) only if the
164 -- primary key does not already exist in the table.
165 --
166 -- Results The API returns the standard p_return_status parameter
167 -- indicating one of the standard return statuses :
168 -- * Unexpected error
169 -- * Error
170 -- * Success
171 -- Parameters p_database_object_name : IN required
172 -- Key value of the object to be inserted to the
173 -- table.
174 -- p_object_pk_tbl : IN OUT
175 -- Object table to be updated.
176 --
177 -- Version Initial version number = 1.0
178 -- History Current version number = 1.0
179 --=======================================================
180 procedure INSERT_OBJECT_PK_TABLE (
181 p_return_status OUT NOCOPY VARCHAR2,
182 p_database_object_name IN VARCHAR2,
183 p_object_pk_tbl IN OUT NOCOPY AK_OBJECT_PUB.Object_PK_Tbl_Type
184 );
185
186 --=======================================================
187 -- Function OBJECT_EXISTS
188 --
189 -- Usage Private API for checking for the existence of
190 -- an object with the given key values. This
191 -- API should only be called by other APIs that are
192 -- owned by the Core Modules Team (AK).
193 --
194 -- Desc This API check to see if an object
195 -- exists with the given key values.
196 --
197 -- Results The API returns the standard p_return_status parameter
198 -- indicating one of the standard return statuses :
199 -- * Unexpected error
200 -- * Error
201 -- * Success
202 -- This function will return TRUE if such an object
203 -- exists, or FALSE otherwise.
204 -- Parameters Object key columns
205 --
206 -- Version Initial version number = 1.0
207 -- History Current version number = 1.0
208 --=======================================================
209 function OBJECT_EXISTS (
210 p_api_version_number IN NUMBER,
211 p_return_status OUT NOCOPY VARCHAR2,
212 p_database_object_name IN VARCHAR2
213 ) return BOOLEAN;
214
215 --=======================================================
216 -- Procedure DELETE_ATTRIBUTE
217 --
218 -- Usage Private API for deleting an object attribute. This
219 -- API should only be called by other APIs that are
220 -- owned by the Core Modules Team (AK).
221 --
222 -- Desc Deletes an object attribute with the given key value.
223 --
224 -- Results The API returns the standard p_return_status parameter
225 -- indicating one of the standard return statuses :
226 -- * Unexpected error
227 -- * Error
228 -- * Success
229 -- Parameters p_database_object_name : IN required
230 -- p_attribute_application_id : IN required
231 -- p_attribute_code : IN required
232 -- Key value of the object attribute to be deleted.
233 -- p_delete_cascade : IN required
234 -- If p_delete_cascade flag is 'Y', also delete all
235 -- rows in other tables that references this record.
236 -- Otherwise, this record will not be deleted if there
237 -- are any other rows referencing it.
238 --
239 -- Version Initial version number = 1.0
240 -- History Current version number = 1.0
241 --=======================================================
242 procedure DELETE_ATTRIBUTE (
243 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
244 p_api_version_number IN NUMBER,
245 p_init_msg_tbl IN BOOLEAN := FALSE,
246 p_msg_count OUT NOCOPY NUMBER,
247 p_msg_data OUT NOCOPY VARCHAR2,
248 p_return_status OUT NOCOPY VARCHAR2,
249 p_database_object_name IN VARCHAR2,
250 p_attribute_application_id IN NUMBER,
251 p_attribute_code IN VARCHAR2,
252 p_delete_cascade IN VARCHAR2
253 );
254
255 --=======================================================
256 -- Procedure DELETE_ATTRIBUTE_NAVIGATION
257 --
258 -- Usage Private API for deleting an attribute navigation
259 -- record. This API should only be called by other APIs
260 -- that are owned by the Core Modules Team (AK).
261 --
262 -- Desc Deletes an attribute navigation record with the
263 -- given key value.
264 --
265 -- Results The API returns the standard p_return_status parameter
266 -- indicating one of the standard return statuses :
267 -- * Unexpected error
268 -- * Error
269 -- * Success
270 -- Parameters p_database_object_name : IN required
271 -- p_attribute_application_id : IN required
272 -- p_attribute_code : IN required
273 -- p_value_varchar2 : IN required (can be null)
274 -- p_value_date : IN required (can be null)
275 -- p_value_number : IN required (can be null)
276 -- Key value of the attribute navigation record
277 -- to be deleted.
278 -- p_delete_cascade : IN required
279 -- If p_delete_cascade flag is 'Y', also delete all
280 -- rows in other tables that references this record.
281 -- Otherwise, this record will not be deleted if there
282 -- are any other rows referencing it.
283 --
284 -- Version Initial version number = 1.0
285 -- History Current version number = 1.0
286 --=======================================================
287 procedure DELETE_ATTRIBUTE_NAVIGATION (
288 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
289 p_api_version_number IN NUMBER,
290 p_init_msg_tbl IN BOOLEAN := FALSE,
291 p_msg_count OUT NOCOPY NUMBER,
292 p_msg_data OUT NOCOPY VARCHAR2,
293 p_return_status OUT NOCOPY VARCHAR2,
294 p_database_object_name IN VARCHAR2,
295 p_attribute_application_id IN NUMBER,
296 p_attribute_code IN VARCHAR2,
297 p_value_varchar2 IN VARCHAR2,
298 p_value_date IN DATE,
299 p_value_number IN NUMBER,
300 p_delete_cascade IN VARCHAR2 := 'N'
301 );
302
303 --=======================================================
304 -- Procedure DELETE_ATTRIBUTE_VALUE
305 --
306 -- Usage Private API for deleting an attribute value record.
307 -- This API should only be called by other APIs that are
308 -- owned by the Core Modules Team (AK).
309 --
310 -- Desc Deletes an attribute value record with the given key value.
311 --
312 -- Results The API returns the standard p_return_status parameter
313 -- indicating one of the standard return statuses :
314 -- * Unexpected error
315 -- * Error
316 -- * Success
317 -- Parameters p_database_object_name : IN required
318 -- p_attribute_application_id : IN required
319 -- p_attribute_code : IN required
320 -- p_key_value1 : IN required
321 -- p_key_value2 thru p_key_value10 : IN optional
322 -- Key value of the attribute value record
323 -- to be deleted.
324 -- p_delete_cascade : IN required
325 -- If p_delete_cascade flag is 'Y', also delete all
326 -- rows in other tables that references this record.
327 -- Otherwise, this record will not be deleted if there
328 -- are any other rows referencing it.
332 --=======================================================
329 --
330 -- Version Initial version number = 1.0
331 -- History Current version number = 1.0
333 procedure DELETE_ATTRIBUTE_VALUE (
334 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
335 p_api_version_number IN NUMBER,
336 p_init_msg_tbl IN BOOLEAN := FALSE,
337 p_msg_count OUT NOCOPY NUMBER,
338 p_msg_data OUT NOCOPY VARCHAR2,
339 p_return_status OUT NOCOPY VARCHAR2,
340 p_database_object_name IN VARCHAR2,
341 p_attribute_application_id IN NUMBER,
342 p_attribute_code IN VARCHAR2,
343 p_key_value1 IN VARCHAR2,
344 p_key_value2 IN VARCHAR2 := FND_API.G_MISS_CHAR,
345 p_key_value3 IN VARCHAR2 := FND_API.G_MISS_CHAR,
346 p_key_value4 IN VARCHAR2 := FND_API.G_MISS_CHAR,
347 p_key_value5 IN VARCHAR2 := FND_API.G_MISS_CHAR,
348 p_key_value6 IN VARCHAR2 := FND_API.G_MISS_CHAR,
349 p_key_value7 IN VARCHAR2 := FND_API.G_MISS_CHAR,
350 p_key_value8 IN VARCHAR2 := FND_API.G_MISS_CHAR,
351 p_key_value9 IN VARCHAR2 := FND_API.G_MISS_CHAR,
352 p_key_value10 IN VARCHAR2 := FND_API.G_MISS_CHAR,
353 p_delete_cascade IN VARCHAR2 := 'N'
354 );
355
356 --=======================================================
357 -- Procedure DELETE_OBJECT
358 --
359 -- Usage Private API for deleting an object. This
360 -- API should only be called by other APIs that are
361 -- owned by the Core Modules Team (AK).
362 --
363 -- Desc Deletes an object with the given key value.
364 --
365 -- Results The API returns the standard p_return_status parameter
366 -- indicating one of the standard return statuses :
367 -- * Unexpected error
368 -- * Error
369 -- * Success
370 -- Parameters p_database_object_name : IN required
371 -- database object name of the object to be deleted
372 -- p_delete_cascade : IN required
373 -- If p_delete_cascade flag is 'Y', also delete all
374 -- rows in other tables that references this attribute.
375 -- Otherwise, this attribute will not be deleted if there
376 -- are any other rows referencing it.
377 --
378 -- Version Initial version number = 1.0
379 -- History Current version number = 1.0
380 --=======================================================
381 procedure DELETE_OBJECT (
382 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
383 p_api_version_number IN NUMBER,
384 p_init_msg_tbl IN BOOLEAN := FALSE,
385 p_msg_count OUT NOCOPY NUMBER,
386 p_msg_data OUT NOCOPY VARCHAR2,
387 p_return_status OUT NOCOPY VARCHAR2,
388 p_database_object_name IN VARCHAR2,
389 p_delete_cascade IN VARCHAR2 := 'N'
390 );
391
392 --=======================================================
393 -- Function VALIDATE_ATTRIBUTE
394 --
395 -- Usage Private API for validating an object attribute. This
396 -- API should only be called by other APIs that are
397 -- owned by the Core Modules Team (AK).
398 --
399 -- Desc Perform validation on an object attribute record.
400 --
401 -- Results The API returns the standard p_return_status parameter
402 -- indicating one of the standard return statuses :
403 -- * Unexpected error
404 -- * Error
405 -- * Success
406 -- In addition, this function returns TRUE if all
407 -- validation tests are passed, or FALSE otherwise.
408 -- Parameters Object Attribute columns
409 -- p_caller : IN required
410 -- Must be one of the following values defined
411 -- in package AK_ON_OBJECTS_PVT:
412 -- - G_CREATE (if calling from the Create API)
413 -- - G_DOWNLOAD (if calling from the Download API)
414 -- - G_UPDATE (if calling from the Update API)
415 --
416 -- Note This API is intended for performing record-level
417 -- validation. It is not designed for item-level
418 -- validation.
419 --
420 -- Version Initial version number = 1.0
421 -- History Current version number = 1.0
422 --=======================================================
423 function VALIDATE_ATTRIBUTE (
424 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
425 p_api_version_number IN NUMBER,
426 p_return_status OUT NOCOPY VARCHAR2,
427 p_database_object_name IN VARCHAR2,
428 p_attribute_application_id IN NUMBER,
429 p_attribute_code IN VARCHAR2,
430 p_column_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
431 p_attribute_label_length IN NUMBER := FND_API.G_MISS_NUM,
432 p_display_value_length IN NUMBER := FND_API.G_MISS_NUM,
433 p_bold IN VARCHAR2 := FND_API.G_MISS_CHAR,
434 p_italic IN VARCHAR2 := FND_API.G_MISS_CHAR,
435 p_vertical_alignment IN VARCHAR2 := FND_API.G_MISS_CHAR,
436 p_horizontal_alignment IN VARCHAR2 := FND_API.G_MISS_CHAR,
440 p_base_table_column_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
437 p_data_source_type IN VARCHAR2 := FND_API.G_MISS_CHAR,
438 p_data_storage_type IN VARCHAR2 := FND_API.G_MISS_CHAR,
439 p_table_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
441 p_required_flag IN VARCHAR2 := FND_API.G_MISS_CHAR,
442 p_default_value_varchar2 IN VARCHAR2 := FND_API.G_MISS_CHAR,
443 p_default_value_number IN NUMBER := FND_API.G_MISS_NUM,
444 p_default_value_date IN DATE := FND_API.G_MISS_DATE,
445 p_lov_region_application_id IN NUMBER := FND_API.G_MISS_NUM,
446 p_lov_region_code IN VARCHAR2 := FND_API.G_MISS_CHAR,
447 p_lov_foreign_key_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
448 p_lov_attribute_application_id IN NUMBER := FND_API.G_MISS_NUM,
449 p_lov_attribute_code IN VARCHAR2 := FND_API.G_MISS_CHAR,
450 p_defaulting_api_pkg IN VARCHAR2 := FND_API.G_MISS_CHAR,
451 p_defaulting_api_proc IN VARCHAR2 := FND_API.G_MISS_CHAR,
452 p_validation_api_pkg IN VARCHAR2 := FND_API.G_MISS_CHAR,
453 p_validation_api_proc IN VARCHAR2 := FND_API.G_MISS_CHAR,
454 p_attribute_label_long IN VARCHAR2 := FND_API.G_MISS_CHAR,
455 p_attribute_label_short IN VARCHAR2 := FND_API.G_MISS_CHAR,
456 p_caller IN VARCHAR2,
457 p_pass IN NUMBER := 2
458 ) return BOOLEAN;
459
460 --==========================================================
461 -- Function VALIDATE_ATTRIBUTE_NAVIGATION
462 --
463 -- Usage Private API for validating an attribute navigation.
464 -- record.
465 -- This API should only be called by other APIs that are
466 -- owned by the Core Modules Team (AK).
467 --
468 -- Desc Perform validation on an attribute navigation record.
469 --
470 -- Results The API returns the standard p_return_status parameter
471 -- indicating one of the standard return statuses :
472 -- * Unexpected error
473 -- * Error
474 -- * Success
475 -- In addition, this function returns TRUE if all
476 -- validation tests are passed, or FALSE otherwise.
477 -- Parameters Attribute Navigation columns
478 -- p_caller : IN required
479 -- Must be one of the following values defined
480 -- in package AK_ON_OBJECTS_PVT:
481 -- - G_CREATE (if calling from the Create API)
482 -- - G_DOWNLOAD (if calling from the Download API)
483 -- - G_UPDATE (if calling from the Update API)
484 --
485 -- Note This API is intended for performing record-level
486 -- validation. It is not designed for item-level
487 -- validation.
488 --
489 -- Version Initial version number = 1.0
490 -- History Current version number = 1.0
491 --==========================================================
492 function VALIDATE_ATTRIBUTE_NAVIGATION (
493 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
494 p_api_version_number IN NUMBER,
495 p_return_status OUT NOCOPY VARCHAR2,
496 p_database_object_name IN VARCHAR2,
497 p_attribute_application_id IN NUMBER,
498 p_attribute_code IN VARCHAR2,
499 p_value_varchar2 IN VARCHAR2,
500 p_value_date IN DATE,
501 p_value_number IN NUMBER,
502 p_to_region_appl_id IN NUMBER := FND_API.G_MISS_NUM,
503 p_to_region_code IN VARCHAR2 := FND_API.G_MISS_CHAR,
504 p_caller IN VARCHAR2,
505 p_pass IN NUMBER := 2
506 ) return BOOLEAN;
507
508 --=======================================================
509 -- Function VALIDATE_ATTRIBUTE_VALUE
510 --
511 -- Usage Private API for validating an attribute value record.
512 -- This API should only be called by other APIs that are
513 -- owned by the Core Modules Team (AK).
514 --
515 -- Desc Perform validation on an attribute value record.
516 --
517 -- Results The API returns the standard p_return_status parameter
518 -- indicating one of the standard return statuses :
519 -- * Unexpected error
520 -- * Error
521 -- * Success
522 -- In addition, this function returns TRUE if all
523 -- validation tests are passed, or FALSE otherwise.
524 -- Parameters Attribute Value columns
525 -- p_caller : IN required
526 -- Must be one of the following values defined
527 -- in package AK_ON_OBJECTS_PVT:
528 -- - G_CREATE (if calling from the Create API)
529 -- - G_DOWNLOAD (if calling from the Download API)
530 -- - G_UPDATE (if calling from the Update API)
531 --
532 -- Note This API is intended for performing record-level
533 -- validation. It is not designed for item-level
534 -- validation.
535 --
536 -- Version Initial version number = 1.0
537 -- History Current version number = 1.0
538 --=======================================================
539 function VALIDATE_ATTRIBUTE_VALUE (
540 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
541 p_api_version_number IN NUMBER,
542 p_return_status OUT NOCOPY VARCHAR2,
546 p_key_value1 IN VARCHAR2,
543 p_database_object_name IN VARCHAR2,
544 p_attribute_application_id IN NUMBER,
545 p_attribute_code IN VARCHAR2,
547 p_key_value2 IN VARCHAR2 := FND_API.G_MISS_CHAR,
548 p_key_value3 IN VARCHAR2 := FND_API.G_MISS_CHAR,
549 p_key_value4 IN VARCHAR2 := FND_API.G_MISS_CHAR,
550 p_key_value5 IN VARCHAR2 := FND_API.G_MISS_CHAR,
551 p_key_value6 IN VARCHAR2 := FND_API.G_MISS_CHAR,
552 p_key_value7 IN VARCHAR2 := FND_API.G_MISS_CHAR,
553 p_key_value8 IN VARCHAR2 := FND_API.G_MISS_CHAR,
554 p_key_value9 IN VARCHAR2 := FND_API.G_MISS_CHAR,
555 p_key_value10 IN VARCHAR2 := FND_API.G_MISS_CHAR,
556 p_value_varchar2 IN VARCHAR2 := FND_API.G_MISS_CHAR,
557 p_value_date IN DATE := FND_API.G_MISS_DATE,
558 p_value_number IN NUMBER := FND_API.G_MISS_NUM,
559 p_caller IN VARCHAR2
560 ) return BOOLEAN;
561
562 --=======================================================
563 -- Function VALIDATE_OBJECT
564 --
565 -- Usage Private API for validating an object record.
566 -- This API should only be called by other APIs that are
567 -- owned by the Core Modules Team (AK).
568 --
569 -- Desc Perform validation on an object record.
570 --
571 -- Results The API returns the standard p_return_status parameter
572 -- indicating one of the standard return statuses :
573 -- * Unexpected error
574 -- * Error
575 -- * Success
576 -- In addition, this function returns TRUE if all
577 -- validation tests are passed, or FALSE otherwise.
578 -- Parameters Object columns
579 -- p_caller : IN required
580 -- Must be one of the following values defined
581 -- in package AK_ON_OBJECTS_PVT:
582 -- - G_CREATE (if calling from the Create API)
583 -- - G_DOWNLOAD (if calling from the Download API)
584 -- - G_UPDATE (if calling from the Update API)
585 --
586 -- Note This API is intended for performing record-level
587 -- validation. It is not designed for item-level
588 -- validation.
589 --
590 -- Version Initial version number = 1.0
591 -- History Current version number = 1.0
592 --=======================================================
593 function VALIDATE_OBJECT (
594 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
595 p_api_version_number IN NUMBER,
596 p_return_status OUT NOCOPY VARCHAR2,
597 p_database_object_name IN VARCHAR2,
598 p_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
599 p_description IN VARCHAR2 := FND_API.G_MISS_CHAR,
600 p_application_id IN NUMBER := FND_API.G_MISS_NUM,
601 p_primary_key_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
602 p_defaulting_api_pkg IN VARCHAR2 := FND_API.G_MISS_CHAR,
603 p_defaulting_api_proc IN VARCHAR2 := FND_API.G_MISS_CHAR,
604 p_validation_api_pkg IN VARCHAR2 := FND_API.G_MISS_CHAR,
605 p_validation_api_proc IN VARCHAR2 := FND_API.G_MISS_CHAR,
606 p_caller IN VARCHAR2,
607 p_pass IN NUMBER := 2
608 ) return BOOLEAN;
609
610 --=======================================================
611 -- Procedure CREATE_ATTRIBUTE
612 --
613 -- Usage Private API for creating an object attribute. This
614 -- API should only be called by other APIs that are
615 -- owned by the Core Modules Team (AK).
616 --
617 -- Desc Creates an object attribute using the given info.
618 -- This API should only be called by other APIs that are
619 -- owned by the Core Modules Team (AK).
620 --
621 -- Results The API returns the standard p_return_status parameter
622 -- indicating one of the standard return statuses :
623 -- * Unexpected error
624 -- * Error
625 -- * Success
626 -- Parameters Object Attribute columns
627 -- p_loader_timestamp : IN optional
628 -- If a timestamp is passed, the API will create the
629 -- record using this timestamp. Only the upload API
630 -- should call with this parameter loaded.
631 --
632 -- Version Initial version number = 1.0
633 -- History Current version number = 1.0
634 --=======================================================
635 procedure CREATE_ATTRIBUTE (
636 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
637 p_api_version_number IN NUMBER,
638 p_init_msg_tbl IN BOOLEAN := FALSE,
639 p_msg_count OUT NOCOPY NUMBER,
640 p_msg_data OUT NOCOPY VARCHAR2,
641 p_return_status OUT NOCOPY VARCHAR2,
642 p_database_object_name IN VARCHAR2,
643 p_attribute_application_id IN NUMBER,
644 p_attribute_code IN VARCHAR2,
645 p_column_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
646 p_attribute_label_length IN NUMBER,
647 p_display_value_length IN NUMBER,
648 p_bold IN VARCHAR2,
649 p_italic IN VARCHAR2,
653 p_data_storage_type IN VARCHAR2 := FND_API.G_MISS_CHAR,
650 p_vertical_alignment IN VARCHAR2,
651 p_horizontal_alignment IN VARCHAR2,
652 p_data_source_type IN VARCHAR2,
654 p_table_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
655 p_base_table_column_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
656 p_required_flag IN VARCHAR2,
657 p_default_value_varchar2 IN VARCHAR2 := FND_API.G_MISS_CHAR,
658 p_default_value_number IN NUMBER := FND_API.G_MISS_NUM,
659 p_default_value_date IN DATE := FND_API.G_MISS_DATE,
660 p_lov_region_application_id IN NUMBER := FND_API.G_MISS_NUM,
661 p_lov_region_code IN VARCHAR2 := FND_API.G_MISS_CHAR,
662 p_lov_foreign_key_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
663 p_lov_attribute_application_id IN NUMBER := FND_API.G_MISS_NUM,
664 p_lov_attribute_code IN VARCHAR2 := FND_API.G_MISS_CHAR,
665 p_defaulting_api_pkg IN VARCHAR2 := FND_API.G_MISS_CHAR,
666 p_defaulting_api_proc IN VARCHAR2 := FND_API.G_MISS_CHAR,
667 p_validation_api_pkg IN VARCHAR2 := FND_API.G_MISS_CHAR,
668 p_validation_api_proc IN VARCHAR2 := FND_API.G_MISS_CHAR,
669 p_attribute_category IN VARCHAR2 := FND_API.G_MISS_CHAR,
670 p_attribute1 IN VARCHAR2 := FND_API.G_MISS_CHAR,
671 p_attribute2 IN VARCHAR2 := FND_API.G_MISS_CHAR,
672 p_attribute3 IN VARCHAR2 := FND_API.G_MISS_CHAR,
673 p_attribute4 IN VARCHAR2 := FND_API.G_MISS_CHAR,
674 p_attribute5 IN VARCHAR2 := FND_API.G_MISS_CHAR,
675 p_attribute6 IN VARCHAR2 := FND_API.G_MISS_CHAR,
676 p_attribute7 IN VARCHAR2 := FND_API.G_MISS_CHAR,
677 p_attribute8 IN VARCHAR2 := FND_API.G_MISS_CHAR,
678 p_attribute9 IN VARCHAR2 := FND_API.G_MISS_CHAR,
679 p_attribute10 IN VARCHAR2 := FND_API.G_MISS_CHAR,
680 p_attribute11 IN VARCHAR2 := FND_API.G_MISS_CHAR,
681 p_attribute12 IN VARCHAR2 := FND_API.G_MISS_CHAR,
682 p_attribute13 IN VARCHAR2 := FND_API.G_MISS_CHAR,
683 p_attribute14 IN VARCHAR2 := FND_API.G_MISS_CHAR,
684 p_attribute15 IN VARCHAR2 := FND_API.G_MISS_CHAR,
685 p_attribute_label_long IN VARCHAR2 := FND_API.G_MISS_CHAR,
686 p_attribute_label_short IN VARCHAR2 := FND_API.G_MISS_CHAR,
687 p_created_by IN NUMBER := FND_API.G_MISS_NUM,
688 p_creation_date IN DATE := FND_API.G_MISS_DATE,
689 p_last_updated_by IN NUMBER := FND_API.G_MISS_NUM,
690 p_last_update_date IN DATE := FND_API.G_MISS_DATE,
691 p_last_update_login IN NUMBER := FND_API.G_MISS_NUM,
692 p_loader_timestamp IN DATE := FND_API.G_MISS_DATE,
693 p_pass IN NUMBER,
694 p_copy_redo_flag IN OUT NOCOPY BOOLEAN
695 );
696
697 --=======================================================
698 -- Procedure CREATE_ATTRIBUTE_NAVIGATION
699 --
700 -- Usage Private API for creating an attribute navigation
701 -- record. This API should only be called by other APIs
702 -- that are owned by the Core Modules Team (AK).
703 --
704 -- Desc Creates an attribute navigation record using the given
705 -- info. This API should only be called by other APIs that
706 -- are owned by the Core Modules Team (AK).
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 Attribute Navigation columns
714 -- p_loader_timestamp : IN optional
715 -- If a timestamp is passed, the API will create the
716 -- record using this timestamp. Only the upload API
717 -- should call with this parameter loaded.
718 --
719 -- Version Initial version number = 1.0
720 -- History Current version number = 1.0
721 --=======================================================
722 procedure CREATE_ATTRIBUTE_NAVIGATION (
723 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
724 p_api_version_number IN NUMBER,
725 p_init_msg_tbl IN BOOLEAN := FALSE,
726 p_msg_count OUT NOCOPY NUMBER,
727 p_msg_data OUT NOCOPY VARCHAR2,
728 p_return_status OUT NOCOPY VARCHAR2,
729 p_database_object_name IN VARCHAR2,
730 p_attribute_application_id IN NUMBER,
731 p_attribute_code IN VARCHAR2,
732 p_value_varchar2 IN VARCHAR2,
733 p_value_date IN DATE,
734 p_value_number IN NUMBER,
735 p_to_region_appl_id IN NUMBER,
736 p_to_region_code IN VARCHAR2,
737 p_attribute_category IN VARCHAR2 := FND_API.G_MISS_CHAR,
738 p_attribute1 IN VARCHAR2 := FND_API.G_MISS_CHAR,
739 p_attribute2 IN VARCHAR2 := FND_API.G_MISS_CHAR,
740 p_attribute3 IN VARCHAR2 := FND_API.G_MISS_CHAR,
741 p_attribute4 IN VARCHAR2 := FND_API.G_MISS_CHAR,
742 p_attribute5 IN VARCHAR2 := FND_API.G_MISS_CHAR,
743 p_attribute6 IN VARCHAR2 := FND_API.G_MISS_CHAR,
744 p_attribute7 IN VARCHAR2 := FND_API.G_MISS_CHAR,
745 p_attribute8 IN VARCHAR2 := FND_API.G_MISS_CHAR,
749 p_attribute12 IN VARCHAR2 := FND_API.G_MISS_CHAR,
746 p_attribute9 IN VARCHAR2 := FND_API.G_MISS_CHAR,
747 p_attribute10 IN VARCHAR2 := FND_API.G_MISS_CHAR,
748 p_attribute11 IN VARCHAR2 := FND_API.G_MISS_CHAR,
750 p_attribute13 IN VARCHAR2 := FND_API.G_MISS_CHAR,
751 p_attribute14 IN VARCHAR2 := FND_API.G_MISS_CHAR,
752 p_attribute15 IN VARCHAR2 := FND_API.G_MISS_CHAR,
753 p_created_by IN NUMBER := FND_API.G_MISS_NUM,
754 p_creation_date IN DATE := FND_API.G_MISS_DATE,
755 p_last_updated_by IN NUMBER := FND_API.G_MISS_NUM,
756 p_last_update_date IN DATE := FND_API.G_MISS_DATE,
757 p_last_update_login IN NUMBER := FND_API.G_MISS_NUM,
758 p_loader_timestamp IN DATE := FND_API.G_MISS_DATE,
759 p_pass IN NUMBER,
760 p_copy_redo_flag IN OUT NOCOPY BOOLEAN
761 );
762
763 --=======================================================
764 -- Procedure CREATE_ATTRIBUTE_VALUE
765 --
766 -- Usage Private API for creating an attribute value record.
767 -- This API should only be called by other APIs that are
768 -- owned by the Core Modules Team (AK).
769 --
770 -- Desc Creates an attribute value record using the given info.
771 -- This API should only be called by other APIs that are
772 -- owned by the Core Modules Team (AK).
773 --
774 -- Results The API returns the standard p_return_status parameter
775 -- indicating one of the standard return statuses :
776 -- * Unexpected error
777 -- * Error
778 -- * Success
779 -- Parameters Attribute Value columns
780 -- p_loader_timestamp : IN optional
781 -- If a timestamp is passed, the API will create the
782 -- record using this timestamp. Only the upload API
783 -- should call with this parameter loaded.
784 --
785 -- Version Initial version number = 1.0
786 -- History Current version number = 1.0
787 --=======================================================
788 procedure CREATE_ATTRIBUTE_VALUE (
789 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
790 p_api_version_number IN NUMBER,
791 p_init_msg_tbl IN BOOLEAN := FALSE,
792 p_msg_count OUT NOCOPY NUMBER,
793 p_msg_data OUT NOCOPY VARCHAR2,
794 p_return_status OUT NOCOPY VARCHAR2,
795 p_database_object_name IN VARCHAR2,
796 p_attribute_application_id IN NUMBER,
797 p_attribute_code IN VARCHAR2,
798 p_key_value1 IN VARCHAR2,
799 p_key_value2 IN VARCHAR2 := FND_API.G_MISS_CHAR,
800 p_key_value3 IN VARCHAR2 := FND_API.G_MISS_CHAR,
801 p_key_value4 IN VARCHAR2 := FND_API.G_MISS_CHAR,
802 p_key_value5 IN VARCHAR2 := FND_API.G_MISS_CHAR,
803 p_key_value6 IN VARCHAR2 := FND_API.G_MISS_CHAR,
804 p_key_value7 IN VARCHAR2 := FND_API.G_MISS_CHAR,
805 p_key_value8 IN VARCHAR2 := FND_API.G_MISS_CHAR,
806 p_key_value9 IN VARCHAR2 := FND_API.G_MISS_CHAR,
807 p_key_value10 IN VARCHAR2 := FND_API.G_MISS_CHAR,
808 p_value_varchar2 IN VARCHAR2 := FND_API.G_MISS_CHAR,
809 p_value_date IN DATE := FND_API.G_MISS_DATE,
810 p_value_number IN NUMBER := FND_API.G_MISS_NUM,
811 p_created_by IN NUMBER := FND_API.G_MISS_NUM,
812 p_creation_date IN DATE := FND_API.G_MISS_DATE,
813 p_last_updated_by IN NUMBER := FND_API.G_MISS_NUM,
814 p_last_update_date IN DATE := FND_API.G_MISS_DATE,
815 p_last_update_login IN NUMBER := FND_API.G_MISS_NUM,
816 p_loader_timestamp IN DATE := FND_API.G_MISS_DATE
817 );
818
819 --=======================================================
820 -- Procedure CREATE_OBJECT
821 --
822 -- Usage Private API for creating an object. This
823 -- API should only be called by other APIs that are
824 -- owned by the Core Modules Team (AK).
825 --
826 -- Desc Creates an object using the given info. This
827 -- API should only be called by other APIs that are
828 -- owned by the Core Modules Team (AK).
829 --
830 -- Results The API returns the standard p_return_status parameter
831 -- indicating one of the standard return statuses :
832 -- * Unexpected error
833 -- * Error
834 -- * Success
835 -- Parameters Object columns
836 -- p_loader_timestamp : IN optional
837 -- If a timestamp is passed, the API will create the
838 -- record using this timestamp. Only the upload API
839 -- should call with this parameter loaded.
840 --
841 -- Version Initial version number = 1.0
842 -- History Current version number = 1.0
843 --=======================================================
844 procedure CREATE_OBJECT (
845 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
846 p_api_version_number IN NUMBER,
847 p_init_msg_tbl IN BOOLEAN := FALSE,
848 p_msg_count OUT NOCOPY NUMBER,
852 p_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
849 p_msg_data OUT NOCOPY VARCHAR2,
850 p_return_status OUT NOCOPY VARCHAR2,
851 p_database_object_name IN VARCHAR2,
853 p_description IN VARCHAR2 := FND_API.G_MISS_CHAR,
854 p_application_id IN NUMBER,
855 p_primary_key_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
856 p_defaulting_api_pkg IN VARCHAR2 := FND_API.G_MISS_CHAR,
857 p_defaulting_api_proc IN VARCHAR2 := FND_API.G_MISS_CHAR,
858 p_validation_api_pkg IN VARCHAR2 := FND_API.G_MISS_CHAR,
859 p_validation_api_proc IN VARCHAR2 := FND_API.G_MISS_CHAR,
860 p_attribute_category IN VARCHAR2 := FND_API.G_MISS_CHAR,
861 p_attribute1 IN VARCHAR2 := FND_API.G_MISS_CHAR,
862 p_attribute2 IN VARCHAR2 := FND_API.G_MISS_CHAR,
863 p_attribute3 IN VARCHAR2 := FND_API.G_MISS_CHAR,
864 p_attribute4 IN VARCHAR2 := FND_API.G_MISS_CHAR,
865 p_attribute5 IN VARCHAR2 := FND_API.G_MISS_CHAR,
866 p_attribute6 IN VARCHAR2 := FND_API.G_MISS_CHAR,
867 p_attribute7 IN VARCHAR2 := FND_API.G_MISS_CHAR,
868 p_attribute8 IN VARCHAR2 := FND_API.G_MISS_CHAR,
869 p_attribute9 IN VARCHAR2 := FND_API.G_MISS_CHAR,
870 p_attribute10 IN VARCHAR2 := FND_API.G_MISS_CHAR,
871 p_attribute11 IN VARCHAR2 := FND_API.G_MISS_CHAR,
872 p_attribute12 IN VARCHAR2 := FND_API.G_MISS_CHAR,
873 p_attribute13 IN VARCHAR2 := FND_API.G_MISS_CHAR,
874 p_attribute14 IN VARCHAR2 := FND_API.G_MISS_CHAR,
875 p_attribute15 IN VARCHAR2 := FND_API.G_MISS_CHAR,
876 p_created_by IN NUMBER := FND_API.G_MISS_NUM,
877 p_creation_date IN DATE := FND_API.G_MISS_DATE,
878 p_last_updated_by IN NUMBER := FND_API.G_MISS_NUM,
879 p_last_update_date IN DATE := FND_API.G_MISS_DATE,
880 p_last_update_login IN NUMBER := FND_API.G_MISS_NUM,
881 p_loader_timestamp IN DATE := FND_API.G_MISS_DATE,
882 p_pass IN NUMBER,
883 p_copy_redo_flag IN OUT NOCOPY BOOLEAN
884 );
885
886 --=======================================================
887 -- Function VALID_COLUMN_NAME
888 --
889 -- Desc This function check for the existence of
890 -- a column within a given table.
891 --
892 -- Results Returns TRUE if the column exists in
893 -- the given table, or FALSE otherwise.
894 --
895 -- Parameters p_table_name : IN required
896 -- Name of the table that contains the column
897 -- p_column_name : IN required
898 -- Name of the column to be checked.
899 --=======================================================
900
901 function VALID_COLUMN_NAME (
902 p_table_name IN VARCHAR2,
903 p_column_name IN VARCHAR2
904 ) return BOOLEAN;
905
906 end AK_OBJECT_PVT;
[Home] [Help]