1 package flm_ekanban_logger AUTHID CURRENT_USER as
2 /* $Header: flmflogs.pls 120.1 2011/12/08 18:13:58 pding noship $ */
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 --Loggging constants. They are associated with the
8 --'FND: Debug Log Level' profile
9 NO_LOGGING CONSTANT NUMBER := fnd_log.level_unexpected + 1;
10 TRACE_LOGGING CONSTANT NUMBER := fnd_log.level_procedure;
11 FULL_LOGGING CONSTANT NUMBER := fnd_log.level_statement;
12
13 --These types are used to pass an arbitrarily long parameter list to
14 --entryPoint.
15 type param_rec_t is record(paramName VARCHAR2(255), paramValue VARCHAR2(255));
16 type param_tbl_t is table of param_rec_t index by binary_integer;
17
18 --log an arbitrary message.
19 procedure log(p_logLevel IN NUMBER,
20 p_msg IN VARCHAR2,
21 x_returnStatus out NOCOPY VARCHAR2);
22
23 --Record an entrance to a procedure. This procedure will log the procedure name and
24 --parameter values in an structured fashion. Every entryPoint() should have a matching
25 --exitPoint(), even if an exception occurs. Messages are logged only if the message level
26 --parameter is 1 or greater
27 procedure entryPoint(p_logLevel IN NUMBER,
28 p_procName IN VARCHAR2,
29 p_params IN param_tbl_t,
30 x_returnStatus out NOCOPY VARCHAR2);
31
32 --Record an entrance to a procedure. This procedure will log the procedure name. Every
33 --entryPoint() should have a matching exitPoint(), even if an exception occurs. Messages are
34 --logged only if the message level parameter is 1 or greater
35 procedure entryPointNoParams(p_logLevel IN NUMBER,
36 p_procName IN VARCHAR2,
37 x_returnStatus out NOCOPY VARCHAR2);
38
39 --Record an exit to a procedure. This procedure will log the procedure as being exited. It
40 --should be used in conjunction with entryPoint(). Messages will only be logged if the message
41 --level is 1 or greater.
42 procedure exitPoint(p_logLevel IN NUMBER,
43 p_procName IN VARCHAR2,
44 p_procReturnStatus IN VARCHAR2,
45 p_msg IN VARCHAR2,
46 x_returnStatus out NOCOPY VARCHAR2);
47
48 --Resets package globals. Should be called after a flow is complete for formatting
49 --purposes, but is not required.
50 procedure cleanUp(x_returnStatus out NOCOPY VARCHAR2);
51 end flm_ekanban_logger;