[Home] [Help]
PACKAGE: APPS.XLA_EVENTS_PKG
Source
1 PACKAGE xla_events_pkg AUTHID CURRENT_USER AS
2 -- $Header: xlaevevt.pkh 120.34 2010/10/13 12:56:53 nksurana ship $
3 /*===========================================================================+
4 | Copyright (c) 2001-2002 Oracle Corporation |
5 | Redwood Shores, CA, USA |
6 | All rights reserved. |
7 +============================================================================+
8 | FILENAME |
9 | xlaevevt.pkh |
10 | |
11 | PACKAGE NAME |
12 | xla_events_pkg |
13 | |
14 | DESCRIPTION |
15 | This is a XLA private package, which contains all the APIs |
16 | required for processing accounting events. |
17 | |
18 | The public wrapper called xla_event_pub_pkg, is built based on |
19 | this package. |
20 | |
21 | Note: |
22 | - the APIs do not execute any COMMIT or ROLLBACK. |
23 | |
24 | HISTORY |
25 | 08-Feb-01 G. Gu Created |
26 | 10-Mar-01 P. Labrevois Reviewed |
27 | 17-Mar-01 P. Labrevois Added array create_event |
28 | 13-Sep-01 P. Labrevois Added 2nd array create_event |
29 | 08-Feb-02 S. Singhania Reviewed and performed major changes |
30 | 10-Feb-02 S. Singhania Made changes in APIs to handle 'Transaction |
31 | Number' (new column added in xla_entities) |
32 | 13-Feb-02 S. Singhania Made changes in APIs to handle 'Event Number' |
33 | 18-Feb-02 S. Singhania Added specification for 'Initialize' |
34 | 05-Apr-02 S. Singhania Removed the not required, redundant APIs |
35 | 19-Apr-02 S. Singhania Added seperate API to update transaction |
36 | number. |
37 | 06-May-02 S. Singhania Added "ledger_id" parameter in the bulk API |
38 | "create_entity_event" |
39 | 31-May-02 S. Singhania Renamed 'create_entity_event' API to |
40 | 'create_bulk_events' |
41 | 13-Jun-02 S. Singhania Added 'update_event_status_bulk' API to be |
42 | used by Accounting Program |
43 | 09-Sep-02 S. Singhania Modified signature of 'create_bulk_events'. |
44 | Bug # 2530796 |
45 | 08-Nov-02 S. Singhania Included specifications for 'get_entity_id' |
46 | API for 'document mode' Accounting Program |
47 | 10-Jul-03 S. Singhania Added new APIs for MANUAL events (2899700) |
48 | - UPDATE_MANUAL_EVENT |
49 | - CREATE_MANUAL_EVENT |
50 | - DELETE_PROCESSED_EVENT |
51 | 04-Sep-03 S. Singhania Added parameter p_source_application_id to the|
52 | CREATE_BULK_EVENTS API |
53 | 23-Jun-04 W. Shen New API delete_entity to delete entities |
54 | from xla_transaction_entities(bug 3316535) |
55 | 23-OCT-04 W. Shen New API to delete/update/create event in bulk |
56 | 4-Apr-05 W. Shen Add Transaction_date to create_event and |
57 | create_manual_event API |
58 | 20-Apr-05 S. Singhania Bug 4312353. Modified signature of routines in|
59 | to reflect the change in the way we handle |
60 | valuation method different from other |
61 | security columns. |
62 | 02-May-05 V. Kumar Removed function create_bulk_events, |
63 | Bug # 4323140 |
64 | 30-SEP-10 VDAMERLA Bug:9077926 Created overloaded procedures |
65 | for create_bulk_events and |
66 | update_bulk_event_statuses to pass |
67 | bulk limit value |
68 | 13-Oct-10 nksurana Bug 10152910 Created new function/API |
69 | allow_third_party_update to check if the party|
70 | site can be updated, based on Control Account.|
71 +===========================================================================*/
72
73 -------------------------------------------------------------------------------
74 -- declaring global constants
75 -------------------------------------------------------------------------------
76
77 --C_CONTEXT_EVENTAPI CONSTANT VARCHAR2(1) := 'A';
78 --C_CONTEXT_POSTING CONSTANT VARCHAR2(1) := 'P';
79 --C_CONTEXT_PURGE CONSTANT VARCHAR2(1) := 'P';
80 g_limit_event_size integer:=2000;
81 g_limit_event_status_size integer:=2000;
82
83 C_INTERNAL_UNPROCESSED CONSTANT VARCHAR2(1) := 'U';
84 C_INTERNAL_DRAFT CONSTANT VARCHAR2(1) := 'D';
85 C_INTERNAL_FINAL CONSTANT VARCHAR2(1) := 'P';
86 C_INTERNAL_ERROR CONSTANT VARCHAR2(1) := 'E';
87 C_INTERNAL_INVALID CONSTANT VARCHAR2(1) := 'I';
88
89
90 -------------------------------------------------------------------------------
91 -- Misc. routines
92 -------------------------------------------------------------------------------
93
94 PROCEDURE initialize;
95
96 -------------------------------------------------------------------------------
97 -- Event creation routines
98 -------------------------------------------------------------------------------
99
100 FUNCTION create_event
101 (p_event_source_info IN xla_events_pub_pkg.t_event_source_info
102 ,p_valuation_method IN VARCHAR2
103 ,p_event_type_code IN VARCHAR2
104 ,p_event_date IN DATE
105 ,p_event_status_code IN VARCHAR2
106 ,p_event_number IN INTEGER DEFAULT NULL
107 ,p_transaction_date IN DATE DEFAULT NULL
108 ,p_reference_info IN xla_events_pub_pkg.t_event_reference_info DEFAULT NULL
109 ,p_budgetary_control_flag IN VARCHAR2)
110 RETURN INTEGER;
111
112 FUNCTION create_manual_event
113 (p_event_source_info IN xla_events_pub_pkg.t_event_source_info
114 ,p_event_type_code IN VARCHAR2
115 ,p_event_date IN DATE
116 ,p_event_status_code IN VARCHAR2
117 ,p_process_status_code IN VARCHAR2
118 ,p_event_number IN INTEGER DEFAULT NULL
119 ,p_transaction_date IN DATE DEFAULT NULL
120 ,p_reference_info IN xla_events_pub_pkg.t_event_reference_info DEFAULT NULL
121 ,p_budgetary_control_flag IN VARCHAR2)
122 RETURN INTEGER;
123
124 PROCEDURE create_bulk_events
125 (p_source_application_id IN INTEGER DEFAULT NULL
126 ,p_application_id IN INTEGER
127 ,p_legal_entity_id IN INTEGER DEFAULT NULL
128 ,p_ledger_id IN INTEGER
129 ,p_entity_type_code IN VARCHAR2);
130
131
132 PROCEDURE create_bulk_events
133 (p_source_application_id IN INTEGER DEFAULT NULL
134 ,p_application_id IN INTEGER
135 ,p_legal_entity_id IN INTEGER DEFAULT NULL
136 ,p_ledger_id IN INTEGER
137 ,p_entity_type_code IN VARCHAR2
138 ,p_limit_size IN INTEGER);
139
140 -------------------------------------------------------------------------------
141 -- Event updation routines
142 -------------------------------------------------------------------------------
143
144 PROCEDURE update_event_status
145 (p_event_source_info IN xla_events_pub_pkg.t_event_source_info
146 ,p_valuation_method IN VARCHAR2
147 ,p_event_class_code IN VARCHAR2 DEFAULT NULL
148 ,p_event_type_code IN VARCHAR2 DEFAULT NULL
149 ,p_event_date IN DATE DEFAULT NULL
150 ,p_event_status_code IN VARCHAR2);
151
152 PROCEDURE update_event
153 (p_event_source_info IN xla_events_pub_pkg.t_event_source_info
154 ,p_valuation_method IN VARCHAR2
155 ,p_event_id IN INTEGER
156 ,p_event_type_code IN VARCHAR2 DEFAULT NULL
157 ,p_event_date IN DATE DEFAULT NULL
158 ,p_event_status_code IN VARCHAR2 DEFAULT NULL
159 ,p_transaction_date IN DATE DEFAULT NULL
160 ,p_event_number IN INTEGER DEFAULT NULL
161 ,p_reference_info IN xla_events_pub_pkg.t_event_reference_info DEFAULT NULL
162 ,p_overwrite_event_num IN VARCHAR2 DEFAULT 'N'
163 ,p_overwrite_ref_info IN VARCHAR2 DEFAULT 'N');
164
165 PROCEDURE update_manual_event
166 (p_event_source_info IN xla_events_pub_pkg.t_event_source_info
167 ,p_event_id IN INTEGER
168 ,p_event_type_code IN VARCHAR2 DEFAULT NULL
169 ,p_event_date IN DATE DEFAULT NULL
170 ,p_event_status_code IN VARCHAR2 DEFAULT NULL
171 ,p_process_status_code IN VARCHAR2 DEFAULT NULL
172 ,p_event_number IN INTEGER DEFAULT NULL
173 ,p_reference_info IN xla_events_pub_pkg.t_event_reference_info DEFAULT NULL
174 ,p_overwrite_event_num IN VARCHAR2 DEFAULT 'N'
175 ,p_overwrite_ref_info IN VARCHAR2 DEFAULT 'N');
176
177 PROCEDURE update_bulk_event_statuses
178 (p_application_id IN INTEGER);
179
180 PROCEDURE update_bulk_event_statuses
181 (p_application_id IN INTEGER
182 ,p_limit_size IN INTEGER );
183
184 -------------------------------------------------------------------------------
185 -- Event deletion routines
186 -------------------------------------------------------------------------------
187
188 PROCEDURE delete_event
189 (p_event_source_info IN xla_events_pub_pkg.t_event_source_info
190 ,p_valuation_method IN VARCHAR2
191 ,p_event_id IN INTEGER);
192
193 PROCEDURE delete_processed_event
194 (p_event_source_info IN xla_events_pub_pkg.t_event_source_info
195 ,p_event_id IN INTEGER);
196
197 FUNCTION delete_events
198 (p_event_source_info IN xla_events_pub_pkg.t_event_source_info
199 ,p_valuation_method IN VARCHAR2
200 ,p_event_class_code IN VARCHAR2 DEFAULT NULL
201 ,p_event_type_code IN VARCHAR2 DEFAULT NULL
202 ,p_event_date IN DATE DEFAULT NULL)
203 RETURN INTEGER;
204
205 -- return 1 if there is event for the entity, return 0 if success
206 FUNCTION delete_entity
207 (p_source_info IN xla_events_pub_pkg.t_event_source_info
208 ,p_valuation_method IN VARCHAR2)
209 RETURN INTEGER;
210
211 PROCEDURE delete_bulk_events
212 (p_application_id IN INTEGER);
213
214 -------------------------------------------------------------------------------
215 -- Entity purge routines
216 -------------------------------------------------------------------------------
217
218 PROCEDURE purge_entity
219 (p_event_source_info IN xla_events_pub_pkg.t_event_source_info);
220
221 -------------------------------------------------------------------------------
222 -- Event information routines
223 -------------------------------------------------------------------------------
224
225 FUNCTION get_event_info
226 (p_event_source_info IN xla_events_pub_pkg.t_event_source_info
227 ,p_valuation_method IN VARCHAR2
228 ,p_event_id IN INTEGER)
229 RETURN xla_events_pub_pkg.t_event_info;
230
231 FUNCTION get_event_status
232 (p_event_source_info IN xla_events_pub_pkg.t_event_source_info
233 ,p_valuation_method IN VARCHAR2
234 ,p_event_id IN INTEGER)
235 RETURN VARCHAR2;
236
237 FUNCTION event_exists
238 (p_event_source_info IN xla_events_pub_pkg.t_event_source_info
239 ,p_valuation_method IN VARCHAR2
240 ,p_event_class_code IN VARCHAR2 DEFAULT NULL
241 ,p_event_type_code IN VARCHAR2 DEFAULT NULL
242 ,p_event_date IN DATE DEFAULT NULL
243 ,p_event_status_code IN VARCHAR2 DEFAULT NULL
244 ,p_event_number IN INTEGER DEFAULT NULL
245 ,p_event_id IN NUMBER DEFAULT NULL) -- 8761772
246 RETURN BOOLEAN;
247
248 FUNCTION get_array_event_info
249 (p_event_source_info IN xla_events_pub_pkg.t_event_source_info
250 ,p_valuation_method IN VARCHAR2
251 ,p_event_class_code IN VARCHAR2 DEFAULT NULL
252 ,p_event_type_code IN VARCHAR2 DEFAULT NULL
253 ,p_event_date IN DATE DEFAULT NULL
254 ,p_event_status_code IN VARCHAR2 DEFAULT NULL)
255 RETURN xla_events_pub_pkg.t_array_event_info;
256
257 -------------------------------------------------------------------------------
258 -- Entity update routines
259 -------------------------------------------------------------------------------
260
261 PROCEDURE update_transaction_number
262 (p_event_source_info IN xla_events_pub_pkg.t_event_source_info
263 ,p_valuation_method IN VARCHAR2
264 ,p_transaction_number IN VARCHAR2
265 ,p_event_id IN NUMBER DEFAULT NULL); -- 8761772
266
267 -------------------------------------------------------------------------------
268 -- Control Account information routines
269 -------------------------------------------------------------------------------
270
271 FUNCTION allow_third_party_update
272 (p_event_source_info IN xla_events_pub_pkg.t_event_source_info
273 ,p_valuation_method IN VARCHAR2)
274 RETURN BOOLEAN;
275
276 -------------------------------------------------------------------------------
277 -- Entity information routines
278 -------------------------------------------------------------------------------
279
280 FUNCTION get_entity_id
281 (p_event_source_info IN xla_events_pub_pkg.t_event_source_info
282 ,p_valuation_method IN VARCHAR2
283 ,p_event_id IN NUMBER DEFAULT NULL) -- 8761772
284 RETURN INTEGER;
285
286 FUNCTION period_close
287 (p_period_name IN VARCHAR2
288 ,p_ledger_id IN NUMBER
289 ,p_mode IN VARCHAR2)
290 RETURN VARCHAR2;
294 ,p_ledger_id IN NUMBER
291
292 FUNCTION period_close
293 (p_application_id IN NUMBER
295 ,p_period_name IN VARCHAR2)
296 RETURN VARCHAR2;
297
298
299 END xla_events_pkg;