DBA Data[Home] [Help]

PACKAGE: APPS.BIS_UTILITIES_PVT

Source


1 PACKAGE BIS_UTILITIES_PVT AS
2 /* $Header: BISVUTLS.pls 120.1 2005/12/28 06:05:52 ashankar noship $ */
3 
4 --  Global constant holding the package name
5 
6 G_PKG_NAME          CONSTANT VARCHAR2(30) := 'BIS_UTILITIES_PVT';
7 
8 G_RECORD_SET_SIZE CONSTANT NUMBER := 10;
9 
10 G_TOP           CONSTANT varchar2(3) := 'TOP';
11 G_CENTER        CONSTANT varchar2(10) := 'CENTER';
12 G_QN            CONSTANT varchar2(1) := '?';
13 G_EQ            CONSTANT varchar2(1) := '=';
14 G_AND           CONSTANT varchar2(1) := '&';
15 G_BIS_SEPARATOR CONSTANT varchar2(1) := '-';
16 
17 
18 G_LANGUAGE         CONSTANT varchar2(10) := 'JavaScript';
19 
20 G_ACTION_SAVE       CONSTANT varchar2(100) := 'SAVE';
21 G_ACTION_NEW        CONSTANT varchar2(100) := 'NEW';
22 G_ACTION_INDICATOR  CONSTANT varchar2(100) := 'INDICATOR';
23 G_ACTION_INDICATOR_SAVE CONSTANT varchar2(100) := 'INDICATOR_SAVE';
24 G_ACTION_VIEW_TARGETS      CONSTANT varchar2(100) := 'VIEW_TARGETS';
25 G_ACTION_VIEW_TARGETS_SAVE CONSTANT varchar2(100) := 'VIEW_TARGETS_SAVE';
26 G_ACTION_MEASURE    CONSTANT varchar2(100) := 'MEASURE';
27 G_ACTION_UPDATE     CONSTANT varchar2(100) := 'UPDATE';
28 G_ACTION_PREVIOUS   CONSTANT varchar2(100) := 'PREVIOUS';
29 G_ACTION_NEXT       CONSTANT varchar2(100) := 'NEXT';
30 G_ACTION_BACK       CONSTANT varchar2(100) := 'BACK';
31 G_ACTION_CANCEL     CONSTANT varchar2(100) := 'CANCEL';
32 G_ACTION_DONE       CONSTANT varchar2(100) := 'DONE';
33 G_ACTION_OK         CONSTANT varchar2(100) := 'OK';
34 G_ACTION_OK_SAVE    CONSTANT varchar2(100) := 'OK_SAVE';
35 G_ACTION_DELETE     CONSTANT varchar2(100) := 'DELETE';
36 G_ACTION_SECURITY   CONSTANT varchar2(100) := 'SECURITY';
37 G_ACTION_REVERT     CONSTANT varchar2(100) := 'REVERT';
38 G_ACTION_QUERY      CONSTANT varchar2(100) := 'QUERY';
39 G_ACTION_CHOICE     CONSTANT varchar2(100) := 'CHOICE';
40 G_ACTION_REFRESH        CONSTANT varchar2(100) := 'REFRESH';
41 
42 G_CHILD_WINDOW_WIDTH  CONSTANT NUMBER := 700;
43 G_CHILD_WINDOW_HEIGHT CONSTANT NUMBER := 500;
44 
45 G_BIS_APPLICATION_ID CONSTANT NUMBER := 191;
46 G_BIS_APPLICATION_SHORT_NAME CONSTANT VARCHAR2(10) := 'BIS';
47 G_BIS_REGION_CODE    CONSTANT varchar2(100) := 'BIS_KPI_PROMPTS';
48 
49 G_ROUND_EDGE  CONSTANT VARCHAR2(1000) := 'ROUND';
50 G_FLAT_EDGE   CONSTANT VARCHAR2(1000) := 'FLAT';
51 
52 G_TABLE_LEFT_MARGIN_PERCENT  CONSTANT NUMBER := 1;
53 G_TABLE_RIGHT_MARGIN_PERCENT CONSTANT NUMBER := 1;
54 
55 -- Global Variable to flag debugging
56 -- debug flag; if set to 1, print debug messages, else do not.
57 G_DEBUG_FLAG          NUMBER;
58 
59 TYPE HTML_Button_Rec_Type IS RECORD
60 ( left_edge  varchar2(1000)      -- could be G_ROUND_EDGE or G_FLAT_EDGE
61 , right_edge varchar2(1000)      -- could be G_ROUND_EDGE or G_FLAT_EDGE
62 , disabled   varchar2(1000)      -- FND_API.G_TRUE or FND_API.G_FALSE
63 , label      varchar2(32000)    -- what the user sees
64 , href       varchar2(32000)    -- href iff disabled=FND_API.G_FALSE
65 );
66 
67 TYPE HTML_Button_Tbl_Type IS TABLE of HTML_Button_Rec_Type
68   INDEX BY BINARY_INTEGER;
69 
70 TYPE HTML_Table_Element_Rec_Type IS RECORD
71 ( row_num    number
72 , display_name    varchar2(200)    -- what the user sees
73 , href       varchar2(2000)
74 , align      VARCHAR2(10)
75 , row_span   number
76 , col_span   number
77 , attributes VARCHAR2(1000)
78 );
79 
80 TYPE HTML_Table_Element_Tbl_Type IS TABLE of HTML_Table_Element_Rec_Type
81   INDEX BY BINARY_INTEGER;
82 
83 TYPE HTML_Tablerow_strings_Tbl_Type IS TABLE of VARCHAR2(32000)
84   INDEX BY BINARY_INTEGER;
85 
86 G_FUNCTION_SUBMIT_FORM_SAVE   CONSTANT VARCHAR(20) := 'submitForm_Save';
87 G_FUNCTION_SUBMIT_FORM_DELETE CONSTANT VARCHAR(20) := 'submitForm_Delete';
88 G_FUNCTION_SUBMIT_FORM_NEW    CONSTANT VARCHAR(20) := 'submitForm_New';
89 G_FUNCTION_SUBMIT_FORM_UPDATE CONSTANT VARCHAR(20) := 'submitForm_Update';
90 G_FUNCTION_SUBMIT_FORM_BACK   CONSTANT VARCHAR(20) := 'submitForm_Back';
91 G_FUNCTION_SUBMIT_FORM_NEXT   CONSTANT VARCHAR(20) := 'submitForm_Next';
92 G_FUNCTION_SUBMIT_FORM_CANCEL CONSTANT VARCHAR(20) := 'submitForm_Cancel';
93 G_FUNCTION_SUBMIT_FORM_REVERT CONSTANT VARCHAR(20) := 'submitForm_Revert';
94 G_FUNCTION_SUBMIT_FORM_DONE   CONSTANT VARCHAR(20) := 'submitForm_Done';
95 --- --- Hold-over from temporary button function change ---
96 ---G_FUNCTION_SUBMIT_FORM_DONE   CONSTANT VARCHAR(20) := 'submitForm_Cancel';
97 G_FUNCTION_SUBMIT_FORM_OK     CONSTANT VARCHAR(20) := 'submitForm_OK';
98 
99 -- DATE FORMAT to be used for optimistic locking
100 G_DATE_FORMAT VARCHAR2(200) := 'DD-MM-YYYY HH24:MI:SS';
101 G_DUMMY_VALUE                CONSTANT VARCHAR2(10)  := 'ABCXYZZYX';
102 G_NO_SELECTION_VALUE         CONSTANT VARCHAR2(10)  := 'ABCXYZZYX';
103 
104 --  Functions/ Procedures
105 
106 function getPrompt(p_attribute_code varchar2) return varchar2;
107 function getPrompt
108 ( p_region_code in varchar2
109 , p_attribute_code in varchar2) return varchar2;
110 
111 -- sets the html form fields according to null if they are G_MISS type
112 
113 PROCEDURE PutHtmlNumberTextField
114 ( p_field_name  varchar2
115 , p_number      number
116 );
117 
118 PROCEDURE PutHtmlNumberOptionField
119 ( p_number      number
120 , p_selected    varchar2 := NULL
121 , p_value       varchar2 := NULL
122 );
123 
124 PROCEDURE PutHtmlNumberHiddenField
125 ( p_field_name  varchar2
126 , p_number      number
127 );
128 
129 PROCEDURE PutHtmlVarcharTextField
130 ( p_field_name  varchar2
131 , p_varchar     varchar2
132 );
133 
134 PROCEDURE PutHtmlVarcharOptionField
135 ( p_varchar     varchar2
136 , p_selected    varchar2 := NULL
137 , p_value       varchar2 := NULL
138 );
139 
140 PROCEDURE PutHtmlVarcharHiddenField
141 ( p_field_name  varchar2
142 , p_varchar     varchar2
143 );
144 
145 -- function to get message from msg dictionary
146 FUNCTION Get_FND_Message
147 ( p_message_name IN VARCHAR2
148 )
149 RETURN VARCHAR2;
150 
151 FUNCTION Get_FND_Message
152 ( p_message_name   IN VARCHAR2
153 , p_msg_param1     IN VARCHAR2
154 , p_msg_param1_val IN VARCHAR2
155 )
156 RETURN VARCHAR2;
157 
158 FUNCTION Get_FND_Message
159 ( p_message_name   IN VARCHAR2
160 , p_msg_param1     IN VARCHAR2
161 , p_msg_param1_val IN VARCHAR2
162 , p_msg_param2     IN VARCHAR2
163 , p_msg_param2_val IN VARCHAR2
164 )
165 RETURN VARCHAR2;
166 
167 FUNCTION Get_FND_Message
168 ( p_message_name   IN VARCHAR2
169 , p_msg_param1     IN VARCHAR2
170 , p_msg_param1_val IN VARCHAR2
171 , p_msg_param2     IN VARCHAR2
172 , p_msg_param2_val IN VARCHAR2
173 , p_msg_param3     IN VARCHAR2
174 , p_msg_param3_val IN VARCHAR2
175 )
176 RETURN VARCHAR2;
177 
178 -- these procedures check and puts the error message on the message stack
179 PROCEDURE Add_Error_Message
180 ( p_error_msg_name    IN VARCHAR2
181 , p_error_msg_level   IN NUMBER     := FND_MSG_PUB.G_MSG_LVL_ERROR
182 , p_error_proc_name   IN  VARCHAR2  := NULL
183 , p_error_type        IN  VARCHAR2  := BIS_UTILITIES_PUB.G_ERROR
184 , p_error_table       IN  BIS_UTILITIES_PUB.Error_Tbl_Type
185 , x_error_table       OUT NOCOPY BIS_UTILITIES_PUB.Error_Tbl_Type
186 );
187 
188 PROCEDURE Add_Error_Message
189 ( p_error_msg_name    IN VARCHAR2
190 , p_error_msg_level   IN NUMBER     := FND_MSG_PUB.G_MSG_LVL_ERROR
191 , p_error_proc_name   IN  VARCHAR2  := NULL
192 , p_error_type        IN  VARCHAR2  := BIS_UTILITIES_PUB.G_ERROR
193 , p_token1            IN VARCHAR2
194 , p_value1            IN VARCHAR2
195 , p_error_table       IN  BIS_UTILITIES_PUB.Error_Tbl_Type
196 , x_error_table       OUT NOCOPY BIS_UTILITIES_PUB.Error_Tbl_Type
197 );
198 
199 PROCEDURE Add_Error_Message
200 ( p_error_msg_name    IN VARCHAR2
201 , p_error_msg_level   IN NUMBER     := FND_MSG_PUB.G_MSG_LVL_ERROR
202 , p_error_proc_name   IN  VARCHAR2  := NULL
203 , p_error_type        IN  VARCHAR2  := BIS_UTILITIES_PUB.G_ERROR
204 , p_token1            IN VARCHAR2
205 , p_value1            IN VARCHAR2
206 , p_token2            IN VARCHAR2
207 , p_value2            IN VARCHAR2
208 , p_error_table       IN  BIS_UTILITIES_PUB.Error_Tbl_Type
209 , x_error_table       OUT NOCOPY BIS_UTILITIES_PUB.Error_Tbl_Type
210 );
211 
212 PROCEDURE Add_Error_Message
213 ( p_error_msg_name    IN VARCHAR2
214 , p_error_msg_level   IN NUMBER     := FND_MSG_PUB.G_MSG_LVL_ERROR
215 , p_error_proc_name   IN VARCHAR2  := NULL
216 , p_error_type        IN  VARCHAR2  := BIS_UTILITIES_PUB.G_ERROR
217 , p_token1            IN VARCHAR2
218 , p_value1            IN VARCHAR2
219 , p_token2            IN VARCHAR2
220 , p_value2            IN VARCHAR2
221 , p_token3            IN VARCHAR2
222 , p_value3            IN VARCHAR2
223 , p_error_table       IN  BIS_UTILITIES_PUB.Error_Tbl_Type
224 , x_error_table       OUT NOCOPY BIS_UTILITIES_PUB.Error_Tbl_Type
225 );
226 
227 -- this procedure adds a message to the error table
228 PROCEDURE Add_Error_Message
229 ( p_error_msg_id      IN  NUMBER    := NULL
230 , p_error_description IN  VARCHAR2  := NULL
231 , p_error_proc_name   IN VARCHAR2  := NULL
232 , p_error_type        IN  VARCHAR2  := BIS_UTILITIES_PUB.G_ERROR
233 , p_error_table       IN  BIS_UTILITIES_PUB.Error_Tbl_Type
234 , x_error_table       OUT NOCOPY BIS_UTILITIES_PUB.Error_Tbl_Type
235 );
236 
237 -- these procedures check and puts the error message on the message stack
238 PROCEDURE Add_Error_Message
239 ( p_error_msg_name    IN VARCHAR2
240 , p_error_msg_level   IN NUMBER     := FND_MSG_PUB.G_MSG_LVL_ERROR
241 , p_error_proc_name   IN  VARCHAR2  := NULL
242 , p_error_type        IN  VARCHAR2  := BIS_UTILITIES_PUB.G_ERROR
243 );
244 
245 PROCEDURE Add_Error_Message
246 ( p_error_msg_name    IN VARCHAR2
247 , p_error_msg_level   IN NUMBER     := FND_MSG_PUB.G_MSG_LVL_ERROR
248 , p_error_proc_name   IN  VARCHAR2  := NULL
249 , p_error_type        IN  VARCHAR2  := BIS_UTILITIES_PUB.G_ERROR
250 , p_token1            IN VARCHAR2
251 , p_value1            IN VARCHAR2
252 );
253 
254 PROCEDURE Add_Error_Message
255 ( p_error_msg_name    IN VARCHAR2
256 , p_error_msg_level   IN NUMBER     := FND_MSG_PUB.G_MSG_LVL_ERROR
257 , p_error_proc_name   IN  VARCHAR2  := NULL
258 , p_error_type        IN  VARCHAR2  := BIS_UTILITIES_PUB.G_ERROR
259 , p_token1            IN VARCHAR2
260 , p_value1            IN VARCHAR2
261 , p_token2            IN VARCHAR2
262 , p_value2            IN VARCHAR2
263 );
264 
265 PROCEDURE Add_Error_Message
266 ( p_error_msg_name    IN VARCHAR2
267 , p_error_msg_level   IN NUMBER     := FND_MSG_PUB.G_MSG_LVL_ERROR
268 , p_error_proc_name   IN VARCHAR2  := NULL
269 , p_error_type        IN  VARCHAR2  := BIS_UTILITIES_PUB.G_ERROR
270 , p_token1            IN VARCHAR2
271 , p_value1            IN VARCHAR2
272 , p_token2            IN VARCHAR2
273 , p_value2            IN VARCHAR2
274 , p_token3            IN VARCHAR2
275 , p_value3            IN VARCHAR2
276 );
277 
278 -- this procedure adds a message to the error table
279 PROCEDURE Add_Error_Message
280 ( p_error_msg_id      IN  NUMBER    := NULL
281 , p_error_description IN  VARCHAR2  := NULL
282 , p_error_proc_name   IN VARCHAR2  := NULL
283 , p_error_type        IN  VARCHAR2  := BIS_UTILITIES_PUB.G_ERROR
284 );
285 --
286 PROCEDURE PutStyle;
287 
288 -- This function will return a string
289 -- The string is a html table with all the images arranged
290 -- properly in this table according to the buttons desired
291 -- make sure that the string is max length to avoid overflow problems
292 PROCEDURE GetButtonString
293 ( p_Button_table in  HTML_Button_Tbl_Type
294 , x_str          out NOCOPY varchar2
295 );
296 
297 -- This function starts table with the
298 -- standard margins on left and right
299 -- takes in the number of columns and rows in the table
300 PROCEDURE tableOpen
301 ( p_num_row  in NUMBER
302 , p_num_col  in NUMBER
303 );
304 
305 PROCEDURE tableClose;
306 
307 -- these functions put javascript functions in the script with
308 -- standard name and action
309 
310 PROCEDURE putSaveFunction
311 ( p_form_name       varchar2
312 , p_action_var      varchar2
313 , p_str             varchar2 DEFAULT NULL
314 , p_submit_form     varchar2 DEFAULT FND_API.G_TRUE
315 );
316 
317 PROCEDURE putDeleteFunction
318 ( p_form_name       varchar2
319 , p_action_var      varchar2
320 , p_str             varchar2 DEFAULT NULL
321 , p_submit_form     varchar2 DEFAULT FND_API.G_TRUE
322 );
323 
324 PROCEDURE putNewFunction
325 ( p_form_name       varchar2
326 , p_action_var      varchar2
327 , p_str             varchar2 DEFAULT NULL
328 , p_submit_form     varchar2 DEFAULT FND_API.G_TRUE
329 );
330 
331 PROCEDURE putUpdateFunction
332 ( p_form_name       varchar2
333 , p_action_var      varchar2
334 , p_str             varchar2 DEFAULT NULL
335 , p_submit_form     varchar2 DEFAULT FND_API.G_TRUE
336 );
337 
338 PROCEDURE putBackFunction
339 ( p_form_name       varchar2
340 , p_action_var      varchar2
341 , p_str             varchar2 DEFAULT NULL
342 , p_submit_form     varchar2 DEFAULT FND_API.G_TRUE
343 );
344 
345 PROCEDURE putNextFunction
346 ( p_form_name       varchar2
347 , p_action_var      varchar2
348 , p_str             varchar2 DEFAULT NULL
349 , p_submit_form     varchar2 DEFAULT FND_API.G_TRUE
350 );
351 
352 PROCEDURE putCancelFunction
353 ( p_form_name       varchar2
354 , p_action_var      varchar2
355 , p_str             varchar2 DEFAULT NULL
356 , p_submit_form     varchar2 DEFAULT FND_API.G_TRUE
357 );
358 
359 PROCEDURE putRevertFunction
360 ( p_form_name       varchar2
361 , p_action_var      varchar2
362 , p_str             varchar2 DEFAULT NULL
363 , p_submit_form     varchar2 DEFAULT FND_API.G_TRUE
364 );
365 
366 PROCEDURE putDoneFunction
367 ( p_form_name       varchar2
368 , p_action_var      varchar2
369 , p_str             varchar2 DEFAULT NULL
370 , p_submit_form     varchar2 DEFAULT FND_API.G_TRUE
371 );
372 
373 PROCEDURE putOkFunction
374 ( p_form_name       varchar2
375 , p_action_var      varchar2
376 , p_str             varchar2 DEFAULT NULL
377 , p_submit_form     varchar2 DEFAULT FND_API.G_TRUE
378 );
379 
380 PROCEDURE putFunction
381 ( p_form_name       varchar2
382 , p_action_var      varchar2
383 , p_str             varchar2 DEFAULT NULL
384 , p_function_name   varchar2
385 , p_action          varchar2
386 , p_submit_form     varchar2 DEFAULT FND_API.G_TRUE
387 );
388 
389 PROCEDURE putVerticalSpacer(p_col_num NUMBER);
390 PROCEDURE putGreyLine(p_col_num NUMBER);
391 
392 PROCEDURE getGroupBoxString
393 ( p_title_string IN  varchar2
394 , p_title_bold   IN  varchar2 := FND_API.G_FALSE
395 , p_data_string  IN  varchar2
396 , x_str          OUT NOCOPY varchar2
397 );
398 
399 PROCEDURE getGroupBoxString
400 ( p_title_string IN  varchar2
401 , p_title_bold   IN  varchar2 := FND_API.G_FALSE
402 , p_data_tbl     IN  BIS_UTILITIES_PUB.BIS_VARCHAR_TBL
403 , x_data_tbl     OUT NOCOPY BIS_UTILITIES_PUB.BIS_VARCHAR_TBL
404 
405 );
406 
407 PROCEDURE getTableString
408 ( p_heading_table  IN  HTML_Table_Element_Tbl_Type
409 , p_data_table     IN  HTML_Table_Element_Tbl_Type
410 , p_head_row_count IN  number
411 , p_data_row_count IN  number
412 , p_col_count      IN  NUMBER
413 , x_str            OUT NOCOPY varchar2
414 );
415 
416 --Overloaded getTableString Function
417 PROCEDURE getTableString
418 (p_heading_table     IN   HTML_Table_Element_Tbl_Type
419 ,p_data_table        IN   HTML_Table_Element_Tbl_Type
420 ,p_head_row_count    IN   number
421 ,p_data_row_count    IN   number
422 ,p_col_count         IN   number
423 ,x_str               OUT NOCOPY  HTML_Tablerow_Strings_Tbl_type
424 );
425 
426 -- concatenate the two error tables into one
427 PROCEDURE concatenateErrorTables
428 ( p_error_Tbl1 IN  BIS_UTILITIES_PUB.Error_Tbl_Type
429 , p_error_Tbl2 IN  BIS_UTILITIES_PUB.Error_Tbl_Type
430 , x_error_Tbl  OUT NOCOPY BIS_UTILITIES_PUB.Error_Tbl_Type
431 );
432 
433 -- function to return NULL if G_MISS_CHAR
434 FUNCTION CheckMissChar
435 ( p_char IN VARCHAR2
436 )
437 RETURN VARCHAR2;
438 
439 -- function to return NULL if G_MISS_NUM
440 FUNCTION CheckMissNum
441 ( p_num IN NUMBER
442 )
443 RETURN NUMBER;
444 
445 FUNCTION CheckMissDate
446 ( p_date IN DATE
447 )
448 RETURN DATE;
449 
450 --
451 FUNCTION PutNullString
452 ( p_Str    varchar2
453 , p_align  varchar2
454 , p_rowspan NUMBER
455 , p_colspan NUMBER
456 )
457 return VARCHAR2;
458 --
459 -- the following functions return FND_API.G_TRUE/FND_API.G_FALSE
460 
461 FUNCTION Value_Missing(
462     p_value      IN VARCHAR2 )
463 RETURN VARCHAR2;
464 
465 FUNCTION Value_Missing(
466     p_value      IN NUMBER )
467 RETURN VARCHAR2;
468 
469 FUNCTION Value_Missing(
470     p_value      IN DATE )
471 RETURN VARCHAR2;
472 
473 FUNCTION Value_Not_Missing(
474     p_value      IN VARCHAR2 )
475 RETURN VARCHAR2;
476 
477 FUNCTION Value_Not_Missing(
478     p_value      IN NUMBER )
479 RETURN VARCHAR2;
480 
481 FUNCTION Value_Not_Missing(
482     p_value      IN DATE )
483 RETURN VARCHAR2;
484 FUNCTION Value_NULL(
485      p_value      IN VARCHAR2 )
486 RETURN VARCHAR2;
487 
488 FUNCTION Value_NULL(
489      p_value      IN NUMBER )
490 RETURN VARCHAR2;
491 
492 FUNCTION Value_NULL(
493      p_value      IN DATE )
494 RETURN VARCHAR2;
495 
496 FUNCTION Value_Not_NULL(
497      p_value      IN VARCHAR2 )
498 RETURN VARCHAR2;
499 
500 FUNCTION Value_Not_NULL(
501      p_value      IN NUMBER )
502 RETURN VARCHAR2;
503 
504 FUNCTION Value_Not_NULL(
505      p_value      IN DATE )
506 RETURN VARCHAR2;
507 
508 FUNCTION Value_Missing_Or_Null(  -- 2730145
509     p_value      IN VARCHAR )
510 RETURN VARCHAR2;
511 
512 FUNCTION Value_Missing_Or_Null(  -- 2730145
513     p_value      IN NUMBER )
514 RETURN VARCHAR2;
515 
516 FUNCTION Value_Missing_Or_Null(  -- 2730145
517     p_value      IN DATE )
518 RETURN VARCHAR2;
519 
520 FUNCTION Value_Not_Missing_Not_Null(  -- 2730145
521     p_value      IN VARCHAR2 )
522 RETURN VARCHAR2;
523 
524 FUNCTION Value_Not_Missing_Not_Null(  -- 2730145
525     p_value      IN NUMBER )
526 RETURN VARCHAR2;
527 
528 FUNCTION Value_Not_Missing_Not_Null(  -- 2730145
529     p_value      IN DATE )
530 RETURN VARCHAR2;
531 
532 PROCEDURE Set_Debug_Flag;
533 
534 -- returns FND_API.G_TRUE is OK to convert to ID
535 -- else FND_API.G_FALSE
536 FUNCTION Convert_to_ID
537 ( p_id         NUMBER
538 , p_short_name VARCHAR2
539 , p_name       VARCHAR2
540 )
541 return VARCHAR2;
542 --
543 --
544 procedure Replace_String
545 ( p_string    IN VARCHAR2
546 , x_string    OUT NOCOPY VARCHAR2
547 );
548 --
549 function target_level_where_clause
550 return varchar2;
551 
552 --
553 function target_level_where_clause
554 (p_user_id IN NUMBER)
555 return varchar2;
556 --
557 -- Fix for 2254597 starts here
558 function target_level_where_clause
559 (p_user_id                    IN NUMBER
560 ,x_return_status              OUT NOCOPY  VARCHAR2
561 ,x_msg_count                  OUT NOCOPY  VARCHAR2
562 ,x_msg_data                   OUT NOCOPY  VARCHAR2
563 )
564 return varchar2;
565 -- Fix for 2254597 ends here
566 --
567 function Perf_measure_where_clause
568 return varchar2;
569 --
570 function Perf_measure_where_clause
571 (p_user_id IN NUMBER)
572 return varchar2;
573 --
574 -- Fix for 2254597 starts here
575 function Perf_measure_where_clause
576 (p_user_id                    IN NUMBER
577 ,x_return_status              OUT NOCOPY  VARCHAR2
578 ,x_msg_count                  OUT NOCOPY  VARCHAR2
579 ,x_msg_data                   OUT NOCOPY  VARCHAR2
580 )
581  return varchar2;
582 -- Fix for 2254597 ends here
583 --
584 PROCEDURE resequence_dim_level_values
585 (p_dim_values_rec   IN   BIS_TARGET_PUB.TARGET_REC_TYPE
586 ,p_sequence_dir     IN   VARCHAR2
587 ,x_dim_values_rec   IN OUT NOCOPY  BIS_TARGET_PUB.TARGET_REC_TYPE
588 ,x_error_tbl        OUT NOCOPY  BIS_UTILITIES_PUB.ERROR_TBL_TYPE
589 );
590 --
591 PROCEDURE reseq_actual_dim_level_values
592 (p_dim_values_Rec   IN   BIS_ACTUAL_PUB.Actual_rec_type
593 ,p_Sequence_dir     IN   VARCHAR2
594 ,x_dim_values_rec   IN OUT NOCOPY  BIS_ACTUAL_PUB.Actual_rec_type
595 ,x_error_tbl        OUT NOCOPY  BIS_UTILITIES_PUB.ERROR_TBL_TYPE
596 );
597 --
598 PROCEDURE resequence_dim_levels
599 (p_dim_level_rec    IN   BIS_TARGET_LEVEL_PUB.TARGET_LEVEL_REC_TYPE
600 ,p_sequence_dir     IN   VARCHAR2
601 ,x_dim_level_rec    IN OUT NOCOPY  BIS_TARGET_LEVEL_PUB.TARGET_LEVEL_REC_TYPE
602 ,x_error_tbl        OUT NOCOPY  BIS_UTILITIES_PUB.ERROR_TBL_TYPE
603 );
604 --
605 -- mdamle 01/12/2001 - Resequence Indicator record
606 PROCEDURE reseq_ind_dim_level_values
607 (p_dim_values_Rec   IN   BIS_INDICATOR_REGION_PUB.Indicator_Region_Rec_Type
608 ,p_Sequence_dir     IN   VARCHAR2
609 ,x_dim_values_rec   IN OUT NOCOPY  BIS_INDICATOR_REGION_PUB.Indicator_Region_Rec_Type
610 ,x_error_tbl        OUT NOCOPY  BIS_UTILITIES_PUB.ERROR_TBL_TYPE
611 );
612 --
613 FUNCTION GET_SOURCE_FROM_DIM_LEVEL
614 (p_DimLevelId IN NUMBER  := NULL
615 ,p_DimLevelShortName IN VARCHAR2 := NULL
616 )
617 RETURN VARCHAR2;
618 --
619 FUNCTION GET_TIME_DIMENSION_NAME
620 (p_DimLevelId IN NUMBER  := NULL
621  ,p_DimLevelName IN VARCHAR2 := NULL
622 )
623 RETURN VARCHAR2;
624 --
625 FUNCTION GET_ORG_DIMENSION_NAME
626 (p_DimLevelId IN NUMBER := NULL
627  ,p_DimLevelName IN VARCHAR2 := NULL
628 )
629 RETURN VARCHAR2;
630 --
631 FUNCTION GET_INV_LOC_DIMENSION_NAME -- 2525408
632 (p_DimLevelId IN NUMBER := NULL
633  ,p_DimLevelName IN VARCHAR2 := NULL
634 )
635 RETURN VARCHAR2;
636 --
637 FUNCTION GET_TIME_DIMENSION_NAME_TL
638 (p_TargetLevelId IN NUMBER := NULL
639  ,p_TargetLevelName IN VARCHAR2 := NULL
640 )
641 RETURN VARCHAR2;
642 --
643 FUNCTION GET_ORG_DIMENSION_NAME_TL
644 (p_TargetLevelId IN NUMBER := NULL
645  ,p_TargetLevelName IN VARCHAR2 := NULL
646 )
647 RETURN VARCHAR2;
648 --
649 PROCEDURE  get_org_dim_name_tl_edw
650 ( p_tgt_lvl_short_name   IN VARCHAR2,
651   p_tgt_lvl_ID       IN NUMBER,
652   x_dimension_short_name OUT NOCOPY VARCHAR2,
653   x_return_status    OUT NOCOPY VARCHAR2,
654   x_return_msg       OUT NOCOPY VARCHAR2);
655 --
656 FUNCTION GET_TIME_DIMENSION_NAME_SRC
657 (p_source IN  VARCHAR2
658 )
659 RETURN VARCHAR2;
660 --
661 FUNCTION GET_ORG_DIMENSION_NAME_SRC
662 (p_source IN  VARCHAR2
663 )
664 RETURN VARCHAR2;
665 --
666 FUNCTION GET_INV_LOC_DIMENSION_NAME_SRC --2525408
667 (p_source IN  VARCHAR2
668 )
669 RETURN VARCHAR2;
670 --
671 FUNCTION GET_TOTAL_DIMLEVEL_NAME
672 (p_dim_short_name    IN    VARCHAR2
673  ,p_DimLevelId IN NUMBER := NULL
674  ,p_DimLevelName IN VARCHAR2 := NULL
675 )
676 RETURN VARCHAR2;
677 --
678 FUNCTION GET_TOTAL_DIMLEVEL_NAME_SRC -- 2617369
679 (p_dim_short_name    IN    VARCHAR2
680 ,p_source            IN    VARCHAR2
681 )
682 RETURN VARCHAR2;
683 --
684 FUNCTION IS_TOTAL_DIMLEVEL
685 ( p_dim_Level_short_name    IN    VARCHAR2
686  ,x_return_status           OUT NOCOPY   VARCHAR2
687 )
688 RETURN BOOLEAN;
689 
690 --
691 FUNCTION GET_TOTAL_DIMLEVEL_NAME_TL
692 (p_dim_short_name    IN    VARCHAR2
693  ,p_TargetLevelId IN NUMBER := NULL
694  ,p_TargetLevelName IN VARCHAR2 := NULL
695 )
696 RETURN VARCHAR2;
697 --
698 FUNCTION GET_TIME_SHORT_NAME
699 (p_dim_level_id    IN   NUMBER
700 )
701 RETURN VARCHAR2;
702 --
703 FUNCTION GET_TIME_FROM
704 ( p_duration         IN   NUMBER
705 , p_table_name       IN   VARCHAR2
706 , p_time             IN   VARCHAR2
707 , p_id               IN   VARCHAR2
708 , p_id_col_name      IN   VARCHAR2
709 , p_value_col_name   IN   VARCHAR2
710 , p_Org_Level_ID     IN   VARCHAR2
711 , p_Org_Level_Short_name IN   VARCHAR2
712 , p_time_level_id    IN   NUMBER
713 , p_time_level_sh_name IN  VARCHAR2
714 )
715 RETURN VARCHAR2;
716 --
717 FUNCTION GET_TIME_TO
718 ( p_duration         IN   NUMBER
719 , p_table_name       IN   VARCHAR2
720 , p_time             IN   VARCHAR2
721 , p_id               IN   VARCHAR2
722 , p_id_col_name      IN   VARCHAR2
723 , p_value_col_name   IN   VARCHAR2
724 , p_Org_Level_ID     IN   VARCHAR2
725 , p_Org_Level_Short_name IN   VARCHAR2
726 , p_time_level_id    IN   NUMBER
727 , p_time_level_sh_name IN  VARCHAR2
728 )
729 RETURN VARCHAR2;
730 --
731 Procedure Get_Org_Info_Based_On_Source  -- what to do if org_id/short_name is missing.
732 ( p_source       IN varchar2,
733   p_org_level_id     IN varchar2,
734   p_org_level_short_name IN varchar2,
735   x_org_level_id     OUT NOCOPY varchar2,
736   x_org_level_short_name OUT NOCOPY varchar2
737 );
738 --
739 Procedure Get_Time_Level_Value_ID_Minus -- where (sysdate - p_sysdate_less) is between start and end dates..
740 ( p_source      IN varchar2,
741   p_view_name       IN varchar2,
742   p_id_name         IN varchar2,
743   p_org_level_id    IN varchar2,
744   p_org_level_short_name IN varchar2,
745   p_sysdate_less    IN number,
746   x_time_id     OUT NOCOPY varchar2
747 );
748 --
749 Procedure Get_Start_End_Dates   -- where level_value_id = p_id_value_name
750 ( p_source      IN varchar2,    --   and level_value = p_time_value
751   p_view_name       IN varchar2,    --   need to merge this and Get_Start_End_Dates2
752   p_id_col_name         IN varchar2,
753   p_id_value_name       IN varchar2,
754   --  p_value_col_name      IN varchar2,
755   --  p_time_value          IN varchar2,
756   p_org_level_id    IN varchar2,
757   p_org_level_short_name IN varchar2,
758   x_start_date      OUT NOCOPY date,
759   x_end_date        OUT NOCOPY date
760 );
761 --
762 Procedure Get_Time_Level_Value_ID_Date  -- where target_date is between start and end dates..
763 ( p_source      IN varchar2,        -- this and Get_Time_Level_Value_ID1 need to be combined.
764   p_view_name       IN varchar2,
765   p_id_name         IN varchar2,
766   p_org_level_id    IN varchar2,
767   p_org_level_short_name IN varchar2,
768   p_target_date     IN date,
769   x_time_id     OUT NOCOPY varchar2
770 );
771 --
772 FUNCTION Is_Rolling_Period_Level    -- 2408906
773 (p_level_short_name IN VARCHAR2
774 )
775 RETURN NUMBER;
776 --
777 FUNCTION get_Roll_Period_Start_Date
778 ( p_level_short_name    IN VARCHAR2
779 , p_end_date        IN DATE
780 )
781 RETURN DATE;
782 --
783 --jxyu added for enhancement #2435226
784 FUNCTION Get_FND_Lookup
785 ( p_lookup_type   IN VARCHAR2
786 , p_lookup_code   IN VARCHAR2
787 )
788 RETURN VARCHAR2;
789 
790 
791 
792 FUNCTION get_bis_jsp_path
793 RETURN VARCHAR2;-- 1898436
794 
795 FUNCTION get_webdb_host
796 RETURN VARCHAR2; -- 1898436
797 
798 FUNCTION get_webdb_port
799 RETURN VARCHAR2; -- 1898436
800 
801 
802 PROCEDURE get_debug_mode_profile -- 2694978
803 ( x_is_debug_mode   OUT NOCOPY BOOLEAN
804 , x_return_status   OUT NOCOPY VARCHAR2
805 , x_return_msg      OUT NOCOPY VARCHAR2
806 );
807 
808 PROCEDURE set_debug_log_flag (  -- 2694978
809   p_is_true         IN  BOOLEAN
810 , x_return_status   OUT NOCOPY VARCHAR2
811 , x_return_msg      OUT NOCOPY VARCHAR2
812 ) ;
813 
814 FUNCTION is_debug_on RETURN BOOLEAN ;  -- 2694978
815 
816 PROCEDURE open_debug_log ( -- 2694978
817   p_file_name      IN  VARCHAR2,
818   p_dir_name       IN  VARCHAR2,
819   x_return_status  OUT NOCOPY VARCHAR2,
820   x_return_msg     OUT NOCOPY VARCHAR2);
821 
822 PROCEDURE close_debug_log ( -- 2694978
823   p_file_name      IN  VARCHAR2,
824   p_dir_name       IN  VARCHAR2,
825   x_return_status  OUT NOCOPY VARCHAR2,
826   x_return_msg     OUT NOCOPY VARCHAR2)  ;
827 
828 
829 --
830 -- Init_debug_log calls get_debug_mode_profile, sets the value
831 -- of debug flag (BIS_UTILITIES_PUB.G_IS_DEBUG) using set_debug_log_flag
832 -- and then opens the log file using open_debug_log.
833 --
834 PROCEDURE init_debug_log -- 2694978
835 ( p_file_name       IN  VARCHAR2
836 , p_dir_name        IN  VARCHAR2
837 , x_return_status   OUT NOCOPY VARCHAR2
838 , x_return_msg      OUT NOCOPY VARCHAR2
839 ) ;
840 
841 PROCEDURE init_debug_flag -- 2694978
842 ( x_return_status   OUT NOCOPY VARCHAR2
843 , x_return_msg      OUT NOCOPY VARCHAR2
844 );
845 
846 PROCEDURE put(p_text IN VARCHAR2) ; -- 2694978
847 
848 PROCEDURE put_line(p_text IN VARCHAR2) ; -- 2694978
849 
850 FUNCTION escape_html(
851   p_input IN VARCHAR2
852 )
853 RETURN VARCHAR2;
854 
855 FUNCTION escape_html_input(
856   p_input IN VARCHAR2
857 )
858 RETURN VARCHAR2;
859 
860 FUNCTION is_valid_time_dimension_level
861 (
862   p_bis_dimlevel_id        IN NUMBER  := NULL
863 , x_return_status     OUT NOCOPY VARCHAR2
864 )
865 RETURN BOOLEAN;
866 
867 FUNCTION filter_quotes
868 (
869   p_filter_string    IN VARCHAR2
870 )
871 RETURN VARCHAR2;
872 
873 FUNCTION get_role_id
874 (
875   p_role_name    IN VARCHAR2
876 )
877 RETURN NUMBER;
878 
879 FUNCTION getPMVReport
880 (
881   p_report_url  IN VARCHAR2
882 )
883 RETURN CLOB;
884 
885 FUNCTION checkSWANEnabled
886 RETURN BOOLEAN;
887 
888 END BIS_UTILITIES_PVT;