1 PACKAGE OE_MSG AUTHID CURRENT_USER AS
2 /* $Header: OEXUTMGS.pls 115.0 99/07/16 08:16:45 porting ship $ */
3
4 ---------------------- Define Date Type -----------------------------
5 TYPE MESSAGE_TABLE_TYPE IS TABLE of VARCHAR2(255)
6 Index By BINARY_INTEGER;
7
8 TYPE TOKEN_COUNT_TABLE_TYPE IS TABLE of NUMBER
9 Index By BINARY_INTEGER;
10
11
12 ---------------------- Global Variable ----------------------
13 OE_Msg_Message_Name_Buffer MESSAGE_TABLE_TYPE; -- Message stactk
14 OE_Msg_Token_Name_Buffer MESSAGE_TABLE_TYPE; -- Message stactk
15 OE_Msg_Token_Value_Buffer MESSAGE_TABLE_TYPE; -- Message stactk
16 OE_Msg_Token_Count TOKEN_COUNT_TABLE_TYPE ; --Count Token number for
17 --each message
18 OE_Debug_Info_Buffer VARCHAR2(1000); -- Debug information
19
20 OE_Msg_Last_Msg_Count NUMBER :=0;
21 OE_Msg_Last_Token_Count NUMBER :=0;
22 OE_Msg_Show_Msg_Count NUMBER :=0;
23 OE_Msg_Show_Token_Count NUMBER :=1;
24 OE_Debug_Index NUMBER :=0;
25
26 --------------------- GLOBAL Function Specifications -----------------------
27
28 ---------------------------------------------------------------------------
29 --Module Name : OEXUTMGS.pls and OEXUTMGB.pls
30 --Package Name : OE_MSG
31 --Function Name : Set_Buffer_Message
32 --Parameters : MSG_NAME IN VARCHAR2 --Message Name
33 -- : TOKEN_NAME IN VARCHAR2 --Token Name
34 -- : TOKEN_VALUE IN VARCHAR2 --Token Value
35 --Return Value : Boolean value.
36 -- TRUE - Successfaul
37 -- FALSE - Fail
38 --Requirement : 1.Message name can't be NULL
39 -- 2.One message can't have more than 10 tokens.
40 -- 3.Can't put more than 100 messages in the table without issue
41 -- them.
42 --Description : This function will add the message name to message name table if
43 -- the input message name is different from the last messgae name of
44 -- message name table. Also, if the token name is not NULL, added
45 -- token name and token value to the token table.
46 -------------------------------------------------------------------------------
47 function Set_Buffer_Message(
48 MSG_NAME IN VARCHAR2 DEFAULT NULL
49 , TOKEN_NAME IN VARCHAR2 DEFAULT NULL
50 , TOKEN_VALUE IN VARCHAR2 DEFAULT NULL
51 )
52 return BOOLEAN;
53
54
55 --
56 -- NAME
57 -- Set_Buffer_Message
58 --
59 -- DESCRIPTION
60 -- Procedure version of function Set_Buffer_Message
61 -- (See FUNCTION Set_Buffer_Message)
62 --
63 PROCEDURE Set_Buffer_Message(Msg_Name IN VARCHAR2,
64 Token_Name IN VARCHAR2 Default NULL,
65 Token_Value IN VARCHAR2 Default NULL);
66
67 --
68 -- NAME
69 -- Internal_Exception
70 --
71 -- ARGUMENTS
72 -- Routine The name of the routine where the internal
73 -- execetion occured. (Use the PACKAGE.Routine
74 -- convention.)
75 -- Operation Name of the operation.
76 -- Object Name of the exception object.
77 -- Message Any additional message can be optional
78 -- included as part of the message to the user.
79 -- Message is not translated.
80 -- DESCRIPTION
81 -- Used to report internal exceptions from server plsql.
82 -- This sets a message to be displayed with the following
83 -- information: Routine, Operation, Object, last encountered
84 -- sql error (if any) and optionally Message.
85 --
86 PROCEDURE Internal_Exception(Routine VARCHAR2,
87 Operation VARCHAR2,
88 Object VARCHAR2,
89 Message VARCHAR2 Default NULL);
90
91 -----------------------Local function specification ----------------------
92 function Set_Message_Name(
93 MSG_NAME IN VARCHAR2 DEFAULT NULL
94 )
95 return BOOLEAN;
96
97
98 procedure Get_Message_Name(
99 MSG_NAME OUT VARCHAR2
100 , LAST_MESSAGE OUT NUMBER
101 );
102
103 procedure Get_Buffer_Message(
104 TOKEN_NAME OUT VARCHAR2
105 , TOKEN_VALUE OUT VARCHAR2
106 , LAST_TOKEN IN OUT NUMBER
107 );
108
109 function Get_Last_Token_Of_This_Msg
110 return NUMBER;
111
112 procedure Clean_Buffer_Message;
113
114
115 procedure Set_Debug_Info(
116 Debug_Info IN VARCHAR2 DEFAULT NULL
117 );
118
119 procedure Get_Debug_Info(
120 Debug_Info OUT VARCHAR2
121 );
122
123 procedure Clean_Debug_Info;
124
125 END OE_MSG;
[Home] [Help]