1 PACKAGE CN_MESSAGE_PKG AUTHID CURRENT_USER as
2 /* $Header: cnsymsgs.pls 120.1 2005/07/06 19:00:23 appldev ship $ */
3
4 /*
5 Date Name Description
6 ----------------------------------------------------------------------------+
7 21-NOV-94 P Cook Created
8 24-MAY-95 P Cook Revised message stacking procedures in preparation for
9 testing.
10 Name
11 cn_message_pkg
12
13 Purpose
14 Allow messages (both for reporting and debugging) to be written to a
15 database table or to a stack(plsql table) by PL/SQL programs executed
16 on the server.
17 Messages can be retrieved and used in an on-line report or log file.
18
19 Notes
20 Currently the stack is unimplemented. Only one message is output back to
21 the form.
22
23 */
24
25 -- Procedure Name
26 --
27 -- Purpose
28 -- Cover routine combining set_name and set_token
29 --
30 -- Notes
31 -- Should be able to make set_name/token private leaving this one visible
32
33 PROCEDURE Set_Message( Appl_Short_Name IN VARCHAR2
34 ,Message_Name IN VARCHAR2
35 ,Token_Name1 IN VARCHAR2
36 ,Token_Value1 IN VARCHAR2
37 ,Token_Name2 IN VARCHAR2
38 ,Token_Value2 IN VARCHAR2
39 ,Token_Name3 IN VARCHAR2
40 ,Token_Value3 IN VARCHAR2
41 ,Token_Name4 IN VARCHAR2
42 ,Token_Value4 IN VARCHAR2
43 ,Translate IN BOOLEAN );
44
45 -- Name
46 -- Flush
47 --
48 -- Purpose
49 -- Flush all session messages off the stack and into the table cn_messages
50
51 PROCEDURE Flush;
52
53 -- Name
54 --
55 --
56 -- Purpose
57 --
58
59 PROCEDURE ins_audit_batch( x_parent_proc_audit_id NUMBER
60 ,x_process_audit_id IN OUT NOCOPY NUMBER
61 ,x_request_id NUMBER
62 ,x_process_type VARCHAR2);
63 --
64 -- NAME
65 -- Debug
66 --
67 -- PURPOSE
68 -- Writes a non-translated message to the output buffer only when
69 -- the value for profile option AS_DEBUG = 'Y' or is NULL.
70 --
71 PROCEDURE debug(message_text IN VARCHAR2);
72
73 --
74 -- NAME
75 -- write
76 --
77 -- PURPOSE
78 -- Writes a message to the output buffer regardless
79 -- the value for profile option AS_DEBUG
80 --
81 PROCEDURE write(p_message_text IN VARCHAR2,p_message_type IN VARCHAR2);
82
83 --
84 -- Name
85 -- Set_Name
86 --
87 -- Purpose
88 -- Puts a Message Dictionary message on the message stack.
89 -- (Same syntax as FND_MESSAGE.Set_Name)
90 --
91 PROCEDURE set_name( appl_short_name VARCHAR2 DEFAULT 'CN'
92 ,message_name VARCHAR2
93 ,indent NUMBER DEFAULT null) ;
94
95 --
96 -- Name
97 -- Set_Token
98 --
99 -- Purpose
100 -- Sets the token of the current message on the message stack.
101 -- (Same syntax as FND_MESSAGE.Set_Token
102 --
103 PROCEDURE set_token(token_name VARCHAR2,
104 token_value VARCHAR2,
105 translate BOOLEAN DEFAULT FALSE);
106 --
107 -- Name
108 -- Set_Error
109 --
110 -- Purpose
111 -- Writes the error message of the most recently encountered
112 -- Oracle Error to the output buffer.
113 --
114 -- Arguments
115 -- Routine The name of the routine where the Oracle Error
116 -- occured. (Optional)
117 -- Context Any context information relating to the error
118 -- (e.g. Customer_Id) (Optional)
119 --
120 PROCEDURE Set_Error(routine VARCHAR2 DEFAULT NULL,
121 context VARCHAR2 DEFAULT NULL);
122 --
123 -- NAME
124 -- Clear
125 --
126 -- PURPOSE
127 -- Clears the message stack and frees memory used by it.
128 --
129 PROCEDURE Clear;
130
131 --
132 -- NAME
133 -- Purge
134 --
135 -- PURPOSE
136 -- Delete messages for a given bacth id or forward from a particular date
137
138 PROCEDURE purge( x_process_audit_id NUMBER
139 ,x_creation_date DATE);
140
141 PROCEDURE begin_batch( x_parent_proc_audit_id NUMBER
142 ,x_process_audit_id IN OUT NOCOPY NUMBER
143 ,x_request_id NUMBER
144 ,x_process_type VARCHAR2
145 ,p_org_id IN NUMBER);
146
147 PROCEDURE end_batch(x_process_audit_id NUMBER);
148
149 PROCEDURE rollback_errormsg_commit (x_error_context VARCHAR2);
150
151 END CN_MESSAGE_PKG;
[Home] [Help]