1 package wip_logger AUTHID CURRENT_USER as
2 /* $Header: wipflogs.pls 115.13 2003/05/29 01:13:52 kmreddy ship $ */
3
4 --This package logs messages by using the fnd log package. It formats
5 --the strings for consistency and ease of use.
6
7
8 --These types are used to pass an arbitrarily long parameter list to
9 --entryPoint.
10 type param_rec_t is record(paramName VARCHAR2(255), paramValue VARCHAR2(255));
11 type param_tbl_t is table of param_rec_t index by binary_integer;
12
13 --log an arbitrary message.
14 procedure log(p_msg IN VARCHAR2,
15 x_returnStatus out NOCOPY VARCHAR2);
16
17 --Record an entrance to a procedure. This procedure will log the procedure name and
18 --parameter values in an structured fashion. Every entryPoint() should have a matching
19 --exitPoint(), even if an exception occurs. Messages are logged only if the message level
20 --parameter is 1 or greater
21 procedure entryPoint(p_procName IN VARCHAR2,
22 p_params IN param_tbl_t,
23 x_returnStatus out NOCOPY VARCHAR2);
24
25 --Record an exit to a procedure. This procedure will log the procedure as being exited. It
26 --should be used in conjunction with entryPoint(). Messages will only be logged if the message
27 --level is 1 or greater.
28 procedure exitPoint(p_procName IN VARCHAR2,
29 p_procReturnStatus IN VARCHAR2,
30 p_msg IN VARCHAR2,
31 x_returnStatus out NOCOPY VARCHAR2);
32
33 --Resets package globals. Should be called after a flow is complete for formatting
34 --purposes, but is not required.
35 procedure cleanUp(x_returnStatus out NOCOPY VARCHAR2);
36 end wip_logger;