[Home] [Help]
PACKAGE: APPS.XLA_EVENTS_PKG
Source
1 PACKAGE xla_events_pkg AS
2 -- $Header: xlaevevt.pkh 120.31 2006/05/30 16:50:47 wychan 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 +===========================================================================*/
65
66 -------------------------------------------------------------------------------
67 -- declaring global constants
68 -------------------------------------------------------------------------------
69
70 --C_CONTEXT_EVENTAPI CONSTANT VARCHAR2(1) := 'A';
71 --C_CONTEXT_POSTING CONSTANT VARCHAR2(1) := 'P';
72 --C_CONTEXT_PURGE CONSTANT VARCHAR2(1) := 'P';
73
74 C_INTERNAL_UNPROCESSED CONSTANT VARCHAR2(1) := 'U';
75 C_INTERNAL_DRAFT CONSTANT VARCHAR2(1) := 'D';
76 C_INTERNAL_FINAL CONSTANT VARCHAR2(1) := 'P';
77 C_INTERNAL_ERROR CONSTANT VARCHAR2(1) := 'E';
78 C_INTERNAL_INVALID CONSTANT VARCHAR2(1) := 'I';
79
80
81 -------------------------------------------------------------------------------
82 -- Misc. routines
83 -------------------------------------------------------------------------------
84
85 PROCEDURE initialize;
86
87 -------------------------------------------------------------------------------
88 -- Event creation routines
89 -------------------------------------------------------------------------------
90
91 FUNCTION create_event
92 (p_event_source_info IN xla_events_pub_pkg.t_event_source_info
93 ,p_valuation_method IN VARCHAR2
94 ,p_event_type_code IN VARCHAR2
95 ,p_event_date IN DATE
96 ,p_event_status_code IN VARCHAR2
97 ,p_event_number IN INTEGER DEFAULT NULL
98 ,p_transaction_date IN DATE DEFAULT NULL
99 ,p_reference_info IN xla_events_pub_pkg.t_event_reference_info DEFAULT NULL
100 ,p_budgetary_control_flag IN VARCHAR2)
101 RETURN INTEGER;
102
103 FUNCTION create_manual_event
104 (p_event_source_info IN xla_events_pub_pkg.t_event_source_info
105 ,p_event_type_code IN VARCHAR2
106 ,p_event_date IN DATE
107 ,p_event_status_code IN VARCHAR2
108 ,p_process_status_code IN VARCHAR2
109 ,p_event_number IN INTEGER DEFAULT NULL
110 ,p_transaction_date IN DATE DEFAULT NULL
111 ,p_reference_info IN xla_events_pub_pkg.t_event_reference_info DEFAULT NULL
112 ,p_budgetary_control_flag IN VARCHAR2)
113 RETURN INTEGER;
114
115 PROCEDURE create_bulk_events
116 (p_source_application_id IN INTEGER DEFAULT NULL
117 ,p_application_id IN INTEGER
118 ,p_legal_entity_id IN INTEGER DEFAULT NULL
119 ,p_ledger_id IN INTEGER
120 ,p_entity_type_code IN VARCHAR2);
121
122
123 -------------------------------------------------------------------------------
124 -- Event updation routines
125 -------------------------------------------------------------------------------
126
127 PROCEDURE update_event_status
128 (p_event_source_info IN xla_events_pub_pkg.t_event_source_info
129 ,p_valuation_method IN VARCHAR2
130 ,p_event_class_code IN VARCHAR2 DEFAULT NULL
131 ,p_event_type_code IN VARCHAR2 DEFAULT NULL
132 ,p_event_date IN DATE DEFAULT NULL
133 ,p_event_status_code IN VARCHAR2);
134
135 PROCEDURE update_event
136 (p_event_source_info IN xla_events_pub_pkg.t_event_source_info
137 ,p_valuation_method IN VARCHAR2
138 ,p_event_id IN INTEGER
139 ,p_event_type_code IN VARCHAR2 DEFAULT NULL
140 ,p_event_date IN DATE DEFAULT NULL
141 ,p_event_status_code IN VARCHAR2 DEFAULT NULL
142 ,p_transaction_date IN DATE DEFAULT NULL
143 ,p_event_number IN INTEGER DEFAULT NULL
144 ,p_reference_info IN xla_events_pub_pkg.t_event_reference_info DEFAULT NULL
145 ,p_overwrite_event_num IN VARCHAR2 DEFAULT 'N'
146 ,p_overwrite_ref_info IN VARCHAR2 DEFAULT 'N');
147
148 PROCEDURE update_manual_event
149 (p_event_source_info IN xla_events_pub_pkg.t_event_source_info
150 ,p_event_id IN INTEGER
151 ,p_event_type_code IN VARCHAR2 DEFAULT NULL
152 ,p_event_date IN DATE DEFAULT NULL
153 ,p_event_status_code IN VARCHAR2 DEFAULT NULL
154 ,p_process_status_code IN VARCHAR2 DEFAULT NULL
155 ,p_event_number IN INTEGER DEFAULT NULL
156 ,p_reference_info IN xla_events_pub_pkg.t_event_reference_info DEFAULT NULL
157 ,p_overwrite_event_num IN VARCHAR2 DEFAULT 'N'
158 ,p_overwrite_ref_info IN VARCHAR2 DEFAULT 'N');
159
160 PROCEDURE update_bulk_event_statuses
161 (p_application_id IN INTEGER);
162
163 -------------------------------------------------------------------------------
164 -- Event deletion routines
165 -------------------------------------------------------------------------------
166
167 PROCEDURE delete_event
168 (p_event_source_info IN xla_events_pub_pkg.t_event_source_info
169 ,p_valuation_method IN VARCHAR2
170 ,p_event_id IN INTEGER);
171
172 PROCEDURE delete_processed_event
173 (p_event_source_info IN xla_events_pub_pkg.t_event_source_info
174 ,p_event_id IN INTEGER);
175
176 FUNCTION delete_events
177 (p_event_source_info IN xla_events_pub_pkg.t_event_source_info
178 ,p_valuation_method IN VARCHAR2
179 ,p_event_class_code IN VARCHAR2 DEFAULT NULL
180 ,p_event_type_code IN VARCHAR2 DEFAULT NULL
181 ,p_event_date IN DATE DEFAULT NULL)
182 RETURN INTEGER;
183
184 -- return 1 if there is event for the entity, return 0 if success
185 FUNCTION delete_entity
186 (p_source_info IN xla_events_pub_pkg.t_event_source_info
187 ,p_valuation_method IN VARCHAR2)
188 RETURN INTEGER;
189
190 PROCEDURE delete_bulk_events
191 (p_application_id IN INTEGER);
192
193 -------------------------------------------------------------------------------
194 -- Entity purge routines
195 -------------------------------------------------------------------------------
196
197 PROCEDURE purge_entity
198 (p_event_source_info IN xla_events_pub_pkg.t_event_source_info);
199
200 -------------------------------------------------------------------------------
201 -- Event information routines
202 -------------------------------------------------------------------------------
203
204 FUNCTION get_event_info
205 (p_event_source_info IN xla_events_pub_pkg.t_event_source_info
206 ,p_valuation_method IN VARCHAR2
207 ,p_event_id IN INTEGER)
208 RETURN xla_events_pub_pkg.t_event_info;
209
210 FUNCTION get_event_status
211 (p_event_source_info IN xla_events_pub_pkg.t_event_source_info
212 ,p_valuation_method IN VARCHAR2
213 ,p_event_id IN INTEGER)
214 RETURN VARCHAR2;
215
216 FUNCTION event_exists
217 (p_event_source_info IN xla_events_pub_pkg.t_event_source_info
218 ,p_valuation_method IN VARCHAR2
219 ,p_event_class_code IN VARCHAR2 DEFAULT NULL
220 ,p_event_type_code IN VARCHAR2 DEFAULT NULL
221 ,p_event_date IN DATE DEFAULT NULL
222 ,p_event_status_code IN VARCHAR2 DEFAULT NULL
223 ,p_event_number IN INTEGER DEFAULT NULL
224 ,p_event_id IN PLS_INTEGER DEFAULT NULL)
225 RETURN BOOLEAN;
226
227 FUNCTION get_array_event_info
228 (p_event_source_info IN xla_events_pub_pkg.t_event_source_info
229 ,p_valuation_method IN VARCHAR2
230 ,p_event_class_code IN VARCHAR2 DEFAULT NULL
231 ,p_event_type_code IN VARCHAR2 DEFAULT NULL
232 ,p_event_date IN DATE DEFAULT NULL
233 ,p_event_status_code IN VARCHAR2 DEFAULT NULL)
234 RETURN xla_events_pub_pkg.t_array_event_info;
235
236 -------------------------------------------------------------------------------
237 -- Entity update routines
238 -------------------------------------------------------------------------------
239
240 PROCEDURE update_transaction_number
241 (p_event_source_info IN xla_events_pub_pkg.t_event_source_info
242 ,p_valuation_method IN VARCHAR2
243 ,p_transaction_number IN VARCHAR2
244 ,p_event_id IN PLS_INTEGER DEFAULT NULL);
245
246 -------------------------------------------------------------------------------
247 -- Entity information routines
248 -------------------------------------------------------------------------------
249
250 FUNCTION get_entity_id
251 (p_event_source_info IN xla_events_pub_pkg.t_event_source_info
252 ,p_valuation_method IN VARCHAR2
253 ,p_event_id IN PLS_INTEGER DEFAULT NULL)
254 RETURN INTEGER;
255
256 FUNCTION period_close
257 (p_period_name IN VARCHAR2
258 ,p_ledger_id IN NUMBER
259 ,p_mode IN VARCHAR2)
260 RETURN VARCHAR2;
261
262 FUNCTION period_close
263 (p_application_id IN NUMBER
264 ,p_ledger_id IN NUMBER
265 ,p_period_name IN VARCHAR2)
266 RETURN VARCHAR2;
267
268
269 END xla_events_pkg;