DBA Data[Home] [Help]

PACKAGE: SYS.DBMS_WARNING

Source


1 PACKAGE     dbms_warning AUTHID CURRENT_USER AS
2 
3   /*
4    * For the following functions, meanings of parameters are:
5    *
6    * 1. warning_category - one of:
7    *    - 'ALL'
8    *    - 'INFORMATIONAL'
9    *    - 'SEVERE'
10    *    - 'PERFORMANCE'
11    *
12    * 2. warning_value - one of:
13    *    - 'ENABLE'
14    *    - 'DISABLE'
15    *    - 'ERROR'
16    *
17    * 3. scope - one of:
18    *    - 'SYSTEM'
19    *    - 'SESSION'
20    *
21    * 4. warning_number - any valid warning number
22    */
23 
24   --
25   -- This API changes the warning_category to warning value without affecting
26   -- other independent categories.
27   --
28   PROCEDURE add_warning_setting_cat(warning_category IN VARCHAR2,
29                                     warning_value    IN VARCHAR2,
30                                     scope            IN VARCHAR2);
31 
32   --
33   -- This API changes the warning_number to warning value without affecting
34   -- other existing settings.
35   --
36   PROCEDURE add_warning_setting_num(warning_number IN PLS_INTEGER,
37                                     warning_value  IN VARCHAR2,
38                                     scope          IN VARCHAR2);
39 
40   --
41   -- This API returns the session warning_value for a given warning_category
42   -- If any of parameter values are incorrect or, if the function was
43   -- unsuccessful 'INVALID' is returned, the session warning_value is
44   -- returned on successful completion.
45   --
46   FUNCTION get_warning_setting_cat(warning_category IN VARCHAR2)
47                                    RETURN VARCHAR2;
48 
49   --
50   -- This API returns the session warning_value for a given warning_number
51   -- If any of parameter values are incorrect or, if the function was
52   -- unsuccessful 'INVALID' is returned, the session warning_value is
53   -- returned on successful completion.
54   --
55   FUNCTION get_warning_setting_num(warning_number IN PLS_INTEGER)
56                                    RETURN VARCHAR2;
57 
58   --
59   -- This API returns the entire warning setting string for the current
60   -- session
61   --
62   FUNCTION get_warning_setting_string RETURN VARCHAR2;
63 
64   --
65   -- This API sets the entire warning string, replacing the old values.
66   -- It can set the value for the SESSION or for SYSTEM depending on the
67   -- value of the scope parameter.
68   --
69   PROCEDURE set_warning_setting_string(VALUE IN VARCHAR2, scope IN VARCHAR2);
70 
71   --
72   -- This API returns the warning category name for the given warning number
73   --
74   FUNCTION get_category(warning_number IN  PLS_INTEGER) RETURN VARCHAR2;
75 
76 END dbms_warning;