DBA Data[Home] [Help]

PACKAGE: APPS.FND_XDFDICTIONARY_PKG

Source


1 package Fnd_XdfDictionary_Pkg AUTHID CURRENT_USER as
2 /* $Header: fndpxdts.pls 120.2 2007/12/03 13:12:31 vkhatri ship $ */
3 
4 
5 --
6 -- UploadTable (PUBLIC))
7 --   Public procedure for afdict.lct to call when uploading tables using
8 --   using afdict.lct. It calls InsertTable() when needed.
9 --
10 procedure UploadTable (
11   x_application_short_name       in varchar2,
12   x_table_name                   in varchar2,
13   x_user_table_name              in varchar2,
14   x_table_type                   in varchar2,
15   x_description                  in varchar2,
16   x_auto_size                    in varchar2,
17   x_initial_extent               in varchar2,
18   x_next_extent                  in varchar2,
19   x_min_extents                  in varchar2,
20   x_max_extents                  in varchar2,
21   x_ini_trans                    in varchar2,
22   x_max_trans                    in varchar2,
23   x_pct_free                     in varchar2,
24   x_pct_increase                 in varchar2,
25   x_pct_used                     in varchar2,
26   x_hosted_support_style         in varchar2,
27   x_user_id                      in varchar2);
28 
29 
30 --
31 -- UploadColumn (PUBLIC))
32 --   Public procedure for afdict.lct to call when uploading columns using
33 --   using afdict.lct. It calls InsertColumn() when needed.
34 --
35 
36 procedure UploadColumn (
37   x_application_short_name       in varchar2,
38   x_table_name                   in varchar2,
39   x_column_name                  in varchar2,
40   x_user_column_name             in varchar2,
41   x_column_sequence              in varchar2,
42   x_column_type                  in varchar2,
43   x_width                        in varchar2,
44   x_null_allowed_flag            in varchar2,
45   x_description                  in varchar2,
46   x_default_value                in varchar2,
47   x_translate_flag               in varchar2,
48   x_precision                    in varchar2,
49   x_scale                        in varchar2,
50   x_flexfield_usage_code         in varchar2,
51   x_flexfield_application_id     in varchar2,
52   x_flexfield_name               in varchar2,
53   x_flex_value_set_app_id        in varchar2,
54   x_flex_value_set_id            in varchar2,
55   x_user_id                      in varchar2);
56 
57 
58 --
59 -- UploadHistColumn (PUBLIC))
60 --   Public procedure for afdict.lct to call when uploading hist columns using
61 --   using afdict.lct. It calls InsertHistColumn() when needed.
62 --
63 
64 procedure UploadHistColumn (
65   x_application_short_name       in varchar2,
66   x_table_name                   in varchar2,
67   x_column_name                  in varchar2,
68   x_partition                    in varchar2,
69   x_hsize                        in varchar2,
70   x_user_id                      in varchar2);
71 
72 --
73 -- UploadIndex (PUBLIC))
74 --   Public procedure for afdict.lct to call when uploading indexes using
75 --   using afdict.lct. It calls InsertIndex() when needed.
76 --
77 procedure UploadIndex (
78   x_application_short_name       in varchar2,
79   x_table_name                   in varchar2,
80   x_index_name                   in varchar2,
81   x_uniqueness                   in varchar2,
82   x_auto_size                    in varchar2,
83   x_description                  in varchar2,
84   x_initial_extent               in varchar2,
85   x_next_extent                  in varchar2,
86   x_min_extents                  in varchar2,
87   x_max_extents                  in varchar2,
88   x_ini_trans                    in varchar2,
89   x_max_trans                    in varchar2,
90   x_pct_free                     in varchar2,
91   x_pct_increase                 in varchar2,
92   x_user_id                      in varchar2);
93 
94 --
95 -- UploadIndexColumn (PUBLIC))
96 --   Public procedure for afdict.lct to call when uploading index columns using
97 --   using afdict.lct.
98 --
99 procedure UploadIndexColumn (
100   x_application_short_name       in varchar2,
101   x_table_name                   in varchar2,
102   x_index_name                   in varchar2,
103   x_index_column_name            in varchar2,
104   x_index_column_sequence        in varchar2,
105   x_user_id                      in varchar2);
106 
107 --
108 -- UploadPrimaryKey (PUBLIC))
109 --   Public procedure for afdict.lct to call when uploading primary key using
110 --   using afdict.lct.  It calls InsertPrimary() when needed.
111 --
112 procedure UploadPrimaryKey (
113   x_application_short_name       in varchar2,
114   x_table_name                   in varchar2,
115   x_primary_key_name             in varchar2,
116   x_primary_key_type             in varchar2,
117   x_audit_key_flag               in varchar2,
118   x_description                  in varchar2,
119   x_enabled_flag                 in varchar2,
120   x_user_id                      in varchar2);
121 
122 --
123 -- UploadPrimaryKeyColumn (PUBLIC))
124 --   Public procedure for afdict.lct to call when uploading primary key column
125 --   using afdict.lct.
126 --
127 procedure UploadPrimaryKeyColumn (
128   x_application_short_name       in varchar2,
129   x_table_name                   in varchar2,
130   x_primary_key_name             in varchar2,
131   x_primary_key_column_name      in varchar2,
132   x_primary_key_column_sequence  in varchar2,
133   x_user_id                      in varchar2);
134 
135 --
136 -- UploadForeignKey (PUBLIC))
137 --   Public procedure for afdict.lct to call when uploading foreign key using
138 --   using afdict.lct.  It calls InsertForeign() when needed.
139 --
140 procedure UploadForeignKey (
141   x_application_short_name       in varchar2,
142   x_table_name                   in varchar2,
143   x_foreign_key_name             in varchar2,
144   x_primary_key_application_name in varchar2,
145   x_primary_key_table_name       in varchar2,
146   x_primary_key_name             in varchar2,
147   x_description                  in varchar2,
148   x_cascade_behavior             in varchar2,
149   x_foreign_key_relation         in varchar2,
150   x_condition                    in varchar2,
151   x_enabled_flag                 in varchar2,
152   x_user_id                      in varchar2);
153 
154 --
155 -- UploadForeignKeyColumn (PUBLIC))
156 --   Public procedure for afdict.lct to call when uploading foreign key column
157 --   using afdict.lct.
158 --
159 procedure UploadForeignKeyColumn (
160   x_application_short_name       in varchar2,
161   x_table_name                   in varchar2,
162   x_foreign_key_name             in varchar2,
163   x_foreign_key_column_name      in varchar2,
164   x_foreign_key_column_sequence  in varchar2,
165   x_cascade_value                in varchar2,
166   x_user_id                      in varchar2);
167 
168 --
169 -- UploadSequence (PUBLIC))
170 --   Public procedure for afdict.lct to call when uploading sequence
171 --   using afdict.lct. It calls InsertSequence when needed.
172 --
173 procedure UploadSequence (
174   x_application_short_name       in varchar2,
175   x_sequence_name                in varchar2,
176   x_start_value                  in varchar2,
177   x_description                  in varchar2,
178   x_increment_by                 in varchar2,
179   x_min_value                    in varchar2,
180   x_max_value                    in varchar2,
181   x_cache_size                   in varchar2,
182   x_cycle_flag                   in varchar2,
183   x_order_flag                   in varchar2,
184   x_user_id                      in varchar2);
185 
186 --
187 -- UploadView (PUBLIC))
188 --   Public procedure for afdict.lct to call when uploading view
189 --   using afdict.lct. It calls InsertView when needed.
190 --
191 procedure UploadView (
192   x_application_short_name       in varchar2,
193   x_view_name                    in varchar2,
194   x_text                         in varchar2,
195   x_description                  in varchar2,
196   x_user_id                      in varchar2);
197 
198 --
199 -- UploadViewColumn (PUBLIC))
200 --   Public procedure for afdict.lct to call when uploading view column
201 --   using afdict.lct.
202 --
203 procedure UploadViewColumn (
204   x_application_short_name       in varchar2,
205   x_view_name                    in varchar2,
206   x_view_column_name             in varchar2,
207   x_view_column_sequence         in varchar2,
208   x_user_id                      in varchar2);
209 
210 --
211 -- ViewTextLength (PUBLIC)
212 --   Return the view text length.
213 --   This is a helper function as length() function can not be used
214 --   directly in sql but is ok to used on a variable in PL/SQL.
215 --
216 function ViewTextLength (
217   x_application_id               in number,
218   x_view_name                    in varchar2) return number;
219 pragma restrict_references(ViewTextLength, WNDS);
220 
221 --
222 -- RemoveColumn (PUBLIC)
223 --   Remove column from FND_COLUMNS table.
224 --   Before removing this column, make sure that there is no index,
225 --   primary key or foreign key is using this column
226 --
227 procedure RemoveColumn(
228   x_application_short_name       in varchar2,
229   x_table_name                   in varchar2,
230   x_column_name                  in varchar2);
231 
232 --
233 -- RemoveIndex (PUBLIC)
234 --   Remove index from FND_INDEXES and FND_INDEX_COLUMNS table.
235 --
236 procedure RemoveIndex(
237   x_application_short_name       in varchar2,
238   x_table_name                   in varchar2,
239   x_index_name                   in varchar2);
240 
241 --
242 -- RemovePrimaryKey (PUBLIC)
243 --   Remove primary key from FND_PRIMARY_KEYS and FND_PRIMARY_KEY_COLUMNS table.
244 --   Before deleting primary key, make sure that there is no foreign key
245 --   pointing to this primary key
246 --
247 procedure RemovePrimaryKey(
248   x_application_short_name       in varchar2,
249   x_table_name                   in varchar2,
250   x_primary_key_name             in varchar2);
251 
252 --
253 -- RemoveForeignKey (PUBLIC)
254 --   Remove foreign key from FND_FOREIGN_KEYS and FND_FOREIGN_KEY_COLUMNS table.
255 --
256 procedure RemoveForeignKey(
257   x_application_short_name       in varchar2,
258   x_table_name                   in varchar2,
259   x_foreign_key_name             in varchar2);
260 
261 --
262 -- RemoveSequence (PUBLIC)
263 --   Remove sequence from FND_SEQUENCES table.
264 --
265 procedure RemoveSequence(
266   x_application_short_name       in varchar2,
267   x_sequence_name                in varchar2);
268 
269 --
270 -- RemoveView (PUBLIC)
271 --   Remove view from FND_VIEWS and FND_VIEW_COLUMNS table.
272 --
273 procedure RemoveView(
274   x_application_short_name       in varchar2,
275   x_view_name                    in varchar2);
276 
277 --
278 -- RemoveTable (PUBLIC)
279 --   Remove table from FND_TABLES and all its columns, indexes, primary
280 --   keys and foreign keys.
281 --
282 procedure RemoveTable(
283   x_application_short_name       in varchar2,
284   x_table_name                   in varchar2);
285 
286 --
287 -- UploadTable (PUBLIC)) - Overloaded
288 --   Public procedure for afdict.lct to call when uploading tables using
289 --   using afdict.lct. It calls InsertTable() when needed.
290 --
291 procedure UploadTable (
292   x_application_short_name       in varchar2,
293   x_table_name                   in varchar2,
294   x_user_table_name              in varchar2,
295   x_table_type                   in varchar2,
296   x_description                  in varchar2,
297   x_auto_size                    in varchar2,
298   x_initial_extent               in varchar2,
299   x_next_extent                  in varchar2,
300   x_min_extents                  in varchar2,
301   x_max_extents                  in varchar2,
302   x_ini_trans                    in varchar2,
303   x_max_trans                    in varchar2,
304   x_pct_free                     in varchar2,
305   x_pct_increase                 in varchar2,
306   x_pct_used                     in varchar2,
307   x_hosted_support_style         in varchar2,
308   x_user_id                      in varchar2,
309   x_custom_mode 			   in varchar2,
310   x_last_update_date 		   in varchar2);
311 
312 --
313 -- UploadColumn (PUBLIC))- Overloaded
314 --   Public procedure for afdict.lct to call when uploading columns using
315 --   using afdict.lct. It calls InsertColumn() when needed.
316 --
317 
318 procedure UploadColumn (
319   x_application_short_name       in varchar2,
320   x_table_name                   in varchar2,
321   x_column_name                  in varchar2,
322   x_user_column_name             in varchar2,
323   x_column_sequence              in varchar2,
324   x_column_type                  in varchar2,
325   x_width                        in varchar2,
326   x_null_allowed_flag            in varchar2,
327   x_description                  in varchar2,
328   x_default_value                in varchar2,
329   x_translate_flag               in varchar2,
330   x_precision                    in varchar2,
331   x_scale                        in varchar2,
332   x_flexfield_usage_code         in varchar2,
333   x_flexfield_application_id     in varchar2,
334   x_flexfield_name               in varchar2,
335   x_flex_value_set_app_id        in varchar2,
336   x_flex_value_set_id            in varchar2,
337   x_user_id                      in varchar2,
338   x_custom_mode 			   in varchar2,
339   x_last_update_date 		   in varchar2);
340 
341 --
342 -- UploadHistColumn (PUBLIC)) - Overloaded
343 --   Public procedure for afdict.lct to call when uploading hist columns using
344 --   using afdict.lct. It calls InsertHistColumn() when needed.
345 --
346 
347 procedure UploadHistColumn (
348   x_application_short_name       in varchar2,
349   x_table_name                   in varchar2,
350   x_column_name                  in varchar2,
351   x_partition                    in varchar2,
352   x_hsize                        in varchar2,
353   x_user_id                      in varchar2,
354   x_custom_mode 			   in varchar2,
355   x_last_update_date 		   in varchar2);
356 
357 --
358 -- Public procedure UploadHistColumn_MV () -
359 -- upload MVIEW metadata
360 
361 procedure UploadHistColumn_MV (
362   x_application_short_name       in varchar2,
363   x_table_name                   in varchar2,
364   x_column_name                  in varchar2,
365   x_partition                    in varchar2,
366   x_hsize                        in varchar2,
367   x_user_id                      in varchar2,
368   x_custom_mode 		  in varchar2,
369   x_last_update_date 		   in varchar2,
370   x_mview_owner                    in varchar2
371 ) ;
372 
373 --
374 -- UploadIndex (PUBLIC)) - Overloaded
375 --   Public procedure for afdict.lct to call when uploading indexes using
376 --   using afdict.lct. It calls InsertIndex() when needed.
377 --
378 procedure UploadIndex (
382   x_uniqueness                   in varchar2,
379   x_application_short_name       in varchar2,
380   x_table_name                   in varchar2,
381   x_index_name                   in varchar2,
383   x_auto_size                    in varchar2,
384   x_description                  in varchar2,
385   x_initial_extent               in varchar2,
386   x_next_extent                  in varchar2,
387   x_min_extents                  in varchar2,
388   x_max_extents                  in varchar2,
389   x_ini_trans                    in varchar2,
390   x_max_trans                    in varchar2,
391   x_pct_free                     in varchar2,
392   x_pct_increase                 in varchar2,
393   x_user_id                      in varchar2,
394   x_custom_mode 		 in varchar2,
395   x_last_update_date 		 in varchar2,
396   x_phase_mode                   in varchar2);
397 
398 --
399 -- UploadIndexColumn (PUBLIC)) - Overloaded
400 --   Public procedure for afdict.lct to call when uploading index columns using
401 --   using afdict.lct.
402 --
403 procedure UploadIndexColumn (
404   x_application_short_name       in varchar2,
405   x_table_name                   in varchar2,
406   x_index_name                   in varchar2,
407   x_index_column_name            in varchar2,
408   x_index_column_sequence        in varchar2,
409   x_user_id                      in varchar2,
410   x_custom_mode 			   in varchar2,
411   x_last_update_date 		   in varchar2);
412 
413 --
414 -- UploadPrimaryKey (PUBLIC)) - Overloaded
415 --   Public procedure for afdict.lct to call when uploading primary key using
416 --   using afdict.lct.  It calls InsertPrimary() when needed.
417 --
418 procedure UploadPrimaryKey (
419   x_application_short_name       in varchar2,
420   x_table_name                   in varchar2,
421   x_primary_key_name             in varchar2,
422   x_primary_key_type             in varchar2,
423   x_audit_key_flag               in varchar2,
424   x_description                  in varchar2,
425   x_enabled_flag                 in varchar2,
426   x_user_id                      in varchar2,
427   x_custom_mode 			   in varchar2,
428   x_last_update_date 		   in varchar2,
429   x_phase_mode			 in varchar2,
430   x_overwrite_PK		   in varchar2 DEFAULT 'N'
431   );
432 
433 --
434 -- UploadPrimaryKeyColumn (PUBLIC)) - Overloaded
435 --   Public procedure for afdict.lct to call when uploading primary key column
436 --   using afdict.lct.
437 --
438 procedure UploadPrimaryKeyColumn (
439   x_application_short_name       in varchar2,
440   x_table_name                   in varchar2,
441   x_primary_key_name             in varchar2,
442   x_primary_key_column_name      in varchar2,
443   x_primary_key_column_sequence  in varchar2,
444   x_user_id                      in varchar2,
445   x_custom_mode 			   in varchar2,
446   x_last_update_date 		   in varchar2);
447 
448 --
449 -- UploadForeignKey (PUBLIC)) - Overloaded
450 --   Public procedure for afdict.lct to call when uploading foreign key using
451 --   using afdict.lct.  It calls InsertForeign() when needed.
452 --
453 procedure UploadForeignKey (
454   x_application_short_name       in varchar2,
455   x_table_name                   in varchar2,
456   x_foreign_key_name             in varchar2,
457   x_primary_key_application_name in varchar2,
458   x_primary_key_table_name       in varchar2,
459   x_primary_key_name             in varchar2,
460   x_description                  in varchar2,
461   x_cascade_behavior             in varchar2,
462   x_foreign_key_relation         in varchar2,
463   x_condition                    in varchar2,
464   x_enabled_flag                 in varchar2,
465   x_user_id                      in varchar2,
466   x_custom_mode 			   in varchar2,
467   x_last_update_date 		   in varchar2,
468   x_phase_mode			 in varchar2);
469 
470 --
471 -- UploadForeignKeyColumn (PUBLIC)) - Overloaded
472 --   Public procedure for afdict.lct to call when uploading foreign key column
473 --   using afdict.lct.
474 --
475 procedure UploadForeignKeyColumn (
476   x_application_short_name       in varchar2,
477   x_table_name                   in varchar2,
478   x_foreign_key_name             in varchar2,
479   x_foreign_key_column_name      in varchar2,
480   x_foreign_key_column_sequence  in varchar2,
481   x_cascade_value                in varchar2,
482   x_user_id                      in varchar2,
483   x_custom_mode 			   in varchar2,
484   x_last_update_date 		   in varchar2);
485 
486 --
487 -- UploadSequence (PUBLIC)) - Overloaded
488 --   Public procedure for afdict.lct to call when uploading sequence
489 --   using afdict.lct. It calls InsertSequence when needed.
490 --
491 procedure UploadSequence (
492   x_application_short_name       in varchar2,
493   x_sequence_name                in varchar2,
494   x_start_value                  in varchar2,
495   x_description                  in varchar2,
496   x_increment_by                 in varchar2,
497   x_min_value                    in varchar2,
498   x_max_value                    in varchar2,
499   x_cache_size                   in varchar2,
500   x_cycle_flag                   in varchar2,
501   x_order_flag                   in varchar2,
502   x_user_id                      in varchar2,
503   x_custom_mode 			   in varchar2,
504   x_last_update_date 		   in varchar2);
505 
506 --
507 -- UploadView (PUBLIC))- Overloaded
508 --   Public procedure for afdict.lct to call when uploading view
509 --   using afdict.lct. It calls InsertView when needed.
510 --
511 procedure UploadView (
512   x_application_short_name       in varchar2,
513   x_view_name                    in varchar2,
514   x_text                         in varchar2,
515   x_description                  in varchar2,
516   x_user_id                      in varchar2,
517   x_custom_mode 			   in varchar2,
518   x_last_update_date 		   in varchar2,
519   x_phase_mode			 in varchar2);
520 
521 --
522 -- UploadViewColumn (PUBLIC))- Overloaded
523 --   Public procedure for afdict.lct to call when uploading view column
524 --   using afdict.lct.
525 --
526 procedure UploadViewColumn (
527   x_application_short_name       in varchar2,
528   x_view_name                    in varchar2,
529   x_view_column_name             in varchar2,
530   x_view_column_sequence         in varchar2,
531   x_user_id                      in varchar2,
532   x_custom_mode 			   in varchar2,
533   x_last_update_date 		   in varchar2);
534 
535   --
536 -- OWNER_ID
537 --   Return the user_id of the OWNER attribute
538 -- IN
539 --   p_name - OWNER attribute value from FNDLOAD data file
540 -- RETURNS
541 --   user_id of owner to use in who columns
542 --
543 function OWNER_ID(
544   p_name in varchar2)
545 return number;
546 
547 
548 --
549 -- UPLOAD_TEST
550 --   Test whether or not to over-write database row when uploading
551 --   data from FNDLOAD data file, based on owner attributes of both
552 --   database row and row in file being uploaded.
553 -- IN
554 --   p_file_id - OWNER_ID(<OWNER attribute from data file>)
555 --   p_file_lud - LAST_UPDATE_DATE attribute from data file
556 --   p_db_id - LAST_UPDATED_BY of db row
557 --   p_db_lud - LAST_UPDATE_DATE of db row
558 --   p_custom_mode - CUSTOM_MODE FNDLOAD parameter value
559 -- RETURNS
560 --   TRUE if safe to over-write.
561 --
562 function UPLOAD_TEST(
563   p_file_id     in number,
564   p_file_lud    in date,
565   p_db_id       in number,
566   p_db_lud      in date,
567   p_custom_mode in varchar2)
568 return boolean;
569 
570 procedure INSERT_ROW (
571   X_ROWID in out  NOCOPY VARCHAR2,
572   P_APPLICATION_ID in NUMBER,
573   P_OBJECT_NAME in VARCHAR2,
574   P_OBJECT_TYPE in VARCHAR2,
575   P_TABLESPACE_TYPE in VARCHAR2,
576   P_CUSTOM_TABLESPACE_TYPE in VARCHAR2,
577   P_OBJECT_SOURCE   in  VARCHAR2,
578   P_ORACLE_USERNAME  in VARCHAR2,
579   P_CUSTOM_FLAG in VARCHAR2,
580   P_CREATION_DATE in DATE,
581   P_CREATED_BY in NUMBER,
582   P_LAST_UPDATE_DATE in DATE,
583   P_LAST_UPDATED_BY in NUMBER,
584   P_LAST_UPDATE_LOGIN in NUMBER);
585 
586 procedure LOCK_ROW (
587   P_APPLICATION_ID in NUMBER,
588   P_OBJECT_NAME in VARCHAR2,
589   P_OBJECT_TYPE in VARCHAR2,
590   P_TABLESPACE_TYPE in VARCHAR2);
591 
592 procedure UPDATE_ROW (
593   P_APPLICATION_ID in NUMBER,
594   P_OBJECT_NAME in VARCHAR2,
595   P_OBJECT_TYPE in VARCHAR2,
596   P_TABLESPACE_TYPE in VARCHAR2,
597   P_CUSTOM_TABLESPACE_TYPE in VARCHAR2,
598   P_OBJECT_SOURCE   in  VARCHAR2,
599   P_ORACLE_USERNAME  in VARCHAR2,
600   P_CUSTOM_FLAG in VARCHAR2,
601   P_LAST_UPDATE_DATE in DATE,
602   P_LAST_UPDATED_BY in NUMBER,
603   P_LAST_UPDATE_LOGIN in NUMBER);
604 
605 procedure LOAD_ROW (
606    P_APPLICATION_ID  in NUMBER,
607    P_OBJECT_NAME     in VARCHAR2,
608    P_OBJECT_TYPE      in VARCHAR2,
609    P_TABLESPACE_TYPE  in VARCHAR2,
613    P_CUSTOM_FLAG in VARCHAR2,
610    P_CUSTOM_TABLESPACE_TYPE  in VARCHAR2,
611    P_OBJECT_SOURCE    in VARCHAR2,
612    P_ORACLE_USERNAME in VARCHAR2,
614    P_LAST_UPDATED_BY  in VARCHAR2,
615    P_CUSTOM_MODE      in VARCHAR2,
616    P_LAST_UPDATE_DATE in VARCHAR2);
617 
618 end Fnd_XdfDictionary_Pkg;