[Home] [Help]
PACKAGE: APPS.EAM_ERROR_MESSAGE_PVT
Source
1 PACKAGE EAM_ERROR_MESSAGE_PVT AUTHID CURRENT_USER AS
2 /* $Header: EAMVWOES.pls 120.1 2005/05/30 10:30:06 appldev $ */
3 /***************************************************************************
4 --
5 -- Copyright (c) 2002 Oracle Corporation, Redwood Shores, CA, USA
6 -- All rights reserved.
7 --
8 -- FILENAME
9 --
10 -- EAMVWOES.pls
11 --
12 -- DESCRIPTION
13 --
14 -- Spec of package EAM_ERROR_MESSAGE_PVT
15 --
16 -- NOTES
17 --
18 -- HISTORY
19 --
20 -- 12-JUN-2002 Kenichi Nagumo Initial Creation
21 ***************************************************************************/
22
23 -- Global constant holding the package name
24
25 G_PKG_NAME CONSTANT VARCHAR2(30) := 'EAM_ERROR_MESSAGE_PVT';
26
27 G_BO_LEVEL CONSTANT NUMBER := 0;
28
29 G_WO_LEVEL CONSTANT NUMBER := 1;
30 G_OP_LEVEL CONSTANT NUMBER := 2;
31 G_OP_NETWORK_LEVEL CONSTANT NUMBER := 3;
32 G_RES_LEVEL CONSTANT NUMBER := 4;
33 G_RES_INST_LEVEL CONSTANT NUMBER := 5;
34 G_SUB_RES_LEVEL CONSTANT NUMBER := 6;
35 G_RES_USAGE_LEVEL CONSTANT NUMBER := 7;
36 G_MAT_REQ_LEVEL CONSTANT NUMBER := 8;
37 G_DIRECT_ITEMS_LEVEL CONSTANT NUMBER := 9;
38
39 G_WO_COMP_LEVEL CONSTANT NUMBER := 10;
40 G_WO_QUALITY_LEVEL CONSTANT NUMBER := 11;
41 G_METER_READING_LEVEL CONSTANT NUMBER := 12;
42 G_WO_COMP_REBUILD_LEVEL CONSTANT NUMBER := 13;
43 G_WO_COMP_MR_READ_LEVEL CONSTANT NUMBER := 14;
44 G_OP_COMP_LEVEL CONSTANT NUMBER := 15;
45 G_REQUEST_TBL_LEVEL CONSTANT NUMBER := 16;
46
47
48
49 G_STATUS_WARNING CONSTANT VARCHAR2(1) := 'W';
50 G_STATUS_UNEXPECTED CONSTANT VARCHAR2(1) := 'U';
51 G_STATUS_ERROR CONSTANT VARCHAR2(1) := 'E';
52 G_STATUS_FATAL CONSTANT VARCHAR2(1) := 'F';
53 G_STATUS_NOT_PICKED CONSTANT VARCHAR2(1) := 'N';
54
55 G_SCOPE_ALL CONSTANT VARCHAR2(1) := 'A';
56 G_SCOPE_RECORD CONSTANT VARCHAR2(1) := 'R';
57 G_SCOPE_SIBLINGS CONSTANT VARCHAR2(1) := 'S';
58 G_SCOPE_CHILDREN CONSTANT VARCHAR2(1) := 'C';
59
60 Debug_File UTL_FILE.FILE_TYPE;
61
62 -- Error record type
63 TYPE Error_Rec_Type IS RECORD
64 ( organization_id NUMBER
65 , entity_id VARCHAR2(3)
66 , message_text VARCHAR2(2000)
67 , entity_index NUMBER
68 , message_type VARCHAR2(1)
69 , bo_identifier VARCHAR2(3) := 'EAM'
70 );
71
72 TYPE Error_Tbl_Type IS TABLE OF Error_Rec_Type
73 INDEX BY BINARY_INTEGER;
74
75 TYPE Mesg_Token_Rec_Type IS RECORD
76 ( message_name VARCHAR2(30) := NULL
77 , application_id VARCHAR2(3) := NULL
78 , message_text VARCHAR2(2000) := NULL
79 , token_name VARCHAR2(30) := NULL
80 , token_value VARCHAR2(100) := NULL
81 , translate BOOLEAN := FALSE
82 , message_type VARCHAR2(1) := NULL
83 );
84
85 TYPE Mesg_Token_Tbl_Type IS TABLE OF Mesg_Token_Rec_Type
86 INDEX BY BINARY_INTEGER;
87
88 TYPE Token_Rec_Type IS RECORD
89 ( token_value VARCHAR2(100) := NULL
90 , token_name VARCHAR2(30) := NULL
91 , translate BOOLEAN := FALSE
92 );
93
94 TYPE Token_Tbl_Type IS TABLE OF Token_Rec_Type
95 INDEX BY BINARY_INTEGER;
96
97 G_MISS_TOKEN_TBL Token_Tbl_Type;
98 G_MISS_MESG_TOKEN_TBL Mesg_Token_Tbl_Type;
99
100
101 PROCEDURE Add_Message
102 ( p_mesg_text IN VARCHAR2
103 , p_entity_id IN NUMBER
104 , p_entity_index IN NUMBER
105 , p_message_type IN VARCHAR2
106 );
107
108 PROCEDURE Translate_And_Insert_Messages
109 ( p_mesg_token_tbl IN EAM_ERROR_MESSAGE_PVT.Mesg_Token_Tbl_Type
110 , p_error_level IN NUMBER
111 , p_entity_index IN NUMBER
112 , p_application_id IN VARCHAR2 := 'EAM'
113 );
114
115 PROCEDURE Add_Error_Token
116 ( p_message_name IN VARCHAR2 := NULL
117 , p_application_id IN VARCHAR2 := 'EAM'
118 , p_message_text IN VARCHAR2 := NULL
119 , x_Mesg_Token_tbl OUT NOCOPY EAM_ERROR_MESSAGE_PVT.Mesg_Token_Tbl_Type
120 , p_Mesg_Token_Tbl IN EAM_ERROR_MESSAGE_PVT.Mesg_Token_Tbl_Type := EAM_ERROR_MESSAGE_PVT.G_MISS_MESG_TOKEN_TBL
121 , p_token_tbl IN EAM_ERROR_MESSAGE_PVT.Token_Tbl_Type := EAM_ERROR_MESSAGE_PVT.G_MISS_TOKEN_TBL
122 , p_message_type IN VARCHAR2 := 'E'
123 );
124
125 PROCEDURE Log_Error
126 ( p_eam_wo_rec IN EAM_PROCESS_WO_PUB.eam_wo_rec_type
127 :=EAM_PROCESS_WO_PUB.G_MISS_EAM_WO_REC
128 , p_eam_op_tbl IN EAM_PROCESS_WO_PUB.eam_op_tbl_type
129 :=EAM_PROCESS_WO_PUB.G_MISS_EAM_OP_TBL
130 , p_eam_op_network_tbl IN EAM_PROCESS_WO_PUB.eam_op_network_tbl_type
131 :=EAM_PROCESS_WO_PUB.G_MISS_EAM_OP_NETWORK_TBL
132 , p_eam_res_tbl IN EAM_PROCESS_WO_PUB.eam_res_tbl_type
133 :=EAM_PROCESS_WO_PUB.G_MISS_EAM_RES_TBL
134 , p_eam_res_inst_tbl IN EAM_PROCESS_WO_PUB.eam_res_inst_tbl_type
135 :=EAM_PROCESS_WO_PUB.G_MISS_EAM_RES_INST_TBL
136 , p_eam_sub_res_tbl IN EAM_PROCESS_WO_PUB.eam_sub_res_tbl_type
137 :=EAM_PROCESS_WO_PUB.G_MISS_EAM_SUB_RES_TBL
138 , p_eam_res_usage_tbl IN EAM_PROCESS_WO_PUB.eam_res_usage_tbl_type
139 :=EAM_PROCESS_WO_PUB.G_MISS_EAM_RES_USAGE_TBL
140 , p_eam_mat_req_tbl IN EAM_PROCESS_WO_PUB.eam_mat_req_tbl_type
141 :=EAM_PROCESS_WO_PUB.G_MISS_EAM_MAT_REQ_TBL
142 , p_eam_direct_items_tbl IN EAM_PROCESS_WO_PUB.eam_direct_items_tbl_type
143 :=EAM_PROCESS_WO_PUB.G_MISS_EAM_DIRECT_ITEMS_TBL
144 , x_eam_wo_rec OUT NOCOPY EAM_PROCESS_WO_PUB.eam_wo_rec_type
145 , x_eam_op_tbl OUT NOCOPY EAM_PROCESS_WO_PUB.eam_op_tbl_type
146 , x_eam_op_network_tbl OUT NOCOPY EAM_PROCESS_WO_PUB.eam_op_network_tbl_type
147 , x_eam_res_tbl OUT NOCOPY EAM_PROCESS_WO_PUB.eam_res_tbl_type
148 , x_eam_res_inst_tbl OUT NOCOPY EAM_PROCESS_WO_PUB.eam_res_inst_tbl_type
149 , x_eam_sub_res_tbl OUT NOCOPY EAM_PROCESS_WO_PUB.eam_sub_res_tbl_type
150 , x_eam_res_usage_tbl OUT NOCOPY EAM_PROCESS_WO_PUB.eam_res_usage_tbl_type
151 , x_eam_mat_req_tbl OUT NOCOPY EAM_PROCESS_WO_PUB.eam_mat_req_tbl_type
152 , x_eam_direct_items_tbl OUT NOCOPY EAM_PROCESS_WO_PUB.eam_direct_items_tbl_type
153 , p_mesg_token_tbl IN EAM_ERROR_MESSAGE_PVT.Mesg_Token_Tbl_Type
154 , p_error_status IN VARCHAR2
155 , p_error_scope IN VARCHAR2 := NULL
156 , p_other_message IN VARCHAR2 := NULL
157 , p_other_mesg_appid IN VARCHAR2 := 'EAM'
158 , p_other_status IN VARCHAR2 := NULL
159 , p_other_token_tbl IN EAM_ERROR_MESSAGE_PVT.Token_Tbl_Type
160 := EAM_ERROR_MESSAGE_PVT.G_MISS_TOKEN_TBL
161 , p_error_level IN NUMBER
162 , p_entity_index IN NUMBER := 1 -- := NULL
163 );
164
165
166
167 PROCEDURE Initialize;
168
169 PROCEDURE Reset;
170
171 PROCEDURE Get_Message_List
172 ( x_message_list OUT NOCOPY EAM_ERROR_MESSAGE_PVT.Error_Tbl_Type);
173
174 PROCEDURE Get_Entity_Message
175 ( p_entity_id IN VARCHAR2
176 , x_message_list OUT NOCOPY EAM_ERROR_MESSAGE_PVT.Error_Tbl_Type
177 );
178
179 PROCEDURE Get_Entity_Message
180 ( p_entity_id IN VARCHAR2
181 , p_entity_index IN NUMBER
182 , x_message_text OUT NOCOPY VARCHAR2
183 );
184
185 PROCEDURE Delete_Message
186 ( p_entity_id IN VARCHAR2
187 , p_entity_index IN NUMBER
188 );
189
190 PROCEDURE Delete_Message
191 ( p_entity_id IN VARCHAR2
192 );
193
194 PROCEDURE Delete_Message;
195
196 PROCEDURE Get_Message
197 ( x_message_text OUT NOCOPY VARCHAR2
198 , x_entity_index OUT NOCOPY NUMBER
199 , x_entity_id OUT NOCOPY VARCHAR2
200 , x_message_type OUT NOCOPY VARCHAR2
201 );
202
203 FUNCTION Get_Message_Count RETURN NUMBER;
204
205 PROCEDURE Dump_Message_List;
206
207 PROCEDURE Open_Debug_Session
208 ( p_debug_filename IN VARCHAR2
209 , p_output_dir IN VARCHAR2
210 , p_debug_file_mode IN VARCHAR2
211 , x_return_status OUT NOCOPY VARCHAR2
212 , p_mesg_token_tbl IN EAM_ERROR_MESSAGE_PVT.Mesg_Token_Tbl_Type
213 , x_mesg_token_tbl OUT NOCOPY EAM_ERROR_MESSAGE_PVT.Mesg_Token_Tbl_Type
214 );
215
216 PROCEDURE Close_Debug_Session;
217
218 PROCEDURE Write_Debug
219 ( p_debug_message IN VARCHAR2
220 );
221
222 PROCEDURE Set_BO_Identifier(p_bo_identifier IN VARCHAR);
223
224 FUNCTION Get_BO_Identifier RETURN VARCHAR2;
225
226
227 PROCEDURE Log_Error
228 ( p_eam_wo_comp_rec IN EAM_PROCESS_WO_PUB.eam_wo_comp_rec_type
229 :=EAM_PROCESS_WO_PUB.G_MISS_EAM_COMP_WO_REC
230 , p_eam_wo_quality_tbl IN EAM_PROCESS_WO_PUB.eam_wo_quality_tbl_type
231 :=EAM_PROCESS_WO_PUB.G_MISS_EAM_WO_QUALITY_TBL
232 , p_eam_meter_reading_tbl IN EAM_PROCESS_WO_PUB.eam_meter_reading_tbl_type
233 :=EAM_PROCESS_WO_PUB.G_MISS_EAM_METER_READING_TBL
234 , p_eam_counter_prop_tbl IN EAM_PROCESS_WO_PUB.eam_counter_prop_tbl_type
235 :=EAM_PROCESS_WO_PUB.G_MISS_EAM_COUNTER_PROP_TBL
236 , p_eam_wo_comp_rebuild_tbl IN EAM_PROCESS_WO_PUB.eam_wo_comp_rebuild_tbl_type
237 :=EAM_PROCESS_WO_PUB.G_MISS_EAM_WO_COMP_REBUILD_TBL
238 , p_eam_wo_comp_mr_read_tbl IN EAM_PROCESS_WO_PUB.eam_wo_comp_mr_read_tbl_type
239 :=EAM_PROCESS_WO_PUB.G_MISS_EAM_WO_COMP_MR_READ_TBL
240 , p_eam_op_comp_tbl IN EAM_PROCESS_WO_PUB.eam_op_comp_tbl_type
241 :=EAM_PROCESS_WO_PUB.G_MISS_EAM_OP_COMP_TBL
242 , p_eam_request_tbl IN EAM_PROCESS_WO_PUB.eam_request_tbl_type
243 :=EAM_PROCESS_WO_PUB.G_MISS_EAM_REQUEST_TBL
244
245 , x_eam_wo_comp_rec OUT NOCOPY EAM_PROCESS_WO_PUB.eam_wo_comp_rec_type
246 , x_eam_wo_quality_tbl OUT NOCOPY EAM_PROCESS_WO_PUB.eam_wo_quality_tbl_type
247 , x_eam_meter_reading_tbl OUT NOCOPY EAM_PROCESS_WO_PUB.eam_meter_reading_tbl_type
248 , x_eam_counter_prop_tbl OUT NOCOPY EAM_PROCESS_WO_PUB.eam_counter_prop_tbl_type
249 , x_eam_wo_comp_rebuild_tbl OUT NOCOPY EAM_PROCESS_WO_PUB.eam_wo_comp_rebuild_tbl_type
250 , x_eam_wo_comp_mr_read_tbl OUT NOCOPY EAM_PROCESS_WO_PUB.eam_wo_comp_mr_read_tbl_type
251 , x_eam_op_comp_tbl OUT NOCOPY EAM_PROCESS_WO_PUB.eam_op_comp_tbl_type
252 , x_eam_request_tbl OUT NOCOPY EAM_PROCESS_WO_PUB.eam_request_tbl_type
253
254 , p_mesg_token_tbl IN EAM_ERROR_MESSAGE_PVT.Mesg_Token_Tbl_Type
255 , p_error_status IN VARCHAR2
256 , p_error_scope IN VARCHAR2 := NULL
257 , p_other_message IN VARCHAR2 := NULL
258 , p_other_mesg_appid IN VARCHAR2 := 'EAM'
259 , p_other_status IN VARCHAR2 := NULL
260 , p_other_token_tbl IN EAM_ERROR_MESSAGE_PVT.Token_Tbl_Type
261 := EAM_ERROR_MESSAGE_PVT.G_MISS_TOKEN_TBL
262 , p_error_level IN NUMBER
263 , p_entity_index IN NUMBER := 1 -- := NULL
264 );
265
266 END EAM_ERROR_MESSAGE_PVT;