1 package AK_REGION_PVT as
2 /* $Header: akdvregs.pls 120.2 2005/09/15 22:27:02 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_REGION_PVT';
8
9 -- Procedure specs
10
11 /*
12 --=======================================================
13 -- Procedure CREATE_GRAPH
14 --
15 -- Usage Private API for creating a region graph. This
16 -- API should only be called by other APIs that are
17 -- owned by the Core Modules Team (AK).
18 --
19 -- Desc Creates a region graph using the given info.
20 -- This API should only be called by other APIs that are
21 -- owned by the Core Modules Team (AK).
22 --
23 -- Results The API returns the standard p_return_status parameter
24 -- indicating one of the standard return statuses :
25 -- * Unexpected error
26 -- * Error
27 -- * Success
28 -- Parameters Region Item columns
29 -- p_loader_timestamp : IN optional
30 -- If a timestamp is passed, the API will create the
31 -- record using this timestamp. Only the upload API
32 -- should call with this parameter loaded.
33 --
34 -- Version Initial version number = 1.0
35 -- History Current version number = 1.0
36 --=======================================================
37 procedure CREATE_GRAPH (
38 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
39 p_api_version_number IN NUMBER,
40 p_init_msg_tbl IN BOOLEAN := FALSE,
41 p_msg_count OUT NOCOPY NUMBER,
42 p_msg_data OUT NOCOPY VARCHAR2,
43 p_return_status OUT NOCOPY VARCHAR2,
44 p_region_application_id IN NUMBER,
45 p_region_code IN VARCHAR2,
46 p_graph_number IN NUMBER := FND_API.G_MISS_NUM,
47 p_graph_style IN NUMBER := FND_API.G_MISS_NUM,
48 p_display_flag IN VARCHAR2 := FND_API.G_MISS_CHAR,
49 p_depth_radius IN NUMBER := FND_API.G_MISS_NUM,
50 p_graph_title IN VARCHAR2 := FND_API.G_MISS_CHAR,
51 p_y_axis_label IN VARCHAR2 := FND_API.G_MISS_CHAR,
52 p_created_by IN NUMBER := FND_API.G_MISS_NUM,
53 p_creation_date IN DATE := FND_API.G_MISS_DATE,
54 p_last_updated_by IN NUMBER := FND_API.G_MISS_NUM,
55 p_last_update_date IN DATE := FND_API.G_MISS_DATE,
56 p_last_update_login IN NUMBER := FND_API.G_MISS_NUM,
57 p_loader_timestamp IN DATE := FND_API.G_MISS_DATE,
58 p_pass IN NUMBER,
59 p_copy_redo_flag IN OUT NOCOPY BOOLEAN
60 );
61 */
62
63 --=======================================================
64 -- Procedure CREATE_ITEM
65 --
66 -- Usage Private API for creating a region item. This
67 -- API should only be called by other APIs that are
68 -- owned by the Core Modules Team (AK).
69 --
70 -- Desc Creates a region item using the given info.
71 -- This API should only be called by other APIs that are
72 -- owned by the Core Modules Team (AK).
73 --
74 -- Results The API returns the standard p_return_status parameter
75 -- indicating one of the standard return statuses :
76 -- * Unexpected error
77 -- * Error
78 -- * Success
79 -- Parameters Region Item columns
80 -- p_loader_timestamp : IN optional
81 -- If a timestamp is passed, the API will create the
82 -- record using this timestamp. Only the upload API
83 -- should call with this parameter loaded.
84 --
85 -- Version Initial version number = 1.0
86 -- History Current version number = 1.0
87 --=======================================================
88 procedure CREATE_ITEM (
89 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
90 p_api_version_number IN NUMBER,
91 p_init_msg_tbl IN BOOLEAN := FALSE,
92 p_msg_count OUT NOCOPY NUMBER,
93 p_msg_data OUT NOCOPY VARCHAR2,
94 p_return_status OUT NOCOPY VARCHAR2,
95 p_region_application_id IN NUMBER,
96 p_region_code IN VARCHAR2,
97 p_attribute_application_id IN NUMBER,
98 p_attribute_code IN VARCHAR2,
99 p_display_sequence IN NUMBER,
100 p_node_display_flag IN VARCHAR2,
101 p_node_query_flag IN VARCHAR2,
102 p_attribute_label_length IN NUMBER,
103 p_display_value_length IN NUMBER,
104 p_bold IN VARCHAR2,
105 p_italic IN VARCHAR2,
106 p_vertical_alignment IN VARCHAR2,
107 p_horizontal_alignment IN VARCHAR2,
108 p_item_style IN VARCHAR2,
109 p_object_attribute_flag IN VARCHAR2,
110 p_icx_custom_call IN VARCHAR2 := FND_API.G_MISS_CHAR,
111 p_update_flag IN VARCHAR2,
112 p_required_flag IN VARCHAR2,
113 p_security_code IN VARCHAR2 := FND_API.G_MISS_CHAR,
114 p_default_value_varchar2 IN VARCHAR2 := FND_API.G_MISS_CHAR,
115 p_default_value_number IN NUMBER := FND_API.G_MISS_NUM,
116 p_default_value_date IN DATE := FND_API.G_MISS_DATE,
117 p_lov_region_application_id IN NUMBER := FND_API.G_MISS_NUM,
118 p_lov_region_code IN VARCHAR2 := FND_API.G_MISS_CHAR,
119 p_lov_foreign_key_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
120 p_lov_attribute_application_id IN NUMBER := FND_API.G_MISS_NUM,
121 p_lov_attribute_code IN VARCHAR2 := FND_API.G_MISS_CHAR,
122 p_lov_default_flag IN VARCHAR2 := FND_API.G_MISS_CHAR,
123 p_region_defaulting_api_pkg IN VARCHAR2 := FND_API.G_MISS_CHAR,
124 p_region_defaulting_api_proc IN VARCHAR2 := FND_API.G_MISS_CHAR,
125 p_region_validation_api_pkg IN VARCHAR2 := FND_API.G_MISS_CHAR,
126 p_region_validation_api_proc IN VARCHAR2 := FND_API.G_MISS_CHAR,
127 p_order_sequence IN NUMBER := FND_API.G_MISS_NUM,
128 p_order_direction IN VARCHAR2 := FND_API.G_MISS_CHAR,
129 p_display_height IN NUMBER := FND_API.G_MISS_NUM,
130 p_submit IN VARCHAR2,
131 p_encrypt IN VARCHAR2,
132 p_css_class_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
133 p_view_usage_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
134 p_view_attribute_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
135 p_nested_region_appl_id IN NUMBER := FND_API.G_MISS_NUM,
136 p_nested_region_code IN VARCHAR2 := FND_API.G_MISS_CHAR,
137 p_url IN VARCHAR2 := FND_API.G_MISS_CHAR,
138 p_poplist_viewobject IN VARCHAR2 := FND_API.G_MISS_CHAR,
139 p_poplist_display_attr IN VARCHAR2 := FND_API.G_MISS_CHAR,
140 p_poplist_value_attr IN VARCHAR2 := FND_API.G_MISS_CHAR,
141 p_image_file_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
142 p_item_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
143 p_css_label_class_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
144 p_menu_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
145 p_flexfield_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
146 p_flexfield_application_id IN NUMBER := FND_API.G_MISS_NUM,
147 p_tabular_function_code IN VARCHAR2 := FND_API.G_MISS_CHAR,
148 p_tip_type IN VARCHAR2 := FND_API.G_MISS_CHAR,
149 p_tip_message_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
150 p_tip_message_application_id IN NUMBER := FND_API.G_MISS_NUM,
151 p_flex_segment_list IN VARCHAR2 := FND_API.G_MISS_CHAR,
152 p_entity_id IN VARCHAR2 := FND_API.G_MISS_CHAR,
153 p_anchor IN VARCHAR2 := FND_API.G_MISS_CHAR,
154 p_poplist_view_usage_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
155 p_user_customizable IN VARCHAR2 := FND_API.G_MISS_CHAR,
156 p_sortby_view_attribute_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
157 p_admin_customizable IN VARCHAR2,
158 p_invoke_function_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
159 p_expansion IN NUMBER := FND_API.G_MISS_NUM,
160 p_als_max_length IN NUMBER := FND_API.G_MISS_NUM,
161 p_initial_sort_sequence IN VARCHAR2 := FND_API.G_MISS_CHAR,
162 p_customization_application_id IN NUMBER := FND_API.G_MISS_NUM,
163 p_customization_code IN VARCHAR2 := FND_API.G_MISS_CHAR,
164 p_attribute_category IN VARCHAR2 := FND_API.G_MISS_CHAR,
165 p_attribute1 IN VARCHAR2 := FND_API.G_MISS_CHAR,
166 p_attribute2 IN VARCHAR2 := FND_API.G_MISS_CHAR,
167 p_attribute3 IN VARCHAR2 := FND_API.G_MISS_CHAR,
168 p_attribute4 IN VARCHAR2 := FND_API.G_MISS_CHAR,
169 p_attribute5 IN VARCHAR2 := FND_API.G_MISS_CHAR,
170 p_attribute6 IN VARCHAR2 := FND_API.G_MISS_CHAR,
171 p_attribute7 IN VARCHAR2 := FND_API.G_MISS_CHAR,
172 p_attribute8 IN VARCHAR2 := FND_API.G_MISS_CHAR,
173 p_attribute9 IN VARCHAR2 := FND_API.G_MISS_CHAR,
174 p_attribute10 IN VARCHAR2 := FND_API.G_MISS_CHAR,
175 p_attribute11 IN VARCHAR2 := FND_API.G_MISS_CHAR,
176 p_attribute12 IN VARCHAR2 := FND_API.G_MISS_CHAR,
177 p_attribute13 IN VARCHAR2 := FND_API.G_MISS_CHAR,
178 p_attribute14 IN VARCHAR2 := FND_API.G_MISS_CHAR,
179 p_attribute15 IN VARCHAR2 := FND_API.G_MISS_CHAR,
180 p_attribute_label_long IN VARCHAR2 := FND_API.G_MISS_CHAR,
181 p_attribute_label_short IN VARCHAR2 := FND_API.G_MISS_CHAR,
182 p_description IN VARCHAR2 := FND_API.G_MISS_CHAR,
183 p_created_by IN NUMBER := FND_API.G_MISS_NUM,
184 p_creation_date IN DATE := FND_API.G_MISS_DATE,
185 p_last_updated_by IN NUMBER := FND_API.G_MISS_NUM,
186 p_last_update_date IN DATE := FND_API.G_MISS_DATE,
187 p_last_update_login IN NUMBER := FND_API.G_MISS_NUM,
188 p_loader_timestamp IN DATE := FND_API.G_MISS_DATE,
189 p_pass IN NUMBER,
190 p_copy_redo_flag IN OUT NOCOPY BOOLEAN
191 );
192
193 --=======================================================
194 -- Procedure CREATE_REGION
195 --
196 -- Usage Private API for creating a region. This
197 -- API should only be called by other APIs that are
198 -- owned by the Core Modules Team (AK).
199 --
200 -- Desc Creates a region using the given info.
201 -- This API should only be called by other APIs that are
202 -- owned by the Core Modules Team (AK).
203 --
204 -- Results The API returns the standard p_return_status parameter
205 -- indicating one of the standard return statuses :
206 -- * Unexpected error
207 -- * Error
208 -- * Success
209 -- Parameters Region columns
210 -- p_loader_timestamp : IN optional
211 -- If a timestamp is passed, the API will create the
212 -- record using this timestamp. Only the upload API
213 -- should call with this parameter loaded.
214 --
215 -- Version Initial version number = 1.0
216 -- History Current version number = 1.0
217 --=======================================================
218 procedure CREATE_REGION (
219 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
220 p_api_version_number IN NUMBER,
221 p_init_msg_tbl IN BOOLEAN := FALSE,
222 p_msg_count OUT NOCOPY NUMBER,
223 p_msg_data OUT NOCOPY VARCHAR2,
224 p_return_status OUT NOCOPY VARCHAR2,
225 p_region_application_id IN NUMBER,
226 p_region_code IN VARCHAR2,
227 p_database_object_name IN VARCHAR2,
228 p_region_style IN VARCHAR2,
229 p_icx_custom_call IN VARCHAR2 := FND_API.G_MISS_CHAR,
230 p_num_columns IN NUMBER := FND_API.G_MISS_NUM,
231 p_region_defaulting_api_pkg IN VARCHAR2 := FND_API.G_MISS_CHAR,
232 p_region_defaulting_api_proc IN VARCHAR2 := FND_API.G_MISS_CHAR,
233 p_region_validation_api_pkg IN VARCHAR2 := FND_API.G_MISS_CHAR,
234 p_region_validation_api_proc IN VARCHAR2 := FND_API.G_MISS_CHAR,
235 p_appmodule_object_type IN VARCHAR2 := FND_API.G_MISS_CHAR,
236 p_num_rows_display IN NUMBER := FND_API.G_MISS_NUM,
237 p_region_object_type IN VARCHAR2 := FND_API.G_MISS_CHAR,
238 p_image_file_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
239 p_isform_flag IN VARCHAR2,
240 p_help_target IN VARCHAR2 := FND_API.G_MISS_CHAR,
241 p_style_sheet_filename IN VARCHAR2 := FND_API.G_MISS_CHAR,
242 p_version IN VARCHAR2 := FND_API.G_MISS_CHAR,
243 p_applicationmodule_usage_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
244 p_add_indexed_children IN VARCHAR2 := FND_API.G_MISS_CHAR,
245 p_stateful_flag IN VARCHAR2 := FND_API.G_MISS_CHAR,
246 p_function_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
247 p_children_view_usage_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
248 p_search_panel IN VARCHAR2 := FND_API.G_MISS_CHAR,
249 p_advanced_search_panel IN VARCHAR2 := FND_API.G_MISS_CHAR,
250 p_customize_panel IN VARCHAR2 := FND_API.G_MISS_CHAR,
251 p_default_search_panel IN VARCHAR2 := FND_API.G_MISS_CHAR,
252 p_results_based_search IN VARCHAR2 := FND_API.G_MISS_CHAR,
253 p_display_graph_table IN VARCHAR2 := FND_API.G_MISS_CHAR,
254 p_disable_header IN VARCHAR2 := FND_API.G_MISS_CHAR,
255 p_standalone IN VARCHAR2 := FND_API.G_MISS_CHAR,
256 p_auto_customization_criteria IN VARCHAR2 := FND_API.G_MISS_CHAR,
257 p_attribute_category IN VARCHAR2 := FND_API.G_MISS_CHAR,
258 p_attribute1 IN VARCHAR2 := FND_API.G_MISS_CHAR,
259 p_attribute2 IN VARCHAR2 := FND_API.G_MISS_CHAR,
260 p_attribute3 IN VARCHAR2 := FND_API.G_MISS_CHAR,
261 p_attribute4 IN VARCHAR2 := FND_API.G_MISS_CHAR,
262 p_attribute5 IN VARCHAR2 := FND_API.G_MISS_CHAR,
263 p_attribute6 IN VARCHAR2 := FND_API.G_MISS_CHAR,
264 p_attribute7 IN VARCHAR2 := FND_API.G_MISS_CHAR,
265 p_attribute8 IN VARCHAR2 := FND_API.G_MISS_CHAR,
266 p_attribute9 IN VARCHAR2 := FND_API.G_MISS_CHAR,
267 p_attribute10 IN VARCHAR2 := FND_API.G_MISS_CHAR,
268 p_attribute11 IN VARCHAR2 := FND_API.G_MISS_CHAR,
269 p_attribute12 IN VARCHAR2 := FND_API.G_MISS_CHAR,
270 p_attribute13 IN VARCHAR2 := FND_API.G_MISS_CHAR,
271 p_attribute14 IN VARCHAR2 := FND_API.G_MISS_CHAR,
272 p_attribute15 IN VARCHAR2 := FND_API.G_MISS_CHAR,
273 p_name IN VARCHAR2,
274 p_description IN VARCHAR2 := FND_API.G_MISS_CHAR,
275 p_created_by IN NUMBER := FND_API.G_MISS_NUM,
276 p_creation_date IN DATE := FND_API.G_MISS_DATE,
277 p_last_updated_by IN NUMBER := FND_API.G_MISS_NUM,
278 p_last_update_date IN DATE := FND_API.G_MISS_DATE,
279 p_last_update_login IN NUMBER := FND_API.G_MISS_NUM,
280 p_loader_timestamp IN DATE := FND_API.G_MISS_DATE,
281 p_pass IN NUMBER,
282 p_copy_redo_flag IN OUT NOCOPY BOOLEAN
283 );
284
285 /*
286 --=======================================================
287 -- Procedure DELETE_GRAPH
288 --
289 -- Usage Private API for deleting a region graph. This
290 -- API should only be called by other APIs that are
291 -- owned by the Core Modules Team (AK).
292 --
293 -- Desc Deletes a region item with the given key value.
294 --
295 -- Results The API returns the standard p_return_status parameter
296 -- indicating one of the standard return statuses :
297 -- * Unexpected error
298 -- * Error
299 -- * Success
300 -- Parameters p_region_application_id : IN required
301 -- p_region_code : IN required
302 -- p_attribute_application_id : IN required
303 -- p_attribute_code : IN required
304 -- Key value of the region item to be deleted.
305 -- p_delete_cascade : IN required
306 -- If p_delete_cascade flag is 'Y', also delete all
307 -- rows in other tables that references this record.
311 -- Version Initial version number = 1.0
308 -- Otherwise, this record will not be deleted if there
309 -- are any other rows referencing it.
310 --
312 -- History Current version number = 1.0
313 --=======================================================
314 procedure DELETE_GRAPH (
315 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
316 p_api_version_number IN NUMBER,
317 p_init_msg_tbl IN BOOLEAN := FALSE,
318 p_msg_count OUT NOCOPY NUMBER,
319 p_msg_data OUT NOCOPY VARCHAR2,
320 p_return_status OUT NOCOPY VARCHAR2,
321 p_region_application_id IN NUMBER,
322 p_region_code IN VARCHAR2,
323 p_graph_number IN NUMBER,
324 p_delete_cascade IN VARCHAR2
325 );
326 */
327
328 --=======================================================
329 -- Procedure DELETE_ITEM
330 --
331 -- Usage Private API for deleting a region item. This
332 -- API should only be called by other APIs that are
333 -- owned by the Core Modules Team (AK).
334 --
335 -- Desc Deletes a region item with the given key value.
336 --
337 -- Results The API returns the standard p_return_status parameter
338 -- indicating one of the standard return statuses :
339 -- * Unexpected error
340 -- * Error
341 -- * Success
342 -- Parameters p_region_application_id : IN required
343 -- p_region_code : IN required
344 -- p_attribute_application_id : IN required
345 -- p_attribute_code : IN required
346 -- Key value of the region item to be deleted.
347 -- p_delete_cascade : IN required
348 -- If p_delete_cascade flag is 'Y', also delete all
349 -- rows in other tables that references this record.
350 -- Otherwise, this record will not be deleted if there
351 -- are any other rows referencing it.
352 --
353 -- Version Initial version number = 1.0
354 -- History Current version number = 1.0
355 --=======================================================
356 procedure DELETE_ITEM (
357 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
358 p_api_version_number IN NUMBER,
359 p_init_msg_tbl IN BOOLEAN := FALSE,
360 p_msg_count OUT NOCOPY NUMBER,
361 p_msg_data OUT NOCOPY VARCHAR2,
362 p_return_status OUT NOCOPY VARCHAR2,
363 p_region_application_id IN NUMBER,
364 p_region_code IN VARCHAR2,
365 p_attribute_application_id IN NUMBER,
366 p_attribute_code IN VARCHAR2,
367 p_delete_cascade IN VARCHAR2
368 );
369
370 --=======================================================
371 -- Procedure DELETE_REGION
372 --
373 -- Usage Private API for deleting a region. This
374 -- API should only be called by other APIs that are
375 -- owned by the Core Modules Team (AK).
376 --
377 -- Desc Deletes a region with the given key value.
378 --
379 -- Results The API returns the standard p_return_status parameter
380 -- indicating one of the standard return statuses :
381 -- * Unexpected error
382 -- * Error
383 -- * Success
384 -- Parameters p_region_application_id : IN required
385 -- p_region_code : IN required
386 -- Key value of the region to be deleted.
387 -- p_delete_cascade : IN required
388 -- If p_delete_cascade flag is 'Y', also delete all
389 -- rows in other tables that references this record.
390 -- Otherwise, this record will not be deleted if there
391 -- are any other rows referencing it.
392 --
393 -- Version Initial version number = 1.0
394 -- History Current version number = 1.0
395 --=======================================================
396 procedure DELETE_REGION (
397 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
398 p_api_version_number IN NUMBER,
399 p_init_msg_tbl IN BOOLEAN := FALSE,
400 p_msg_count OUT NOCOPY NUMBER,
401 p_msg_data OUT NOCOPY VARCHAR2,
402 p_return_status OUT NOCOPY VARCHAR2,
403 p_region_application_id IN NUMBER,
404 p_region_code IN VARCHAR2,
405 p_delete_cascade IN VARCHAR2
406 );
407
408 --=======================================================
409 -- Procedure DOWNLOAD_REGION
410 --
411 -- Usage Private API for downloading regions. This
412 -- API should only be called by other APIs that are
413 -- owned by the Core Modules Team (AK).
414 --
415 -- Desc This API will extract the regions selected
416 -- by application ID or by key values from the
417 -- database to the output file.
418 -- If a region is selected for writing to the loader
419 -- file, all its children records (including region items)
420 -- will also be written.
421 --
422 -- Results The API returns the standard p_return_status parameter
423 -- indicating one of the standard return statuses :
424 -- * Unexpected error
425 -- * Error
429 -- NLS language for database. If none if given,
426 -- * Success
427 -- Parameters
428 -- p_nls_language : IN optional
430 -- the current NLS language will be used.
431 -- p_get_object_flag : IN required
432 -- Call DOWNLOAD_OBJECT API to extract objects that
433 -- are referenced by the regions that will be extracted
434 -- by this API if this parameter is 'Y'.
435 --
436 -- One of the following parameters must be provided:
437 --
438 -- p_application_id : IN optional
439 -- If given, all attributes for this application ID
440 -- will be written to the output file.
441 -- p_application_id will be ignored if a table is
442 -- given in p_region_pk_tbl.
443 -- p_region_pk_tbl : IN optional
444 -- If given, only regions whose key values are
445 -- included in this table will be written to the
446 -- output file.
447 --
448 --
449 -- Version Initial version number = 1.0
450 -- History Current version number = 1.0
451 --=======================================================
452 procedure DOWNLOAD_REGION (
453 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
454 p_api_version_number IN NUMBER,
455 p_return_status OUT NOCOPY VARCHAR2,
456 p_application_id IN NUMBER := FND_API.G_MISS_NUM,
457 p_region_pk_tbl IN OUT NOCOPY AK_REGION_PUB.Region_PK_Tbl_Type,
458 p_nls_language IN VARCHAR2,
459 p_get_object_flag IN VARCHAR2
460 );
461
462 --=======================================================
463 -- Procedure INSERT_REGION_PK_TABLE
464 --
465 -- Usage Private API for inserting the given region's
466 -- primary key value into the given object
467 -- table.
468 -- This API should only be called by other APIs
469 -- that are owned by the Core Modules Team (AK).
470 --
471 -- Desc This API inserts the given region's primary
472 -- key value into a given region table
473 -- (of type Object_PK_Tbl_Type) only if the
474 -- primary key does not already exist in the table.
475 --
476 -- Results The API returns the standard p_return_status parameter
477 -- indicating one of the standard return statuses :
478 -- * Unexpected error
479 -- * Error
480 -- * Success
481 -- Parameters p_region_application_id : IN required
482 -- p_region_code : IN required
483 -- Key value of the region to be inserted to the
484 -- table.
485 -- p_region_pk_tbl : IN OUT
486 -- Region table to be updated.
487 --
488 -- Version Initial version number = 1.0
489 -- History Current version number = 1.0
490 --=======================================================
491 procedure INSERT_REGION_PK_TABLE (
492 p_return_status OUT NOCOPY VARCHAR2,
493 p_region_application_id IN NUMBER,
494 p_region_code IN VARCHAR2,
495 p_region_pk_tbl IN OUT NOCOPY AK_REGION_PUB.Region_PK_Tbl_Type
496 );
497
498 /*
499 --=======================================================
500 -- Function GRAPH_EXISTS
501 --
502 -- Usage Private API for checking for the existence of
503 -- a region graph with the given key values. This
504 -- API should only be called by other APIs that are
505 -- owned by the Core Modules Team (AK).
506 --
507 -- Desc This API check to see if a region graph record
508 -- exists with the given key values.
509 --
510 -- Results The API returns the standard p_return_status parameter
511 -- indicating one of the standard return statuses :
512 -- * Unexpected error
513 -- * Error
514 -- * Success
515 -- This function will return TRUE if such an object
516 -- attribute exists, or FALSE otherwise.
517 -- Parameters Region Graph key columns
518 --
519 -- Version Initial version number = 1.0
520 -- History Current version number = 1.0
521 --=======================================================
522 function GRAPH_EXISTS (
523 p_api_version_number IN NUMBER,
524 p_return_status OUT NOCOPY VARCHAR2,
525 p_region_application_id IN NUMBER,
526 p_region_code IN VARCHAR2,
527 p_graph_number IN NUMBER
528 ) return BOOLEAN;
529 */
530
531 --=======================================================
532 -- Function ITEM_EXISTS
533 --
534 -- Usage Private API for checking for the existence of
535 -- a region item with the given key values. This
536 -- API should only be called by other APIs that are
537 -- owned by the Core Modules Team (AK).
538 --
539 -- Desc This API check to see if a region item record
540 -- exists with the given key values.
541 --
542 -- Results The API returns the standard p_return_status parameter
543 -- indicating one of the standard return statuses :
544 -- * Unexpected error
548 -- attribute exists, or FALSE otherwise.
545 -- * Error
546 -- * Success
547 -- This function will return TRUE if such an object
549 -- Parameters Region Item key columns
550 --
551 -- Version Initial version number = 1.0
552 -- History Current version number = 1.0
553 --=======================================================
554 function ITEM_EXISTS (
555 p_api_version_number IN NUMBER,
556 p_return_status OUT NOCOPY VARCHAR2,
557 p_region_application_id IN NUMBER,
558 p_region_code IN VARCHAR2,
559 p_attribute_application_id IN NUMBER,
560 p_attribute_code IN VARCHAR2
561 ) return BOOLEAN;
562
563 --=======================================================
564 -- Function REGION_EXISTS
565 --
566 -- Usage Private API for checking for the existence of
567 -- a region with the given key values. This
568 -- API should only be called by other APIs that are
569 -- owned by the Core Modules Team (AK).
570 --
571 -- Desc This API check to see if a region record
572 -- exists with the given key values.
573 --
574 -- Results The API returns the standard p_return_status parameter
575 -- indicating one of the standard return statuses :
576 -- * Unexpected error
577 -- * Error
578 -- * Success
579 -- This function will return TRUE if such an object
580 -- attribute exists, or FALSE otherwise.
581 -- Parameters Region key columns
582 --
583 -- Version Initial version number = 1.0
584 -- History Current version number = 1.0
585 --=======================================================
586 function REGION_EXISTS (
587 p_api_version_number IN NUMBER,
588 p_return_status OUT NOCOPY VARCHAR2,
589 p_region_application_id IN NUMBER,
590 p_region_code IN VARCHAR2
591 ) return BOOLEAN;
592
593 /*
594 --=======================================================
595 -- Procedure UPDATE_GRAPH
596 --
597 -- Usage Private API for updating a region graph.
598 -- This API should only be called by other APIs
599 -- that are owned by the Core Modules Team (AK).
600 --
601 -- Desc This API updates a region graph using the given info
602 --
603 -- Results The API returns the standard p_return_status parameter
604 -- indicating one of the standard return statuses :
605 -- * Unexpected error
606 -- * Error
607 -- * Success
608 -- Parameters Region Graph columns
609 -- p_loader_timestamp : IN optional
610 -- If a timestamp is passed, the API will update the
611 -- record using this timestamp. Only the upload API
612 -- should call with this parameter loaded.
613 --
614 -- Version Initial version number = 1.0
615 -- History Current version number = 1.0
616 --=======================================================
617 procedure UPDATE_GRAPH (
618 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
619 p_api_version_number IN NUMBER,
620 p_init_msg_tbl IN BOOLEAN := FALSE,
621 p_msg_count OUT NOCOPY NUMBER,
622 p_msg_data OUT NOCOPY VARCHAR2,
623 p_return_status OUT NOCOPY VARCHAR2,
624 p_region_application_id IN NUMBER,
625 p_region_code IN VARCHAR2,
626 p_graph_number IN NUMBER,
627 p_graph_style IN NUMBER := FND_API.G_MISS_NUM,
628 p_display_flag IN VARCHAR2 := FND_API.G_MISS_CHAR,
629 p_depth_radius IN NUMBER := FND_API.G_MISS_NUM,
630 p_graph_title IN VARCHAR2 := FND_API.G_MISS_CHAR,
631 p_y_axis_label IN VARCHAR2 := FND_API.G_MISS_CHAR,
632 p_created_by IN NUMBER := FND_API.G_MISS_NUM,
633 p_creation_date IN DATE := FND_API.G_MISS_DATE,
634 p_last_updated_by IN NUMBER := FND_API.G_MISS_NUM,
635 p_last_update_date IN DATE := FND_API.G_MISS_DATE,
636 p_last_update_login IN NUMBER := FND_API.G_MISS_NUM,
637 p_loader_timestamp IN DATE := FND_API.G_MISS_DATE,
638 p_pass IN NUMBER,
639 p_copy_redo_flag IN OUT NOCOPY BOOLEAN
640 );
641 */
642
643 --=======================================================
644 -- Procedure UPDATE_ITEM
645 --
646 -- Usage Private API for updating a region item.
647 -- This API should only be called by other APIs
648 -- that are owned by the Core Modules Team (AK).
649 --
650 -- Desc This API updates a region item using the given info
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 Region Item columns
658 -- p_loader_timestamp : IN optional
659 -- If a timestamp is passed, the API will update the
660 -- record using this timestamp. Only the upload API
661 -- should call with this parameter loaded.
665 --=======================================================
662 --
663 -- Version Initial version number = 1.0
664 -- History Current version number = 1.0
666 procedure UPDATE_ITEM (
667 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
668 p_api_version_number IN NUMBER,
669 p_init_msg_tbl IN BOOLEAN := FALSE,
670 p_msg_count OUT NOCOPY NUMBER,
671 p_msg_data OUT NOCOPY VARCHAR2,
672 p_return_status OUT NOCOPY VARCHAR2,
673 p_region_application_id IN NUMBER,
674 p_region_code IN VARCHAR2,
675 p_attribute_application_id IN NUMBER,
676 p_attribute_code IN VARCHAR2,
677 p_display_sequence IN NUMBER := FND_API.G_MISS_NUM,
678 p_node_display_flag IN VARCHAR2 := FND_API.G_MISS_CHAR,
679 p_node_query_flag IN VARCHAR2 := FND_API.G_MISS_CHAR,
680 p_attribute_label_length IN NUMBER := FND_API.G_MISS_NUM,
681 p_display_value_length IN NUMBER := FND_API.G_MISS_NUM,
682 p_bold IN VARCHAR2 := FND_API.G_MISS_CHAR,
683 p_italic IN VARCHAR2 := FND_API.G_MISS_CHAR,
684 p_vertical_alignment IN VARCHAR2 := FND_API.G_MISS_CHAR,
685 p_horizontal_alignment IN VARCHAR2 := FND_API.G_MISS_CHAR,
686 p_item_style IN VARCHAR2 := FND_API.G_MISS_CHAR,
687 p_object_attribute_flag IN VARCHAR2 := FND_API.G_MISS_CHAR,
688 p_icx_custom_call IN VARCHAR2 := FND_API.G_MISS_CHAR,
689 p_update_flag IN VARCHAR2 := FND_API.G_MISS_CHAR,
690 p_required_flag IN VARCHAR2 := FND_API.G_MISS_CHAR,
691 p_security_code IN VARCHAR2 := FND_API.G_MISS_CHAR,
692 p_default_value_varchar2 IN VARCHAR2 := FND_API.G_MISS_CHAR,
693 p_default_value_number IN NUMBER := FND_API.G_MISS_NUM,
694 p_default_value_date IN DATE := FND_API.G_MISS_DATE,
695 p_lov_region_application_id IN NUMBER := FND_API.G_MISS_NUM,
696 p_lov_region_code IN VARCHAR2 := FND_API.G_MISS_CHAR,
697 p_lov_foreign_key_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
698 p_lov_attribute_application_id IN NUMBER := FND_API.G_MISS_NUM,
699 p_lov_attribute_code IN VARCHAR2 := FND_API.G_MISS_CHAR,
700 p_lov_default_flag IN VARCHAR2 := FND_API.G_MISS_CHAR,
701 p_region_defaulting_api_pkg IN VARCHAR2 := FND_API.G_MISS_CHAR,
702 p_region_defaulting_api_proc IN VARCHAR2 := FND_API.G_MISS_CHAR,
703 p_region_validation_api_pkg IN VARCHAR2 := FND_API.G_MISS_CHAR,
704 p_region_validation_api_proc IN VARCHAR2 := FND_API.G_MISS_CHAR,
705 p_order_sequence IN NUMBER := FND_API.G_MISS_NUM,
706 p_order_direction IN VARCHAR2 := FND_API.G_MISS_CHAR,
707 p_display_height IN NUMBER := FND_API.G_MISS_NUM,
708 p_submit IN VARCHAR2,
709 p_encrypt IN VARCHAR2,
710 p_css_class_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
711 p_view_usage_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
712 p_view_attribute_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
713 p_nested_region_appl_id IN NUMBER := FND_API.G_MISS_NUM,
714 p_nested_region_code IN VARCHAR2 := FND_API.G_MISS_CHAR,
715 p_url IN VARCHAR2 := FND_API.G_MISS_CHAR,
716 p_poplist_viewobject IN VARCHAR2 := FND_API.G_MISS_CHAR,
717 p_poplist_display_attr IN VARCHAR2 := FND_API.G_MISS_CHAR,
718 p_poplist_value_attr IN VARCHAR2 := FND_API.G_MISS_CHAR,
719 p_image_file_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
720 p_item_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
721 p_css_label_class_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
722 p_menu_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
723 p_flexfield_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
724 p_flexfield_application_id IN NUMBER := FND_API.G_MISS_NUM,
725 p_tabular_function_code IN VARCHAR2 := FND_API.G_MISS_CHAR,
726 p_tip_type IN VARCHAR2 := FND_API.G_MISS_CHAR,
727 p_tip_message_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
728 p_tip_message_application_id IN NUMBER := FND_API.G_MISS_NUM,
729 p_flex_segment_list IN VARCHAR2 := FND_API.G_MISS_CHAR,
730 p_entity_id IN VARCHAR2 := FND_API.G_MISS_CHAR,
731 p_anchor IN VARCHAR2 := FND_API.G_MISS_CHAR,
732 p_poplist_view_usage_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
733 p_user_customizable IN VARCHAR2 := FND_API.G_MISS_CHAR,
734 p_sortby_view_attribute_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
735 p_admin_customizable IN VARCHAR2,
736 p_invoke_function_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
737 p_expansion IN NUMBER := FND_API.G_MISS_NUM,
738 p_als_max_length IN NUMBER := FND_API.G_MISS_NUM,
739 p_initial_sort_sequence IN VARCHAR2 := FND_API.G_MISS_CHAR,
740 p_customization_application_id IN NUMBER := FND_API.G_MISS_NUM,
741 p_customization_code IN VARCHAR2 := FND_API.G_MISS_CHAR,
742 p_attribute_category IN VARCHAR2 := FND_API.G_MISS_CHAR,
743 p_attribute1 IN VARCHAR2 := FND_API.G_MISS_CHAR,
744 p_attribute2 IN VARCHAR2 := FND_API.G_MISS_CHAR,
745 p_attribute3 IN VARCHAR2 := FND_API.G_MISS_CHAR,
746 p_attribute4 IN VARCHAR2 := FND_API.G_MISS_CHAR,
747 p_attribute5 IN VARCHAR2 := FND_API.G_MISS_CHAR,
748 p_attribute6 IN VARCHAR2 := FND_API.G_MISS_CHAR,
749 p_attribute7 IN VARCHAR2 := FND_API.G_MISS_CHAR,
750 p_attribute8 IN VARCHAR2 := FND_API.G_MISS_CHAR,
751 p_attribute9 IN VARCHAR2 := FND_API.G_MISS_CHAR,
755 p_attribute13 IN VARCHAR2 := FND_API.G_MISS_CHAR,
752 p_attribute10 IN VARCHAR2 := FND_API.G_MISS_CHAR,
753 p_attribute11 IN VARCHAR2 := FND_API.G_MISS_CHAR,
754 p_attribute12 IN VARCHAR2 := FND_API.G_MISS_CHAR,
756 p_attribute14 IN VARCHAR2 := FND_API.G_MISS_CHAR,
757 p_attribute15 IN VARCHAR2 := FND_API.G_MISS_CHAR,
758 p_attribute_label_long IN VARCHAR2 := FND_API.G_MISS_CHAR,
759 p_attribute_label_short IN VARCHAR2 := FND_API.G_MISS_CHAR,
760 p_description IN VARCHAR2 := FND_API.G_MISS_CHAR,
761 p_created_by IN NUMBER := FND_API.G_MISS_NUM,
762 p_creation_date IN DATE := FND_API.G_MISS_DATE,
763 p_last_updated_by IN NUMBER := FND_API.G_MISS_NUM,
764 p_last_update_date IN DATE := FND_API.G_MISS_DATE,
765 p_last_update_login IN NUMBER := FND_API.G_MISS_NUM,
766 p_loader_timestamp IN DATE := FND_API.G_MISS_DATE,
767 p_pass IN NUMBER,
768 p_copy_redo_flag IN OUT NOCOPY BOOLEAN
769 );
770
771 --=======================================================
772 -- Procedure UPDATE_REGION
773 --
774 -- Usage Private API for updating a region.
775 -- This API should only be called by other APIs
776 -- that are owned by the Core Modules Team (AK).
777 --
778 -- Desc This API updates a region using the given info
779 --
780 -- Results The API returns the standard p_return_status parameter
781 -- indicating one of the standard return statuses :
782 -- * Unexpected error
783 -- * Error
784 -- * Success
785 -- Parameters Region columns
786 -- p_loader_timestamp : IN optional
787 -- If a timestamp is passed, the API will update the
788 -- record using this timestamp. Only the upload API
789 -- should call with this parameter loaded.
790 --
791 -- Version Initial version number = 1.0
792 -- History Current version number = 1.0
793 --=======================================================
794 procedure UPDATE_REGION (
795 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
796 p_api_version_number IN NUMBER,
797 p_init_msg_tbl IN BOOLEAN := FALSE,
798 p_msg_count OUT NOCOPY NUMBER,
799 p_msg_data OUT NOCOPY VARCHAR2,
800 p_return_status OUT NOCOPY VARCHAR2,
801 p_region_application_id IN NUMBER,
802 p_region_code IN VARCHAR2,
803 p_database_object_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
804 p_region_style IN VARCHAR2 := FND_API.G_MISS_CHAR,
805 p_icx_custom_call IN VARCHAR2 := FND_API.G_MISS_CHAR,
806 p_num_columns IN NUMBER := FND_API.G_MISS_NUM,
807 p_region_defaulting_api_pkg IN VARCHAR2 := FND_API.G_MISS_CHAR,
808 p_region_defaulting_api_proc IN VARCHAR2 := FND_API.G_MISS_CHAR,
809 p_region_validation_api_pkg IN VARCHAR2 := FND_API.G_MISS_CHAR,
810 p_region_validation_api_proc IN VARCHAR2 := FND_API.G_MISS_CHAR,
811 p_appmodule_object_type IN VARCHAR2 := FND_API.G_MISS_CHAR,
812 p_num_rows_display IN NUMBER := FND_API.G_MISS_NUM,
813 p_region_object_type IN VARCHAR2 := FND_API.G_MISS_CHAR,
814 p_image_file_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
815 p_isform_flag IN VARCHAR2 := FND_API.G_MISS_CHAR,
816 p_help_target IN VARCHAR2 := FND_API.G_MISS_CHAR,
817 p_style_sheet_filename IN VARCHAR2 := FND_API.G_MISS_CHAR,
818 p_version IN VARCHAR2 := FND_API.G_MISS_CHAR,
819 p_applicationmodule_usage_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
820 p_add_indexed_children IN VARCHAR2 := FND_API.G_MISS_CHAR,
821 p_stateful_flag IN VARCHAR2 := FND_API.G_MISS_CHAR,
822 p_function_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
823 p_children_view_usage_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
824 p_search_panel IN VARCHAR2 := FND_API.G_MISS_CHAR,
825 p_advanced_search_panel IN VARCHAR2 := FND_API.G_MISS_CHAR,
826 p_customize_panel IN VARCHAR2 := FND_API.G_MISS_CHAR,
827 p_default_search_panel IN VARCHAR2 := FND_API.G_MISS_CHAR,
828 p_results_based_search IN VARCHAR2 := FND_API.G_MISS_CHAR,
829 p_display_graph_table IN VARCHAR2 := FND_API.G_MISS_CHAR,
830 p_disable_header IN VARCHAR2 := FND_API.G_MISS_CHAR,
831 p_standalone IN VARCHAR2 := FND_API.G_MISS_CHAR,
832 p_auto_customization_criteria IN VARCHAR2 := FND_API.G_MISS_CHAR,
833 p_attribute_category IN VARCHAR2 := FND_API.G_MISS_CHAR,
834 p_attribute1 IN VARCHAR2 := FND_API.G_MISS_CHAR,
835 p_attribute2 IN VARCHAR2 := FND_API.G_MISS_CHAR,
836 p_attribute3 IN VARCHAR2 := FND_API.G_MISS_CHAR,
837 p_attribute4 IN VARCHAR2 := FND_API.G_MISS_CHAR,
838 p_attribute5 IN VARCHAR2 := FND_API.G_MISS_CHAR,
839 p_attribute6 IN VARCHAR2 := FND_API.G_MISS_CHAR,
840 p_attribute7 IN VARCHAR2 := FND_API.G_MISS_CHAR,
841 p_attribute8 IN VARCHAR2 := FND_API.G_MISS_CHAR,
842 p_attribute9 IN VARCHAR2 := FND_API.G_MISS_CHAR,
843 p_attribute10 IN VARCHAR2 := FND_API.G_MISS_CHAR,
844 p_attribute11 IN VARCHAR2 := FND_API.G_MISS_CHAR,
845 p_attribute12 IN VARCHAR2 := FND_API.G_MISS_CHAR,
846 p_attribute13 IN VARCHAR2 := FND_API.G_MISS_CHAR,
850 p_description IN VARCHAR2 := FND_API.G_MISS_CHAR,
847 p_attribute14 IN VARCHAR2 := FND_API.G_MISS_CHAR,
848 p_attribute15 IN VARCHAR2 := FND_API.G_MISS_CHAR,
849 p_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
851 p_created_by IN NUMBER := FND_API.G_MISS_NUM,
852 p_creation_date IN DATE := FND_API.G_MISS_DATE,
853 p_last_updated_by IN NUMBER := FND_API.G_MISS_NUM,
854 p_last_update_date IN DATE := FND_API.G_MISS_DATE,
855 p_last_update_login IN NUMBER := FND_API.G_MISS_NUM,
856 p_loader_timestamp IN DATE := FND_API.G_MISS_DATE,
857 p_pass IN NUMBER,
858 p_copy_redo_flag IN OUT NOCOPY BOOLEAN
859 );
860
861 /*
862 --=======================================================
863 -- Function VALIDATE_GRAPH
864 --
865 -- Usage Private API for validating a region graph. This
866 -- API should only be called by other APIs that are
867 -- owned by the Core Modules Team (AK).
868 --
869 -- Desc Perform validation on a region graph record.
870 --
871 -- Results The API returns the standard p_return_status parameter
872 -- indicating one of the standard return statuses :
873 -- * Unexpected error
874 -- * Error
875 -- * Success
876 -- In addition, this function returns TRUE if all
877 -- validation tests are passed, or FALSE otherwise.
878 -- Parameters Region graph columns
879 -- p_caller : IN required
880 -- Must be one of the following values defined
881 -- in package AK_ON_OBJECTS_PVT:
882 -- - G_CREATE (if calling from the Create API)
883 -- - G_DOWNLOAD (if calling from the Download API)
884 -- - G_UPDATE (if calling from the Update API)
885 --
886 -- Note This API is intended for performing record-level
887 -- validation. It is not designed for item-level
888 -- validation.
889 --
890 -- Version Initial version number = 1.0
891 -- History Current version number = 1.0
892 --=======================================================
893 function VALIDATE_GRAPH (
894 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
895 p_api_version_number IN NUMBER,
896 p_return_status OUT NOCOPY VARCHAR2,
897 p_region_application_id IN NUMBER,
898 p_region_code IN VARCHAR2,
899 p_graph_number IN NUMBER := FND_API.G_MISS_NUM,
900 p_graph_style IN NUMBER := FND_API.G_MISS_NUM,
901 p_display_flag IN VARCHAR2 := FND_API.G_MISS_CHAR,
902 p_depth_radius IN NUMBER := FND_API.G_MISS_NUM,
903 p_graph_title IN VARCHAR2 := FND_API.G_MISS_CHAR,
904 p_y_axis_label IN VARCHAR2 := FND_API.G_MISS_CHAR,
905 p_caller IN VARCHAR2,
906 p_pass IN NUMBER := 2
907 ) return BOOLEAN;
908 */
909
910 --=======================================================
911 -- Function VALIDATE_ITEM
912 --
913 -- Usage Private API for validating a region item. This
914 -- API should only be called by other APIs that are
915 -- owned by the Core Modules Team (AK).
916 --
917 -- Desc Perform validation on a region item record.
918 --
919 -- Results The API returns the standard p_return_status parameter
920 -- indicating one of the standard return statuses :
921 -- * Unexpected error
922 -- * Error
923 -- * Success
924 -- In addition, this function returns TRUE if all
925 -- validation tests are passed, or FALSE otherwise.
926 -- Parameters Region item columns
927 -- p_caller : IN required
928 -- Must be one of the following values defined
929 -- in package AK_ON_OBJECTS_PVT:
930 -- - G_CREATE (if calling from the Create API)
931 -- - G_DOWNLOAD (if calling from the Download API)
932 -- - G_UPDATE (if calling from the Update API)
933 --
934 -- Note This API is intended for performing record-level
935 -- validation. It is not designed for item-level
936 -- validation.
937 --
938 -- Version Initial version number = 1.0
939 -- History Current version number = 1.0
940 --=======================================================
941 function VALIDATE_ITEM (
942 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
943 p_api_version_number IN NUMBER,
944 p_return_status OUT NOCOPY VARCHAR2,
945 p_region_application_id IN NUMBER,
946 p_region_code IN VARCHAR2,
947 p_attribute_application_id IN NUMBER := FND_API.G_MISS_NUM,
948 p_attribute_code IN VARCHAR2 := FND_API.G_MISS_CHAR,
949 p_display_sequence IN NUMBER := FND_API.G_MISS_NUM,
950 p_node_display_flag IN VARCHAR2 := FND_API.G_MISS_CHAR,
951 p_node_query_flag IN VARCHAR2 := FND_API.G_MISS_CHAR,
952 p_attribute_label_length IN NUMBER := FND_API.G_MISS_NUM,
953 p_display_value_length IN NUMBER := FND_API.G_MISS_NUM,
954 p_bold IN VARCHAR2 := FND_API.G_MISS_CHAR,
955 p_italic IN VARCHAR2 := FND_API.G_MISS_CHAR,
959 p_object_attribute_flag IN VARCHAR2 := FND_API.G_MISS_CHAR,
956 p_vertical_alignment IN VARCHAR2 := FND_API.G_MISS_CHAR,
957 p_horizontal_alignment IN VARCHAR2 := FND_API.G_MISS_CHAR,
958 p_item_style IN VARCHAR2 := FND_API.G_MISS_CHAR,
960 p_icx_custom_call IN VARCHAR2 := FND_API.G_MISS_CHAR,
961 p_update_flag IN VARCHAR2 := FND_API.G_MISS_CHAR,
962 p_required_flag IN VARCHAR2 := FND_API.G_MISS_CHAR,
963 p_security_code IN VARCHAR2 := FND_API.G_MISS_CHAR,
964 p_default_value_varchar2 IN VARCHAR2 := FND_API.G_MISS_CHAR,
965 p_default_value_number IN NUMBER := FND_API.G_MISS_NUM,
966 p_default_value_date IN DATE := FND_API.G_MISS_DATE,
967 p_nested_region_appl_id IN NUMBER := FND_API.G_MISS_NUM,
968 p_nested_region_code IN VARCHAR2 := FND_API.G_MISS_CHAR,
969 p_lov_region_application_id IN NUMBER := FND_API.G_MISS_NUM,
970 p_lov_region_code IN VARCHAR2 := FND_API.G_MISS_CHAR,
971 p_lov_foreign_key_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
972 p_lov_attribute_application_id IN NUMBER := FND_API.G_MISS_NUM,
973 p_lov_attribute_code IN VARCHAR2 := FND_API.G_MISS_CHAR,
974 p_lov_default_flag IN VARCHAR2 := FND_API.G_MISS_CHAR,
975 p_region_defaulting_api_pkg IN VARCHAR2 := FND_API.G_MISS_CHAR,
976 p_region_defaulting_api_proc IN VARCHAR2 := FND_API.G_MISS_CHAR,
977 p_region_validation_api_pkg IN VARCHAR2 := FND_API.G_MISS_CHAR,
978 p_region_validation_api_proc IN VARCHAR2 := FND_API.G_MISS_CHAR,
979 p_order_sequence IN NUMBER := FND_API.G_MISS_NUM,
980 p_order_direction IN VARCHAR2 := FND_API.G_MISS_CHAR,
981 p_menu_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
982 p_flexfield_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
983 p_flexfield_application_id IN NUMBER := FND_API.G_MISS_NUM,
984 p_tabular_function_code IN VARCHAR2 := FND_API.G_MISS_CHAR,
985 p_tip_type IN VARCHAR2 := FND_API.G_MISS_CHAR,
986 p_tip_message_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
987 p_tip_message_application_id IN NUMBER := FND_API.G_MISS_NUM,
988 p_flex_segment_list IN VARCHAR2 := FND_API.G_MISS_CHAR,
989 p_entity_id IN VARCHAR2 := FND_API.G_MISS_CHAR,
990 p_anchor IN VARCHAR2 := FND_API.G_MISS_CHAR,
991 p_poplist_view_usage_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
992 p_user_customizable IN VARCHAR2 := FND_API.G_MISS_CHAR,
993 p_sortby_view_attribute_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
994 p_invoke_function_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
995 p_expansion IN NUMBER := FND_API.G_MISS_NUM,
996 p_als_max_length IN NUMBER := FND_API.G_MISS_NUM,
997 p_initial_sort_sequence IN VARCHAR2 := FND_API.G_MISS_CHAR,
998 p_customization_application_id IN NUMBER := FND_API.G_MISS_NUM,
999 p_customization_code IN VARCHAR2 := FND_API.G_MISS_CHAR,
1000 p_attribute_label_long IN VARCHAR2 := FND_API.G_MISS_CHAR,
1001 p_attribute_label_short IN VARCHAR2 := FND_API.G_MISS_CHAR,
1002 p_caller IN VARCHAR2,
1003 p_pass IN NUMBER := 2
1004 ) return boolean;
1005
1006 --=======================================================
1007 -- Function VALIDATE_REGION
1008 --
1009 -- Usage Private API for validating a region. This
1010 -- API should only be called by other APIs that are
1011 -- owned by the Core Modules Team (AK).
1012 --
1013 -- Desc Perform validation on a region record.
1014 --
1015 -- Results The API returns the standard p_return_status parameter
1016 -- indicating one of the standard return statuses :
1017 -- * Unexpected error
1018 -- * Error
1019 -- * Success
1020 -- In addition, this function returns TRUE if all
1021 -- validation tests are passed, or FALSE otherwise.
1022 -- Parameters Region columns
1023 -- p_caller : IN required
1024 -- Must be one of the following values defined
1025 -- in package AK_ON_OBJECTS_PVT:
1026 -- - G_CREATE (if calling from the Create API)
1027 -- - G_DOWNLOAD (if calling from the Download API)
1028 -- - G_UPDATE (if calling from the Update API)
1029 --
1030 -- Note This API is intended for performing record-level
1031 -- validation. It is not designed for item-level
1032 -- validation.
1033 --
1034 -- Version Initial version number = 1.0
1035 -- History Current version number = 1.0
1036 --=======================================================
1037 function VALIDATE_REGION (
1038 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
1039 p_api_version_number IN NUMBER,
1040 p_return_status OUT NOCOPY VARCHAR2,
1041 p_region_application_id IN NUMBER := FND_API.G_MISS_NUM,
1042 p_region_code IN VARCHAR2 := FND_API.G_MISS_CHAR,
1043 p_database_object_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
1044 p_region_style IN VARCHAR2 := FND_API.G_MISS_CHAR,
1045 p_icx_custom_call IN VARCHAR2 := FND_API.G_MISS_CHAR,
1046 p_num_columns IN NUMBER := FND_API.G_MISS_NUM,
1047 p_region_defaulting_api_pkg IN VARCHAR2 := FND_API.G_MISS_CHAR,
1048 p_region_defaulting_api_proc IN VARCHAR2 := FND_API.G_MISS_CHAR,
1049 p_region_validation_api_pkg IN VARCHAR2 := FND_API.G_MISS_CHAR,
1053 p_caller IN VARCHAR2,
1050 p_region_validation_api_proc IN VARCHAR2 := FND_API.G_MISS_CHAR,
1051 p_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
1052 p_description IN VARCHAR2 := FND_API.G_MISS_CHAR,
1054 p_pass IN NUMBER := 2
1055 ) return boolean;
1056
1057 Procedure ADD_NESTED_REG_TO_REG_PK (
1058 p_region_application_id IN NUMBER,
1059 p_region_code IN VARCHAR2,
1060 p_region_pk_tbl IN OUT NOCOPY AK_REGION_PUB.Region_PK_Tbl_Type
1061 );
1062
1063 end AK_REGION_PVT;
[Home] [Help]