PACKAGE: APPS.APP_EXCEPTION

Source

1 package app_exception AUTHID CURRENT_USER as
2 /* $Header: AFEXCEPS.pls 115.4 2002/12/13 02:33:10 tmorrow ship $ */
3 
4 
5 --
6 -- Package
7 --   app_exception
8 -- Purpose
9 --   Exception handling utilities
10 -- History
11 --   08/09/93	K Brodersen	Created
12 --
13 
14   --
15   -- PUBLIC VARIABLES
16   --
17 
18   -- Exceptions
19   application_exception exception;
20   record_lock_exception exception;
21 
22   -- Exception Pragmas
23   pragma exception_init(application_exception, -20001);
24   pragma exception_init(record_lock_exception,  -0054);
25 
26   --
27   -- PUBLIC FUNCTIONS
28   --
29 
30   --
31   -- Name
32   --   raise_exception
33   -- Purpose
34   --   Stores exception information and raises
35   --   app_exception.application_exception.
36   -- Arguments
37   --   exception_type		Exception type
38   --   exception_code		Exception code
39   --   exception_text		Additional context information
40   --
41   procedure raise_exception(exception_type varchar2 default null,
42                             exception_code number   default null,
43                             exception_text varchar2 default null);
44 
45   --
46   -- Name
47   --   get_exception
48   -- Purpose
49   --   Returns stored exception information.
50   -- Arguments
51   --   exception_type		Retrieved exception type
52   --   exception_code		Retrieved exception code
53   --   exception_text		Retrieved context information
54   --
55   procedure get_exception(exception_type OUT NOCOPY varchar2,
56                           exception_code OUT NOCOPY number,
57                           exception_text OUT NOCOPY varchar2);
58   pragma restrict_references(get_exception, WNDS, WNPS, RNDS);
59 
60   --
61   -- Name
62   --   get_type
63   -- Purpose
64   --   Returns stored exception type.
65   -- Arguments
66   --   *None*
67   --
68   function get_type return varchar2;
69   pragma restrict_references(get_type, WNDS, WNPS, RNDS);
70 
71   --
72   -- Name
73   --   get_code
74   -- Purpose
75   --   Returns stored exception code.
76   -- Arguments
77   --   *None*
78   --
79   function get_code return number;
80   pragma restrict_references(get_code, WNDS, WNPS, RNDS);
81 
82   --
83   -- Name
84   --   get_text
85   -- Purpose
86   --   Returns stored exception text.
87   -- Arguments
88   --   *None*
89   --
90   function get_text return varchar2;
91   pragma restrict_references(get_text, WNDS, WNPS, RNDS);
92 
93   --
94   -- Name
95   --   invalid_argument
96   -- Purpose
97   --   Display invalid argument error message and raise exception
98   -- Arguments
99   --   procname		Name  of procedure
100   --   argument		Name  of argument
101   --   value		Value of argument
102   --
103   procedure invalid_argument(procname varchar2,
104                              argument varchar2,
105                              value    varchar2);
106 
107 end app_exception;