DBA Data[Home] [Help]

PACKAGE: APPS.BNE_INTEGRATOR_UTILS

Source


1 PACKAGE BNE_INTEGRATOR_UTILS AUTHID CURRENT_USER AS
2 /* $Header: bneintgs.pls 120.8.12010000.2 2009/06/22 12:05:42 dhvenkat ship $ */
3 --------------------------------------------------------------------------------
4 --  PACKAGE:      BNE_INTEGRATOR_UTILS                                        --
5 --                                                                            --
6 --  DESCRIPTION:                                                              --
7 --                                                                            --
8 --  MODIFICATION HISTORY                                                      --
9 --  Date         Username  Description                                        --
10 --  22-APR-2002  JRICHARD  Created.                                           --
11 --  18-JUN-2002  KPEET     Updated to include CREATE_INTERFACE_FOR_API and    --
12 --                         renamed CREATE_INTERFACE to                        --
13 --                         CREATE_INTERFACE_FOR_TABLE and renamed             --
14 --                         INSERT_INTERFACE_COLUMN to UPSERT_INTERFACE_COLUMN.--
15 --  10-JUL-2002  KPEET     Added procedure CREATE_INTEGRATOR_NO_CONTENT to    --
16 --                         create an Integrator without a Content of "None".  --
17 --  01-OCT-2002  KPEET     Updated to reflect 8.3 schema changes.             --
18 --  29-OCT-2002  KPEET     Added IS_VALID_APPL_ID due to 8.3 schema changes.  --
19 --  07-NOV-2002  KPEET     Renamed CREATE_PARAMETER_LIST to be                --
20 --                         CREATE_API_PARAMETER_LIST.                         --
21 --  16-FEB-2005  DAGROVES  Bug 4187173 Added new columns to UPSERT_INTERFACE_COLUMN
22 --  26-JUL-2006  DAGROVES  Bug 4447161 Added P_USE_FND_METADATA flag to CREATE_INTERFACE_FOR_TABLE(),
23 --                         Added CREATE%LOV() methods.  Added DELETE%() methods.
24 --  14-AUG-2006  DAGROVES  Bug 5464481 - CREATE SCRIPTS FOR FLEXFIELD COLUMNS --
25 --  17-APR-2007  JRICHARD  Bug 5728544 - UNABLE TO UPLOAD DATA FOR 'WEB ADI - --
26 --                                            UPDATE INTERFACE COLUMN PROMPTS --
27 --------------------------------------------------------------------------------
28 
29 
30 FUNCTION IS_VALID_APPL_ID
31                   (P_APPLICATION_ID IN NUMBER) RETURN BOOLEAN;
32 
33 FUNCTION IS_VALID_OBJECT_CODE
34                   (P_OBJECT_CODE IN VARCHAR2) RETURN BOOLEAN;
35 
36 FUNCTION IS_VALID_OBJECT_CODE
37                   (P_OBJECT_CODE IN VARCHAR2,
38                    P_MAX_CODE_LENGTH IN NUMBER) RETURN BOOLEAN;
39 
40 
41 PROCEDURE LINK_LIST_TO_INTERFACE
42                   (P_PARAM_LIST_APP_ID IN NUMBER,
43                    P_PARAM_LIST_CODE   IN VARCHAR2,
44                    P_INTERFACE_APP_ID  IN NUMBER,
45                    P_INTERFACE_CODE    IN VARCHAR2);
46 
47 
48 PROCEDURE CREATE_API_PARAMETER_LIST
49                   (P_PARAM_LIST_NAME    IN VARCHAR2,
50                    P_API_PACKAGE_NAME   IN VARCHAR2,
51                    P_API_PROCEDURE_NAME IN VARCHAR2,
52                    P_API_TYPE           IN VARCHAR2,
53                    P_API_RETURN_TYPE    IN VARCHAR2 DEFAULT NULL,
54                    P_LANGUAGE           IN VARCHAR2,
55                    P_SOURCE_LANG        IN VARCHAR2,
56                    P_USER_ID            IN NUMBER,
57                    P_OVERLOAD           IN NUMBER,
58                    P_APPLICATION_ID     IN NUMBER,
59                    P_OBJECT_CODE        IN VARCHAR2,
60                    P_PARAM_LIST_CODE    OUT NOCOPY VARCHAR2);
61 
62 
63 PROCEDURE CREATE_INTEGRATOR
64                   (P_APPLICATION_ID       IN NUMBER,
65                    P_OBJECT_CODE          IN VARCHAR2,
66                    P_INTEGRATOR_USER_NAME IN VARCHAR2,
67                    P_LANGUAGE             IN VARCHAR2,
68                    P_SOURCE_LANGUAGE      IN VARCHAR2,
69                    P_USER_ID              IN NUMBER,
70                    P_INTEGRATOR_CODE      OUT NOCOPY VARCHAR2);
71 
72 
73 PROCEDURE CREATE_INTEGRATOR_NO_CONTENT
74                   (P_APPLICATION_ID       IN NUMBER,
75                    P_OBJECT_CODE          IN VARCHAR2,
76                    P_INTEGRATOR_USER_NAME IN VARCHAR2,
77                    P_USER_ID              IN NUMBER,
78                    P_LANGUAGE             IN VARCHAR2,
79                    P_SOURCE_LANGUAGE      IN VARCHAR2,
80                    P_INTEGRATOR_CODE      OUT NOCOPY VARCHAR2);
81 
82 
83 PROCEDURE CREATE_INTERFACE_FOR_TABLE
84                   (P_APPLICATION_ID        IN NUMBER,
85                    P_OBJECT_CODE           IN VARCHAR2,
86                    P_INTEGRATOR_CODE       IN VARCHAR2,
87                    P_INTERFACE_TABLE_NAME  IN VARCHAR2,
88                    P_INTERFACE_USER_NAME   IN VARCHAR2,
89                    P_LANGUAGE              IN VARCHAR2,
90                    P_SOURCE_LANG           IN VARCHAR2,
91                    P_USER_ID               IN NUMBER,
92                    P_INTERFACE_CODE        OUT NOCOPY VARCHAR2,
93                    P_USE_FND_METADATA      IN BOOLEAN  DEFAULT TRUE,
94                    P_INTERFACE_TABLE_OWNER IN VARCHAR2 DEFAULT 'APPS');
95 
96 
97 PROCEDURE CREATE_INTERFACE_FOR_API
98                   (P_APPLICATION_ID      IN NUMBER,
99                    P_OBJECT_CODE         IN VARCHAR2,
100                    P_INTEGRATOR_CODE     IN VARCHAR2,
101                    P_API_PACKAGE_NAME    IN VARCHAR2,
102                    P_API_PROCEDURE_NAME  IN VARCHAR2,
103                    P_INTERFACE_USER_NAME IN VARCHAR2,
104                    P_PARAM_LIST_NAME     IN VARCHAR2,
105                    P_API_TYPE            IN VARCHAR2,
106                    P_API_RETURN_TYPE     IN VARCHAR2 DEFAULT NULL,
107                    P_UPLOAD_TYPE         IN NUMBER,
108                    P_LANGUAGE            IN VARCHAR2,
109                    P_SOURCE_LANG         IN VARCHAR2,
110                    P_USER_ID             IN NUMBER,
111                    P_PARAM_LIST_CODE     OUT NOCOPY VARCHAR2,
112                    P_INTERFACE_CODE      OUT NOCOPY VARCHAR2);
113 
114 
115 PROCEDURE CREATE_INTERFACE_FOR_CONTENT
116                   (P_APPLICATION_ID  IN NUMBER,
117                    P_OBJECT_CODE     IN VARCHAR2,
118                    P_CONTENT_CODE    IN VARCHAR2,
119                    P_INTEGRATOR_CODE IN VARCHAR2,
120                    P_LANGUAGE        IN VARCHAR2,
121                    P_SOURCE_LANG     IN VARCHAR2,
122                    P_USER_ID         IN NUMBER,
123                    P_INTERFACE_CODE  OUT NOCOPY VARCHAR2);
124 
125 
126 PROCEDURE UPSERT_INTERFACE_COLUMN
127                   (P_APPLICATION_ID IN NUMBER,
128                    P_INTERFACE_CODE IN VARCHAR2,
129                    P_SEQUENCE_NUM IN NUMBER,
130                    P_INTERFACE_COL_TYPE IN NUMBER,
131                    P_INTERFACE_COL_NAME IN VARCHAR2,
132                    P_ENABLED_FLAG IN VARCHAR2,
133                    P_REQUIRED_FLAG IN VARCHAR2,
134                    P_DISPLAY_FLAG IN VARCHAR2,
135                    P_FIELD_SIZE IN NUMBER DEFAULT NULL,
136                    P_DEFAULT_TYPE IN VARCHAR2 DEFAULT NULL,
137                    P_DEFAULT_VALUE IN VARCHAR2 DEFAULT NULL,
138                    P_SEGMENT_NUMBER IN NUMBER DEFAULT NULL,
139                    P_GROUP_NAME IN VARCHAR2 DEFAULT NULL,
140                    P_OA_FLEX_CODE IN VARCHAR2 DEFAULT NULL,
141                    P_OA_CONCAT_FLEX IN VARCHAR2 DEFAULT NULL,
142                    P_READ_ONLY_FLAG IN VARCHAR2,
143                    P_VAL_TYPE IN VARCHAR2 DEFAULT NULL,
144                    P_VAL_ID_COL IN VARCHAR2 DEFAULT NULL,
145                    P_VAL_MEAN_COL IN VARCHAR2 DEFAULT NULL,
146                    P_VAL_DESC_COL IN VARCHAR2 DEFAULT NULL,
147                    P_VAL_OBJ_NAME IN VARCHAR2 DEFAULT NULL,
148                    P_VAL_ADDL_W_C IN VARCHAR2 DEFAULT NULL,
149                    P_DATA_TYPE IN NUMBER DEFAULT NULL,
150                    P_NOT_NULL_FLAG IN VARCHAR2,
151                    P_VAL_COMPONENT_APP_ID IN NUMBER DEFAULT NULL,
152                    P_VAL_COMPONENT_CODE IN VARCHAR2 DEFAULT NULL,
153                    P_SUMMARY_FLAG IN VARCHAR2,
154                    P_MAPPING_ENABLED_FLAG IN VARCHAR2,
155                    P_PROMPT_LEFT IN VARCHAR2 DEFAULT NULL,
156                    P_PROMPT_ABOVE IN VARCHAR2 DEFAULT NULL,
157                    P_USER_HINT IN VARCHAR2 DEFAULT NULL,
158                    P_USER_HELP_TEXT IN VARCHAR2 DEFAULT NULL,
159                    P_LANGUAGE IN VARCHAR2,
160                    P_SOURCE_LANG IN VARCHAR2,
161                    P_OA_FLEX_NUM IN VARCHAR2 DEFAULT NULL,
162                    P_OA_FLEX_APPLICATION_ID IN NUMBER DEFAULT NULL,
163                    P_DISPLAY_ORDER IN NUMBER DEFAULT NULL,
164                    P_UPLOAD_PARAM_LIST_ITEM_NUM IN NUMBER DEFAULT NULL,
165                    P_EXPANDED_SQL_QUERY IN VARCHAR2 DEFAULT NULL,
166                    P_LOV_TYPE IN VARCHAR2 DEFAULT NULL,
167                    P_OFFLINE_LOV_ENABLED_FLAG IN VARCHAR2 DEFAULT NULL,
168                    P_VARIABLE_DATA_TYPE_CLASS IN VARCHAR2 DEFAULT NULL,
169                    P_USER_ID IN NUMBER);
170 
171 
172 PROCEDURE CREATE_INTERFACE_ALIAS_COLS
173                   (P_APPLICATION_ID IN NUMBER,
174                    P_INTERFACE_CODE IN VARCHAR2,
175                    P_LANGUAGE       IN VARCHAR2,
176                    P_SOURCE_LANG    IN VARCHAR2,
177                    P_USER_ID        IN NUMBER,
178                    P_VIEW_NAME      IN VARCHAR2,
179                    P_CONTENT_CODE   IN VARCHAR2);
180 
181 
182 PROCEDURE CREATE_API_INTERFACE_AND_MAP
183                   (P_APPLICATION_ID      IN NUMBER,
184                    P_OBJECT_CODE         IN VARCHAR2,
185                    P_INTEGRATOR_CODE     IN VARCHAR2,
186                    P_API_PACKAGE_NAME    IN VARCHAR2,
187                    P_API_PROCEDURE_NAME  IN VARCHAR2,
188                    P_INTERFACE_USER_NAME IN VARCHAR2,
189                    P_CONTENT_CODE        IN VARCHAR2,
190                    P_VIEW_NAME           IN VARCHAR2,
191                    P_PARAM_LIST_NAME     IN VARCHAR2,
192                    P_API_TYPE            IN VARCHAR2,
193                    P_API_RETURN_TYPE     IN VARCHAR2,
194                    P_UPLOAD_TYPE         IN NUMBER,
195                    P_LANGUAGE            IN VARCHAR2,
196                    P_SOURCE_LANG         IN VARCHAR2,
197                    P_USER_ID             IN NUMBER,
198                    P_PARAM_LIST_CODE     OUT NOCOPY VARCHAR2,
199                    P_INTERFACE_CODE      OUT NOCOPY VARCHAR2,
200                    P_MAPPING_CODE        OUT NOCOPY VARCHAR2);
201 
202 PROCEDURE CREATE_DEFAULT_LAYOUT
203                   (P_APPLICATION_ID       IN NUMBER,
204                    P_OBJECT_CODE          IN VARCHAR2,
205                    P_INTEGRATOR_CODE      IN VARCHAR2,
206                    P_INTERFACE_CODE       IN VARCHAR2,
207                    P_USER_ID              IN NUMBER,
208                    P_FORCE                IN BOOLEAN,
209                    P_ALL_COLUMNS          IN BOOLEAN,
210                    P_LAYOUT_CODE          IN OUT NOCOPY VARCHAR2);
211 
212 --------------------------------------------------------------------------------
213 --  PROCEDURE:        CREATE_TABLE_LOV                                        --
214 --                                                                            --
215 --  DESCRIPTION:      Create a Table LOV for a specific interface Column.     --
216 --  EXAMPLES:                                                                 --
217 --    BNE_INTEGRATOR_UTILS.CREATE_TABLE_LOV                                   --
218 --      (P_APPLICATION_ID       => 231,                                       --
219 --       P_INTERFACE_CODE       => 'MY_INTERFACE',                            --
220 --       P_INTERFACE_COL_NAME   => 'COL_NAME',                                --
221 --       P_ID_COL               => 'LOOKUP_CODE', -- LOOKUP CODE UPLOADED     --
222 --       P_MEAN_COL             => 'MEANING',     -- Shown in sheet           --
223 --       P_DESC_COL             => NULL,                                      --
224 --       P_TABLE                => 'FND_LOOKUPS',                             --
225 --       P_ADDL_W_C             => 'lookup_type = ''YES_NO''',                --
226 --       P_WINDOW_CAPTION       => 'Yes/No with Meaning, selecting Meaning, Meaning sortable',--
227 --       P_WINDOW_WIDTH         => 400,                                       --
228 --       P_WINDOW_HEIGHT        => 300,                                       --
229 --       P_TABLE_BLOCK_SIZE     => 10,                                        --
230 --       P_TABLE_SORT_ORDER     => 'ascending',                               --
231 --       P_USER_ID              => 2); -- SEED USER                           --
232 --                                                                            --
233 --    BNE_INTEGRATOR_UTILS.CREATE_TABLE_LOV                                   --
234 --      (P_APPLICATION_ID       => 231,                                       --
235 --       P_INTERFACE_CODE       => 'MY_INTERFACE',                            --
236 --       P_INTERFACE_COL_NAME   => 'COL_NAME',                                --
237 --       P_ID_COL               => 'LOOKUP_CODE', -- LOOKUP CODE UPLOADED     --
238 --       P_MEAN_COL             => 'MEANING',     -- Shown in sheet           --
239 --       P_DESC_COL             => 'DESCRIPTION',                             --
240 --       P_TABLE                => 'FND_LOOKUPS',                             --
241 --       P_ADDL_W_C             => 'lookup_type = ''FND_CLIENT_CHARACTER_SETS''',
242 --       P_WINDOW_CAPTION       => 'Yes/No/All with Meaning and Description, selecting Meaning, Meaning sortable',--
243 --       P_WINDOW_WIDTH         => 400,                                       --
244 --       P_WINDOW_HEIGHT        => 300,                                       --
245 --       P_TABLE_BLOCK_SIZE     => 10,                                        --
246 --       P_TABLE_SORT_ORDER     => 'yes,no', -- sortable by meaning, not description--
247 --       P_USER_ID              => 2); -- SEED USER                           --
248 --                                                                            --
249 --  MODIFICATION HISTORY                                                      --
250 --  Date         Username  Description                                        --
251 --  11-JUL-2006  dagroves  Created.                                           --
252 --------------------------------------------------------------------------------
253 PROCEDURE CREATE_TABLE_LOV
254                   (P_APPLICATION_ID       IN NUMBER,
255                    P_INTERFACE_CODE       IN VARCHAR2,
256                    P_INTERFACE_COL_NAME   IN VARCHAR2,
257                    P_ID_COL               IN VARCHAR2,
258                    P_MEAN_COL             IN VARCHAR2,
259                    P_DESC_COL             IN VARCHAR2,
260                    P_TABLE                IN VARCHAR2,
261                    P_ADDL_W_C             IN VARCHAR2,
262                    P_WINDOW_CAPTION       IN VARCHAR2,
263                    P_WINDOW_WIDTH         IN NUMBER,
264                    P_WINDOW_HEIGHT        IN NUMBER,
265                    P_TABLE_BLOCK_SIZE     IN NUMBER,
266                    P_TABLE_SORT_ORDER     IN VARCHAR2,
267                    P_USER_ID              IN NUMBER,
268                    P_TABLE_COLUMNS        IN VARCHAR2 DEFAULT NULL,
269                    P_TABLE_SELECT_COLUMNS IN VARCHAR2 DEFAULT NULL,
270                    P_TABLE_COLUMN_ALIAS   IN VARCHAR2 DEFAULT NULL,
271                    P_TABLE_HEADERS        IN VARCHAR2 DEFAULT NULL,
272                    P_POPLIST_FLAG         IN VARCHAR2 DEFAULT 'N'
273 );
274 
275 --------------------------------------------------------------------------------
276 --  PROCEDURE:        CREATE_JAVA_LOV                                         --
277 --                                                                            --
278 --  DESCRIPTION:      Create a Table LOV for a specific interface Column.     --
279 --  EXAMPLES:                                                                 --
280 --    BNE_INTEGRATOR_UTILS.CREATE_JAVA_LOV                                    --
281 --      (P_APPLICATION_ID       => P_APPLICATION_ID,                          --
282 --       P_INTERFACE_CODE       => P_INTERFACE_CODE,                          --
283 --       P_INTERFACE_COL_NAME   => 'COL_NAME',                                --
284 --       P_JAVA_CLASS           => 'oracle.apps.bne.lovtest.component.BneLOVTestSimpleJavaLOV01',--
285 --       P_WINDOW_CAPTION       => 'Java LOV selecting Code, Code sortable',  --
286 --       P_WINDOW_WIDTH         => 400,                                       --
287 --       P_WINDOW_HEIGHT        => 300,                                       --
288 --       P_TABLE_BLOCK_SIZE     => 10,                                        --
289 --       P_TABLE_COLUMNS        => 'LOOKUP_CODE',                             --
290 --       P_TABLE_SELECT_COLUMNS => NULL,                                      --
294 --       P_USER_ID              => P_USER_ID);                                --
291 --       P_TABLE_COLUMN_ALIAS   => NULL,                                      --
292 --       P_TABLE_HEADERS        => 'Lookup Code',                             --
293 --       P_TABLE_SORT_ORDER     => 'yes',                                     --
295 --                                                                            --
296 --    BNE_INTEGRATOR_UTILS.CREATE_JAVA_LOV                                    --
297 --      (P_APPLICATION_ID       => P_APPLICATION_ID,                          --
298 --       P_INTERFACE_CODE       => P_INTERFACE_CODE,                          --
299 --       P_INTERFACE_COL_NAME   => 'COL_NAME',                                --
300 --       P_JAVA_CLASS           => 'oracle.apps.bne.lovtest.component.BneLOVTestSimpleJavaLOV01',--
301 --       P_WINDOW_CAPTION       => 'Java LOV, Code, Meaning and Description selecting Code, Meaning and Description. Meaning and Description sortable, tablesize of 50',
302 --       P_WINDOW_WIDTH         => 500,                                       --
303 --       P_WINDOW_HEIGHT        => 500,                                       --
304 --       P_TABLE_BLOCK_SIZE     => 50,                                        --
305 --       P_TABLE_COLUMNS        => 'LOOKUP_CODE,MEANING,DESCRIPTION',         --
306 --       P_TABLE_SELECT_COLUMNS => 'STRING_COL06,STRING_COL08,STRING_COL07',  --
307 --       P_TABLE_COLUMN_ALIAS   => 'STRING_COL06,STRING_COL08,STRING_COL07',  --
308 --       P_TABLE_HEADERS        => 'Lookup Code, Meaning, Description',       --
309 --       P_TABLE_SORT_ORDER     => 'no, yes, yes',                            --
310 --       P_USER_ID              => P_USER_ID);                                --
311 --                                                                            --
312 --                                                                            --
313 --  MODIFICATION HISTORY                                                      --
314 --  Date         Username  Description                                        --
315 --  11-JUL-2006  dagroves  Created.                                           --
316 --------------------------------------------------------------------------------
317 PROCEDURE CREATE_JAVA_LOV
318                   (P_APPLICATION_ID       IN NUMBER,
319                    P_INTERFACE_CODE       IN VARCHAR2,
320                    P_INTERFACE_COL_NAME   IN VARCHAR2,
321                    P_JAVA_CLASS           IN VARCHAR2,
322                    P_WINDOW_CAPTION       IN VARCHAR2,
323                    P_WINDOW_WIDTH         IN NUMBER,
324                    P_WINDOW_HEIGHT        IN NUMBER,
325                    P_TABLE_BLOCK_SIZE     IN NUMBER,
326                    P_TABLE_COLUMNS        IN VARCHAR2,
327                    P_TABLE_SELECT_COLUMNS IN VARCHAR2,
328                    P_TABLE_COLUMN_ALIAS   IN VARCHAR2,
329                    P_TABLE_HEADERS        IN VARCHAR2,
330                    P_TABLE_SORT_ORDER     IN VARCHAR2,
331                    P_USER_ID              IN NUMBER);
332 
333 --------------------------------------------------------------------------------
334 --  PROCEDURE:        CREATE_CALENDAR_LOV                                     --
335 --                                                                            --
336 --  DESCRIPTION:      Create a Calendar LOV for a specific interface Column.  --
337 --  EXAMPLE:                                                                  --
338 --        BNE_INTEGRATOR_UTILS.CREATE_CALENDAR_LOV                            --
339 --          (P_APPLICATION_ID       => 231,                                   --
340 --           P_INTERFACE_CODE       => 'MY_INTERFACE',                        --
341 --           P_INTERFACE_COL_NAME   => 'COL_NAME',                            --
342 --           P_WINDOW_CAPTION       => 'Date Col LOV',                        --
343 --           P_WINDOW_WIDTH         => 230,                                   --
344 --           P_WINDOW_HEIGHT        => 220,                                   --
345 --           P_TABLE_COLUMNS        => NULL,                                  --
346 --           P_USER_ID              => 2);             -- SEED USER           --
347 --                                                                            --
348 --                                                                            --
349 --  MODIFICATION HISTORY                                                      --
350 --  Date         Username  Description                                        --
351 --  11-JUL-2006  dagroves  Created.                                           --
352 --------------------------------------------------------------------------------
353 PROCEDURE CREATE_CALENDAR_LOV
354                   (P_APPLICATION_ID       IN NUMBER,
355                    P_INTERFACE_CODE       IN VARCHAR2,
356                    P_INTERFACE_COL_NAME   IN VARCHAR2,
357                    P_WINDOW_CAPTION       IN VARCHAR2,
358                    P_WINDOW_WIDTH         IN NUMBER,
359                    P_WINDOW_HEIGHT        IN NUMBER,
360                    P_TABLE_COLUMNS        IN VARCHAR2,
361                    P_USER_ID              IN NUMBER);
362 
363 
364 --------------------------------------------------------------------------------
365 --  PROCEDURE:        CREATE_KFF                                              --
366 --                                                                            --
367 --  DESCRIPTION:      Create a Key Flexfield and generic LOV on an interface. --
368 --                    It is assumed that columns will already exist in the    --
369 --                    interface in the form P_FLEX_SEG_COL_NAME_PREFIX%, for  --
370 --                    example SEGMENT1,2,3 for P_FLEX_SEG_COL_NAME_PREFIX     --
374 --                    The following parameters are only used in the LOV, for  --
371 --                    of SEGMENT.  An alias column will be created named      --
372 --                    P_GROUP_NAME for this KFF, and all segments and this    --
373 --                    alias column will be placed in a group P_GROUP_NAME.    --
375 --                    upload validation, you need to develop a custom         --
376 --                    validator to perform validation to your business rules. --
377 --                    (Refer to BneKFFValidator.java or                       --
378 --                              BneAccountingFlexValidator.java               --
379 --                     P_VRULE                                                --
380 --                     P_EFFECTIVE_DATE_COL                                   --
381 --                    Reference: Web ADI Developers guide section 4.5 -       --
382 --                                  "Key Flexfield Validation/LOV Retrieval"  --
383 --  EXAMPLE:                                                                  --
384 --        BNE_INTEGRATOR_UTILS.CREATE_KFF                                     --
385 --                    (P_APPLICATION_ID            => P_APPLICATION_ID,       --
386 --                     P_INTERFACE_CODE            => P_INTERFACE_CODE,       --
387 --                     P_FLEX_SEG_COL_NAME_PREFIX  => 'SEGMENT',              --
388 --                     P_GROUP_NAME                => 'ACCOUNT',              --
389 --                     P_REQUIRED_FLAG             => 'N',                    --
390 --                     P_FLEX_APPLICATION_ID       => 101,                    --
391 --                     P_FLEX_CODE                 => 'GL#',                  --
392 --                     P_FLEX_NUM                  => 101,                    --
393 --                     P_VRULE                     => 'my vrule',             --
394 --                     P_EFFECTIVE_DATE_COL        => 'DATE_COL01',           --
395 --                     P_PROMPT_ABOVE              => 'Accounting Flexfield', --
396 --                     P_PROMPT_LEFT               => 'Accounting Flexfield', --
397 --                     P_USER_HINT                 => 'Enter Account',        --
398 --                     P_USER_ID                   => P_USER_ID);             --
399 --                                                                            --
400 --  MODIFICATION HISTORY                                                      --
401 --  Date         Username  Description                                        --
402 --  11-AUG-2006  dagroves  Created.                                           --
403 --------------------------------------------------------------------------------
404 PROCEDURE CREATE_KFF
405                   (P_APPLICATION_ID            IN NUMBER,
406                    P_INTERFACE_CODE            IN VARCHAR2,
407                    P_FLEX_SEG_COL_NAME_PREFIX  IN VARCHAR2,
408                    P_GROUP_NAME                IN VARCHAR2,
409                    P_REQUIRED_FLAG             IN VARCHAR2,
410                    P_FLEX_APPLICATION_ID       IN NUMBER,
411                    P_FLEX_CODE                 IN VARCHAR2,
412                    P_FLEX_NUM                  IN VARCHAR2,
413                    P_VRULE                     IN VARCHAR2,
414                    P_EFFECTIVE_DATE_COL        IN VARCHAR2,
415                    P_PROMPT_ABOVE              IN VARCHAR2,
416                    P_PROMPT_LEFT               IN VARCHAR2,
417                    P_USER_HINT                 IN VARCHAR2,
418                    P_USER_ID                   IN NUMBER);
419 
420 --------------------------------------------------------------------------------
421 --  PROCEDURE:        CREATE_DFF                                              --
422 --                                                                            --
423 --  DESCRIPTION:      Create a Descriptive Flexfield and generic LOV on an    --
424 --                    interface.  It is assumed that columns will already     --
425 --                    exist in the interface in the form                      --
426 --                    P_FLEX_SEG_COL_NAME_PREFIX%, for example ATTRIBUTE1,2,3 --
427 --                    for P_FLEX_SEG_COL_NAME_PREFIX of ATTRIBUTE.            --
428 --                    An alias column will be created named P_GROUP_NAME for  --
429 --                    DFF, and all segments and this alias column will be     --
430 --                    placed in a group P_GROUP_NAME.                         --
431 --                    If a P_CONTEXT_COL_NAME is set, it must correspond to an--
432 --                    existing column in the interface and it will be used as --
433 --                    an external reference column.  It must correspond to the--
434 --                    Structure column as defined in the DFF Registered in    --
435 --                    Oracle Applications.                                    --
436 --                    The following parameters are only used in the LOV, for  --
437 --                    upload validation, you need to develop a custom         --
438 --                    validator to perform validation to your business rules. --
439 --                    (Refer to BneDFFValidator.java)                         --
440 --                     P_VRULE                                                --
441 --                     P_EFFECTIVE_DATE_COL                                   --
442 --                    Reference: Web ADI Developers guide section 4.7 -       --
443 --                          "Descriptive Flexfield Validation/LOV Retrieval"  --
444 --  EXAMPLE:                                                                  --
445 --        BNE_INTEGRATOR_UTILS.CREATE_DFF                                     --
446 --                    (P_APPLICATION_ID            => P_APPLICATION_ID,       --
450 --                     P_GROUP_NAME                => 'JOURNAL_LINES',        --
447 --                     P_INTERFACE_CODE            => P_INTERFACE_CODE,       --
448 --                     P_FLEX_SEG_COL_NAME_PREFIX  => 'ATTRIBUTE',            --
449 --                     P_CONTEXT_COL_NAME          => 'CONTEXT',              --
451 --                     P_REQUIRED_FLAG             => 'N',                    --
452 --                     P_FLEX_APPLICATION_ID       => 101,                    --
453 --                     P_FLEX_CODE                 => 'GL_JE_LINES',          --
454 --                     P_VRULE                     => NULL,                   --
455 --                     P_EFFECTIVE_DATE_COL        => 'DATE_COL01',           --
456 --                     P_PROMPT_ABOVE              => 'Journal Lines',        --
457 --                     P_PROMPT_LEFT               => 'Journal Lines',        --
458 --                     P_USER_HINT                 => 'Enter Line',           --
459 --                     P_USER_ID                   => P_USER_ID);             --
460 --                                                                            --
461 --  MODIFICATION HISTORY                                                      --
462 --  Date         Username  Description                                        --
463 --  11-AUG-2006  dagroves  Created.                                           --
464 --------------------------------------------------------------------------------
465 PROCEDURE CREATE_DFF
466                   (P_APPLICATION_ID            IN NUMBER,
467                    P_INTERFACE_CODE            IN VARCHAR2,
468                    P_FLEX_SEG_COL_NAME_PREFIX  IN VARCHAR2,
469                    P_CONTEXT_COL_NAME          IN VARCHAR2,
470                    P_GROUP_NAME                IN VARCHAR2,
471                    P_REQUIRED_FLAG             IN VARCHAR2,
472                    P_FLEX_APPLICATION_ID       IN NUMBER,
473                    P_FLEX_CODE                 IN VARCHAR2,
474                    P_VRULE                     IN VARCHAR2,
475                    P_EFFECTIVE_DATE_COL        IN VARCHAR2,
476                    P_PROMPT_ABOVE              IN VARCHAR2,
477                    P_PROMPT_LEFT               IN VARCHAR2,
478                    P_USER_HINT                 IN VARCHAR2,
479                    P_USER_ID                   IN NUMBER);
480 
481 --------------------------------------------------------------------------------
482 --  PROCEDURE:        CREATE_CCID_KFF                                         --
483 --                                                                            --
484 --  DESCRIPTION:      Create a Key Flexfield and generic LOV on an interface. --
485 --                    It is assumed that a code combination column will       --
486 --                    already exist in the interface and be named             --
487 --                    P_INTERFACE_COL_NAME.                                   --
488 --                    Alias columns will be created in the interface named    --
489 --                    P_INTERFACE_COL_NAME||'_SEGMENT1' to                    --
490 --                    P_INTERFACE_COL_NAME||'_SEGMENT'||P_NUM_FLEX_SEGS.      --
491 --                    The following parameters are only used in the LOV, for  --
492 --                    upload validation, you need to develop a custom         --
493 --                    validator to perform validation to your business rules. --
494 --                    (Refer to BneKFFValidator.java or                       --
495 --                              BneAccountingFlexValidator.java               --
496 --                     P_VRULE                                                --
497 --                     P_EFFECTIVE_DATE_COL                                   --
498 --                    Reference: Web ADI Developers guide section 4.5 -       --
499 --                                  "Key Flexfield Validation/LOV Retrieval"  --
500 --                                                                            --
501 --  EXAMPLE:                                                                  --
502 --        BNE_INTEGRATOR_UTILS.CREATE_CCID_KFF                                --
503 --                    (P_APPLICATION_ID            => P_APPLICATION_ID,       --
504 --                     P_INTERFACE_CODE            => P_INTERFACE_CODE,       --
505 --                     P_INTERFACE_COL_NAME        => 'KEYFLEX1_CCID',        --
506 --                     P_NUM_FLEX_SEGS             => 10,                     --
507 --                     P_GROUP_NAME                => 'CCID_ACCOUNT1',        --
508 --                     P_FLEX_APPLICATION_ID       => 101,                    --
509 --                     P_FLEX_CODE                 => 'GL#',                  --
510 --                     P_FLEX_NUM                  => '50214',                --
511 --                     P_VRULE                     => NULL,                   --
512 --                     P_EFFECTIVE_DATE_COL        => 'DATE_COL01',           --
513 --                     P_PROMPT_ABOVE              => 'ADB Accounting Flexfield',--
514 --                     P_PROMPT_LEFT               => 'ADB Accounting Flexfield',--
515 --                     P_USER_HINT                 => 'Enter Account',        --
516 --                     P_USER_ID                   => P_USER_ID);             --
517 --                                                                            --
518 --  MODIFICATION HISTORY                                                      --
519 --  Date         Username  Description                                        --
520 --  11-AUG-2006  dagroves  Created.                                           --
521 --------------------------------------------------------------------------------
522 PROCEDURE CREATE_CCID_KFF
523                   (P_APPLICATION_ID            IN NUMBER,
524                    P_INTERFACE_CODE            IN VARCHAR2,
528                    P_FLEX_APPLICATION_ID       IN NUMBER,
525                    P_INTERFACE_COL_NAME        IN VARCHAR2,
526                    P_NUM_FLEX_SEGS             IN NUMBER,
527                    P_GROUP_NAME                IN VARCHAR2,
529                    P_FLEX_CODE                 IN VARCHAR2,
530                    P_FLEX_NUM                  IN VARCHAR2,
531                    P_VRULE                     IN VARCHAR2,
532                    P_EFFECTIVE_DATE_COL        IN VARCHAR2,
533                    P_PROMPT_ABOVE              IN VARCHAR2,
534                    P_PROMPT_LEFT               IN VARCHAR2,
535                    P_USER_HINT                 IN VARCHAR2,
536                    P_USER_ID                   IN NUMBER);
537 
538 
539 --------------------------------------------------------------------------------
540 --  FUNCTION:    DELETE_ALL_INTEGRATORS                                       --
541 --                                                                            --
542 --  DESCRIPTION: Delete all integrators for the given application id.         --
543 --               This will delete each integrator for the application id      --
544 --                 individually as per DELETE_INTEGRATOR().                   --
545 --               This will include all subsiduary structures:                 --
546 --                - Integrator and attached Parameter Lists                   --
547 --                - Interfaces         as per DELETE_ALL_INTERFACES()         --
548 --                - Contents           as per DELETE_ALL_CONTENTS()           --
549 --                - Mappings           as per DELETE_ALL_MAPPINGS()           --
550 --                - Layouts            as per DELETE_ALL_LAYOUTS()            --
551 --                - Duplicate Profiles as per DELETE_ALL_DUP_PROFILES()       --
552 --               The number of Integrators deleted is returned (0 or greater).--
553 --               No commits are done.                                         --
554 --                                                                            --
555 --  MODIFICATION HISTORY                                                      --
556 --  Date         Username  Description                                        --
557 --  20-JUL-2006  dagroves  Created.                                           --
558 --------------------------------------------------------------------------------
559 FUNCTION DELETE_ALL_INTEGRATORS
560   (P_APPLICATION_ID       IN NUMBER)
561 RETURN NUMBER;
562 
563 
564 --------------------------------------------------------------------------------
565 --  FUNCTION:    DELETE_INTEGRATOR                                            --
566 --                                                                            --
567 --  DESCRIPTION: Delete the given integrator.                                 --
568 --               This will include all subsiduary structures:                 --
569 --                - Integrator and attached Parameter Lists                   --
570 --                - Interfaces         as per DELETE_ALL_INTERFACES()         --
571 --                - Contents           as per DELETE_ALL_CONTENTS()           --
572 --                - Mappings           as per DELETE_ALL_MAPPINGS()           --
573 --                - Layouts            as per DELETE_ALL_LAYOUTS()            --
574 --                - Duplicate Profiles as per DELETE_ALL_DUP_PROFILES()       --
575 --                - Graphs/Graph Columns                                      --
576 --               The number of Integrators deleted is returned (0 or 1).      --
577 --               No commits are done.                                         --
578 --                                                                            --
579 --  MODIFICATION HISTORY                                                      --
580 --  Date         Username  Description                                        --
581 --  20-JUL-2006  dagroves  Created.                                           --
582 --------------------------------------------------------------------------------
583 FUNCTION DELETE_INTEGRATOR
584   (P_APPLICATION_ID       IN NUMBER,
585    P_INTEGRATOR_CODE      IN VARCHAR2)
586 RETURN NUMBER;
587 
588 --------------------------------------------------------------------------------
589 --  FUNCTION:    DELETE_ALL_INTERFACES                                        --
590 --                                                                            --
591 --  DESCRIPTION: Delete all interfaces for the given integrator.              --
592 --               This will delete each interface for the integrator           --
593 --                 individually as per DELETE_INTERFACE().                    --
594 --               The number of interfaces deleted is returned (0 or greater). --
595 --               No commits are done.                                         --
596 --                                                                            --
597 --  MODIFICATION HISTORY                                                      --
598 --  Date         Username  Description                                        --
599 --  20-JUL-2006  dagroves  Created.                                           --
600 --------------------------------------------------------------------------------
601 FUNCTION DELETE_ALL_INTERFACES
602   (P_APPLICATION_ID       IN NUMBER,
603    P_INTEGRATOR_CODE      IN VARCHAR2)
604 RETURN NUMBER;
605 
606 --------------------------------------------------------------------------------
607 --  FUNCTION:    DELETE_INTERFACE                                             --
608 --                                                                            --
609 --  DESCRIPTION: Delete the given interface.                                  --
610 --               This will include all subsiduary structures:                 --
614 --                - Interface Duplicate information                           --
611 --                - Interface                                                 --
612 --                - Interface Columns                                         --
613 --                - Interface Keys/Key columns                                --
615 --                - Queries    as per DELETE_QUERY_IF_UNREF()                 --
616 --                - Components as per DELETE_COMPONENT_IF_UNREF()             --
617 --               It will NOT delete layouts/components/mappings that reference--
618 --               the interface, use DELETE_INTEGRATOR for consistent deletion.--
619 --               of the entire entegrator structure.                          --
620 --               The number of interfaces deleted is returned (0 or 1).       --
621 --               No commits are done.                                         --
622 --                                                                            --
623 --  MODIFICATION HISTORY                                                      --
624 --  Date         Username  Description                                        --
625 --  20-JUL-2006  dagroves  Created.                                           --
626 --------------------------------------------------------------------------------
627 FUNCTION DELETE_INTERFACE
628   (P_APPLICATION_ID       IN NUMBER,
629    P_INTERFACE_CODE       IN VARCHAR2)
630 RETURN NUMBER;
631 
632 --------------------------------------------------------------------------------
633 --  FUNCTION:    DELETE_INTERFACE_COL                                         --
634 --                                                                            --
635 --  DESCRIPTION: Delete the Interface Column.                                 --
636 --               This will include all subsiduary structures:                 --
637 --                - Component           as per DELETE_COMPONENT_IF_UNREF()    --
638 --                - Validation query    as per DELETE_QUERY_IF_UNREF()        --
639 --                - Expanded SQL query  as per DELETE_QUERY_IF_UNREF()        --
640 --               The number of Interface Columns deleted is returned (0 or 1).--
641 --               No commits are done.                                         --
642 --                                                                            --
643 --  MODIFICATION HISTORY                                                      --
644 --  Date         Username  Description                                        --
645 --  20-JUL-2006  dagroves  Created.                                           --
646 --------------------------------------------------------------------------------
647 FUNCTION DELETE_INTERFACE_COL
648   (P_APPLICATION_ID       IN NUMBER,
649    P_INTERFACE_CODE       IN VARCHAR2,
650    P_SEQUENCE_NUM         IN NUMBER)
651 RETURN NUMBER;
652 
653 --------------------------------------------------------------------------------
654 --  FUNCTION:    DELETE_ALL_DUP_PROFILES                                      --
655 --                                                                            --
656 --  DESCRIPTION: Delete all duplicate profiles for the given integrator.      --
657 --               This will delete each duplicate profile for the integrator   --
658 --                 individually as per DELETE_DUP_PROFILE().                  --
659 --               The number of profiles deleted is returned (0 or greater).   --
660 --               No commits are done.                                         --
661 --                                                                            --
662 --  MODIFICATION HISTORY                                                      --
663 --  Date         Username  Description                                        --
664 --  20-JUL-2006  dagroves  Created.                                           --
665 --------------------------------------------------------------------------------
666 FUNCTION DELETE_ALL_DUP_PROFILES
667   (P_APPLICATION_ID       IN NUMBER,
668    P_INTEGRATOR_CODE      IN VARCHAR2)
669 RETURN NUMBER;
670 
671 
672 --------------------------------------------------------------------------------
673 --  FUNCTION:    DELETE_DUP_PROFILE                                           --
674 --                                                                            --
675 --  DESCRIPTION: Delete the given duplicate profile.                          --
676 --               The number of duplicate profiles deleted is returned (0 or 1).--
677 --               No commits are done.                                         --
678 --                                                                            --
679 --  MODIFICATION HISTORY                                                      --
680 --  Date         Username  Description                                        --
681 --  20-JUL-2006  dagroves  Created.                                           --
682 --------------------------------------------------------------------------------
683 FUNCTION DELETE_DUP_PROFILE
684   (P_APPLICATION_ID       IN NUMBER,
685    P_DUP_PROFILE_CODE     IN VARCHAR2)
686 RETURN NUMBER;
687 
688 --------------------------------------------------------------------------------
689 --  FUNCTION:    DELETE_ALL_CONTENTS                                          --
690 --                                                                            --
691 --  DESCRIPTION: Delete all contents for the given integrator.                --
692 --               This will delete each content for the integrator             --
693 --                 individually as per DELETE_CONTENT().                      --
694 --               It will NOT delete any mappings that reference the content.  --
695 --               use DELETE_MAPPING or DELETE_INTEGRATOR for consistent       --
699 --                                                                            --
696 --               deletion.                                                    --
697 --               The number of contents deleted is returned (0 or greater).   --
698 --               No commits are done.                                         --
700 --  MODIFICATION HISTORY                                                      --
701 --  Date         Username  Description                                        --
702 --  20-JUL-2006  dagroves  Created.                                           --
703 --------------------------------------------------------------------------------
704 FUNCTION DELETE_ALL_CONTENTS
705   (P_APPLICATION_ID       IN NUMBER,
706    P_INTEGRATOR_CODE      IN VARCHAR2)
707 RETURN NUMBER;
708 
709 --------------------------------------------------------------------------------
710 --  FUNCTION:    DELETE_CONTENT                                               --
711 --                                                                            --
712 --  DESCRIPTION: Delete the given content.                                    --
713 --               This will include all subsiduary structures:                 --
714 --                - Contents                                                  --
715 --                - Content Columns                                           --
716 --                - Stored SQL definitions                                    --
717 --                - Text File definitions                                     --
718 --                - Queries    as per DELETE_QUERY_IF_UNREF()                 --
719 --               The number of content deleted is returned (0 or 1).          --
720 --               No commits are done.                                         --
721 --                                                                            --
722 --  MODIFICATION HISTORY                                                      --
723 --  Date         Username  Description                                        --
724 --  20-JUL-2006  dagroves  Created.                                           --
725 --------------------------------------------------------------------------------
726 FUNCTION DELETE_CONTENT
727   (P_APPLICATION_ID       IN NUMBER,
728    P_CONTENT_CODE         IN VARCHAR2)
729 RETURN NUMBER;
730 
731 --------------------------------------------------------------------------------
732 --  FUNCTION:    DELETE_ALL_MAPPINGS                                          --
733 --                                                                            --
734 --  DESCRIPTION: Delete all mappings for the given integrator.                --
735 --               This will delete each mapping for the integrator             --
736 --                 individually as per DELETE_MAPPING().                      --
737 --               The number of mappings deleted is returned (0 or greater).   --
738 --               No commits are done.                                         --
739 --                                                                            --
740 --  MODIFICATION HISTORY                                                      --
741 --  Date         Username  Description                                        --
742 --  20-JUL-2006  dagroves  Created.                                           --
743 --------------------------------------------------------------------------------
744 FUNCTION DELETE_ALL_MAPPINGS
745   (P_APPLICATION_ID       IN NUMBER,
746    P_INTEGRATOR_CODE      IN VARCHAR2)
747 RETURN NUMBER;
748 
749 --------------------------------------------------------------------------------
750 --  FUNCTION:    DELETE_MAPPING                                               --
751 --                                                                            --
752 --  DESCRIPTION: Delete the given mapping.                                    --
753 --               This will include all subsiduary structures:                 --
754 --                - Mapping                                                   --
755 --                - Mapping Lines                                             --
756 --               The number of mappings deleted is returned (0 or 1).         --
757 --               No commits are done.                                         --
758 --                                                                            --
759 --  MODIFICATION HISTORY                                                      --
760 --  Date         Username  Description                                        --
761 --  20-JUL-2006  dagroves  Created.                                           --
762 --------------------------------------------------------------------------------
763 FUNCTION DELETE_MAPPING
764   (P_APPLICATION_ID       IN NUMBER,
765    P_MAPPING_CODE         IN VARCHAR2)
766 RETURN NUMBER;
767 
768 --------------------------------------------------------------------------------
769 --  FUNCTION:    DELETE_ALL_LAYOUTS                                           --
770 --                                                                            --
771 --  DESCRIPTION: Delete all layouts for the given integrator.                 --
772 --               This will delete each layouts for the integrator             --
773 --                 individually as per DELETE_LAYOUT().                       --
774 --               The number of layouts deleted is returned (0 or greater).    --
775 --               No commits are done.                                         --
776 --                                                                            --
777 --  MODIFICATION HISTORY                                                      --
778 --  Date         Username  Description                                        --
779 --  20-JUL-2006  dagroves  Created.                                           --
783    P_INTEGRATOR_CODE      IN VARCHAR2)
780 --------------------------------------------------------------------------------
781 FUNCTION DELETE_ALL_LAYOUTS
782   (P_APPLICATION_ID       IN NUMBER,
784 RETURN NUMBER;
785 
786 --------------------------------------------------------------------------------
787 --  FUNCTION:    DELETE_LAYOUT                                                --
788 --                                                                            --
789 --  DESCRIPTION: Delete the given layout.                                     --
790 --               This will include all subsiduary structures:                 --
791 --                - Layout                                                    --
792 --                - Layout Blocks                                             --
793 --                - Layout Columns                                            --
794 --                - Layout LOBS                                               --
795 --                - Graphs/Graph Columns referencing the layout               --
796 --               The number of layouts deleted is returned (0 or 1).          --
797 --               No commits are done.                                         --
798 --                                                                            --
799 --  MODIFICATION HISTORY                                                      --
800 --  Date         Username  Description                                        --
801 --  20-JUL-2006  dagroves  Created.                                           --
802 --------------------------------------------------------------------------------
803 FUNCTION DELETE_LAYOUT
804   (P_APPLICATION_ID       IN NUMBER,
805    P_LAYOUT_CODE          IN VARCHAR2)
806 RETURN NUMBER;
807 
808 --------------------------------------------------------------------------------
809 --  FUNCTION:    DELETE_COMPONENT                                             --
810 --                                                                            --
811 --  DESCRIPTION: Delete the given component.                                  --
812 --               This will include all subsiduary structures:                 --
813 --                - Component                                                 --
814 --                - Parameter List as per DELETE_PARAM_LIST_IF_UNREF()        --
815 --               The number of components deleted is returned (0 or 1).       --
816 --               No commits are done.                                         --
817 --                                                                            --
818 --  MODIFICATION HISTORY                                                      --
819 --  Date         Username  Description                                        --
820 --  20-JUL-2006  dagroves  Created.                                           --
821 --------------------------------------------------------------------------------
822 FUNCTION DELETE_COMPONENT
823   (P_APPLICATION_ID       IN NUMBER,
824    P_COMPONENT_CODE       IN VARCHAR2)
825 RETURN NUMBER;
826 
827 --------------------------------------------------------------------------------
828 --  FUNCTION:    DELETE_COMPONENT_IF_UNREF                                    --
829 --                                                                            --
830 --  DESCRIPTION: Delete the given Component only if it is unreferenced        --
831 --               throughout the entire schema.  All FKs are checked.          --
832 --               Delete is done as per DELETE_COMPONENT() if unreferenced.    --
833 --               The number of components deleted is returned (0 or 1).       --
834 --               No commits are done.                                         --
835 --                                                                            --
836 --  MODIFICATION HISTORY                                                      --
837 --  Date         Username  Description                                        --
838 --  20-JUL-2006  dagroves  Created.                                           --
839 --------------------------------------------------------------------------------
840 FUNCTION DELETE_COMPONENT_IF_UNREF
841   (P_APPLICATION_ID       IN NUMBER,
842    P_COMPONENT_CODE       IN VARCHAR2)
843 RETURN NUMBER;
844 
845 --------------------------------------------------------------------------------
846 --  FUNCTION:    DELETE_QUERY                                                 --
847 --                                                                            --
848 --  DESCRIPTION: Delete the given query.                                      --
849 --               This will include all subsiduary structures:                 --
850 --                - Query                                                     --
851 --                - Simple Query                                              --
852 --                - Raw Query Keys/Key columns                                --
853 --               The number of queries deleted is returned (0 or 1).          --
854 --               No commits are done.                                         --
855 --                                                                            --
856 --  MODIFICATION HISTORY                                                      --
857 --  Date         Username  Description                                        --
858 --  20-JUL-2006  dagroves  Created.                                           --
859 --------------------------------------------------------------------------------
860 FUNCTION DELETE_QUERY
861   (P_APPLICATION_ID       IN NUMBER,
862    P_QUERY_CODE           IN VARCHAR2)
863 RETURN NUMBER;
864 
865 --------------------------------------------------------------------------------
869 --               throughout the entire schema.  All FKs are checked.          --
866 --  FUNCTION:    DELETE_QUERY_IF_UNREF                                        --
867 --                                                                            --
868 --  DESCRIPTION: Delete the given Query only if it is unreferenced            --
870 --               Delete is done as per DELETE_QUERY() if unreferenced.        --
871 --               The number of Queries deleted is returned (0 or 1).          --
872 --               No commits are done.                                         --
873 --                                                                            --
874 --  MODIFICATION HISTORY                                                      --
875 --  Date         Username  Description                                        --
876 --  20-JUL-2006  dagroves  Created.                                           --
877 --------------------------------------------------------------------------------
878 FUNCTION DELETE_QUERY_IF_UNREF
879   (P_APPLICATION_ID       IN NUMBER,
880    P_QUERY_CODE           IN VARCHAR2)
881 RETURN NUMBER;
882 
883 --------------------------------------------------------------------------------
884 --  FUNCTION:    DELETE_PARAM_LIST                                            --
885 --                                                                            --
886 --  DESCRIPTION: Delete the given Parameter List.                             --
887 --               This will include all subsiduary structures:                 --
888 --                - List                                                      --
889 --                - List Items                                                --
890 --                - List Item Groups/Group Items                              --
891 --                - Definitions if otherwise unreferenced                     --
892 --                - Queries on definitions as per DELETE_QUERY_IF_UNREF()     --
893 --                - Attributes for list/items/groups/definitions if otherwise --
894 --                   unreferenced.                                            --
895 --               The number of lists deleted is returned (0 or 1).            --
896 --               No commits are done.                                         --
897 --                                                                            --
898 --  MODIFICATION HISTORY                                                      --
899 --  Date         Username  Description                                        --
900 --  20-JUL-2006  dagroves  Created.                                           --
901 --------------------------------------------------------------------------------
902 FUNCTION DELETE_PARAM_LIST
903   (P_APPLICATION_ID       IN NUMBER,
904    P_PARAM_LIST_CODE      IN VARCHAR2)
905 RETURN NUMBER;
906 
907 --------------------------------------------------------------------------------
908 --  FUNCTION:    DELETE_PARAM_LIST_IF_UNREF                                   --
909 --                                                                            --
910 --  DESCRIPTION: Delete the given Parameter List only if it is unreferenced   --
911 --               throughout the entire schema.  All FKs are checked.          --
912 --               Delete is done as per DELETE_PARAM_LIST() if unreferenced.   --
913 --               The number of lists deleted is returned (0 or 1).            --
914 --               No commits are done.                                         --
915 --                                                                            --
916 --  MODIFICATION HISTORY                                                      --
917 --  Date         Username  Description                                        --
918 --  20-JUL-2006  dagroves  Created.                                           --
919 --------------------------------------------------------------------------------
920 FUNCTION DELETE_PARAM_LIST_IF_UNREF
921   (P_APPLICATION_ID       IN NUMBER,
922    P_PARAM_LIST_CODE      IN VARCHAR2)
923 RETURN NUMBER;
924 
925 
926 --------------------------------------------------------------------------------
927 --  FUNCTION:    UPDATE_INTERFACE_COLUMN_TEXT                                 --
928 --                                                                            --
929 --  DESCRIPTION: Procedure call developed for the Interface Column Prompts    --
930 --               Integrator.  Specifically requested by HRMS to allow their   --
931 --               customers a safe means for modifying the prompts of their    --
932 --               custom integrators.                                          --
933 --                                                                            --
934 --  MODIFICATION HISTORY                                                      --
935 --  Date         Username  Description                                        --
936 --  17-APR-2007  jrichard  Created.                                           --
937 --------------------------------------------------------------------------------
938 PROCEDURE UPDATE_INTERFACE_COLUMN_TEXT
939                   (P_APPLICATION_ID IN NUMBER,
940                    P_INTERFACE_CODE IN VARCHAR2,
941                    P_SEQUENCE_NUM IN NUMBER,
942                    P_LANGUAGE IN VARCHAR2,
943                    P_SOURCE_LANG IN VARCHAR2,
944                    P_PROMPT_LEFT IN VARCHAR2,
945                    P_PROMPT_ABOVE IN VARCHAR2,
946                    P_USER_HINT IN VARCHAR2,
947                    P_USER_HELP_TEXT IN VARCHAR2 DEFAULT NULL,
948                    P_USER_ID IN NUMBER);
949 
950 --------------------------------------------------------------------------------
951 --  PROCEDURE:        ADD_LOV_PARAMETER_LIST                                  --
955 --  MODIFICATION HISTORY                                                      --
952 --                                                                            --
953 --  DESCRIPTION:      Create a parameter list for a LOV.                      --
954 --                                                                            --
956 --  Date         Username  Description                                        --
957 --  11-JUL-2006  dagroves  Created.                                           --
958 --------------------------------------------------------------------------------
959 PROCEDURE ADD_LOV_PARAMETER_LIST
960                   (P_APPLICATION_SHORT_NAME IN VARCHAR2,
961                    P_PARAM_LIST_CODE        IN VARCHAR2,
962                    P_PARAM_LIST_NAME        IN VARCHAR2,
963                    P_WINDOW_CAPTION         IN VARCHAR2,
964                    P_WINDOW_WIDTH           IN NUMBER,
965                    P_WINDOW_HEIGHT          IN NUMBER,
966                    P_TABLE_BLOCK_SIZE       IN NUMBER,
967                    P_TABLE_COLUMNS          IN VARCHAR2,
968                    P_TABLE_SELECT_COLUMNS   IN VARCHAR2,
969                    P_TABLE_COLUMN_ALIAS     IN VARCHAR2,
970                    P_TABLE_HEADERS          IN VARCHAR2,
971                    P_TABLE_SORT_ORDER       IN VARCHAR2,
972                    P_USER_NAME              IN VARCHAR2);
973 
974 END BNE_INTEGRATOR_UTILS;