1 PACKAGE IGC_MSGS_PKG AUTHID CURRENT_USER AS
2 /* $Header: IGCBMSGS.pls 120.3.12000000.1 2007/08/20 12:10:16 mbremkum ship $ */
3
4 -- --------------------------------------------------------------
5 -- Global declarations to be defined for other packages to
6 -- have access to.
7 -- --------------------------------------------------------------
8
9 -- --------------------------------------------------------------
10 -- TokNameArray contains names of all message tokens
11 -- --------------------------------------------------------------
12 TYPE g_TokNameArray IS TABLE OF VARCHAR2(100) INDEX BY BINARY_INTEGER;
13
14 -- --------------------------------------------------------------
15 -- TokValArray contains values for all tokens
16 -- --------------------------------------------------------------
17 TYPE g_TokValArray IS TABLE OF VARCHAR2(1000) INDEX BY BINARY_INTEGER;
18
19 -- --------------------------------------------------------------
20 -- Message Token Name
21 -- --------------------------------------------------------------
22 g_msg_tok_names g_TokNameArray;
23
24 -- --------------------------------------------------------------
25 -- Message Token Value
26 -- --------------------------------------------------------------
27 g_msg_tok_val g_TokValArray;
28
29 -- --------------------------------------------------------------
30 -- Number of tokens added into message.
31 -- --------------------------------------------------------------
32 g_no_msg_tokens NUMBER := 0;
33
34 -- --------------------------------------------------------------
35 -- Debug global variables.
36 -- --------------------------------------------------------------
37 g_debug_mode BOOLEAN := FALSE;
38
39 --
40 -- Procedure definitions for the package defined below. These are
41
42 -- Procedure that adds the appropriate message to the Token array that will be added
43 -- to the error stack so that the user can see any messages generated from the process
44 -- being run.
45 --
46 -- Parameters :
47 --
48 -- p_tokname ==> Token name of the error message
49 -- p_tokval ==> Value of the token to be added.
50 --
51
52 PROCEDURE message_token(
53 p_tokname IN VARCHAR2,
54 p_tokval IN VARCHAR2
55 );
56
57
58 --
59 -- Procedure that sets/adds the appropriate message to the error stack so that the
60 -- user can see any messages generated from the process being run.
61 --
62 -- Parameters :
63 --
64 -- p_appname ==> Application name used for message
65 -- p_msgname ==> Message to be added onto message stack
66 --
67
68 PROCEDURE add_message(
69 p_appname IN VARCHAR2,
70 p_msgname IN VARCHAR2
71 );
72
73 --
74 -- Procedure that outputs debug message to debug file that has been initialized and
75 -- created.
76 --
77 -- NOTE : Initialize_Debug procedure is not public since the Put_Debug_Msg calls the
78 -- Initialize_Debug procedure if things have not previously been setup. All
79 -- global references should be done within the one procedure not from outside
80 -- callers.
81 --
82 -- Parameters :
83 --
84 -- p_debug_message ==> Message to be output to debug file.
85 -- p_profile_log_name ==> Profile option used to get directory location for debug
86 -- p_prod ==> Product string (IGC, GMS, etc.)
87 -- p_sub_comp ==> Sub Component name to the product (CC, CBC, etc.)
88 -- p_filename_val ==> Filename to be used for debug. If null then name is built here.
89 -- x_Return_Status ==> Status of procedure returned to caller
90 --
91
92 PROCEDURE Put_Debug_Msg (
93 p_debug_message IN VARCHAR2,
94 p_profile_log_name IN VARCHAR2,
95 p_prod IN VARCHAR2,
96 p_sub_comp IN VARCHAR2,
97 p_filename_val IN VARCHAR2 := NULL,
98 x_Return_Status OUT NOCOPY VARCHAR2
99 );
100
101
102 END IGC_MSGS_PKG;
103
[Home] [Help]