DBA Data[Home] [Help]

PACKAGE: APPS.XLA_AE_HEADER_PKG

Source


1 PACKAGE xla_ae_header_pkg AS
2 /* $Header: xlajehdr.pkh 120.20.12010000.1 2008/07/29 10:05:13 appldev ship $   */
3 /*===========================================================================+
4 |             Copyright (c) 2001-2002 Oracle Corporation                     |
5 |                       Redwood Shores, CA, USA                              |
6 |                         All rights reserved.                               |
7 +============================================================================+
8 | PACKAGE NAME                                                               |
9 |     xla_ae_header_pkg                                                      |
10 |                                                                            |
11 | DESCRIPTION                                                                |
12 |                                                                            |
13 |                                                                            |
14 | HISTORY                                                                    |
15 |     20-NOV-2002 K.Boussema    Created                                      |
16 |     10-JAN-2003 K.Boussema    Added 'dbdrv' command                        |
17 |     10-MAR-2003 K.Boussema    Made changes for the new bulk approach of the|
18 |                               accounting engine                            |
19 |     03-APR-2003 K.Boussema    Included Analytical criteria feature         |
20 |     19-APR-2003 K.Boussema    Included Error messages                      |
21 |     22-APR-2003 K.Boussema    Added DOC_CATEGORY_NAME source               |
22 |     11-JUN-2003 K.Boussema    Renamed Sequence columns, bug 3000007        |
23 |     17-JUL-2003 K.Boussema    Reviewd the code                             |
24 |     17-SEP-2003 K.Boussema    Updated to Get je_category from cache:3109690|
25 |     19-SEP-2003 K.Boussema    Code changed to include reversed_ae_header_id|
26 |                               and reversed_line_num, see bug 3143095       |
27 |     12-DEC-2003 K.Boussema    Reviewed for bug bug 3042840                 |
28 |     18-DEC-2003 K.Boussema    Changed to fix bug 3042840,3307761,3268940   |
29 |                               3310291 and 3320689                          |
30 |     17-May-2004 W.Shen        add gl_transfer_flag, gl_date,               |
31 |                               and trx_acct_reversal_option to t_rec_header |
32 |                               This is for attribute enhancement project    |
33 |                               add transactionreversal procedure from       |
34 |                               xla_ae_lines_pkg                             |
35 |     21-Sep-2004 S.Singhania   Made ffg changes for the Bulk Performance:   |
36 |                                 -- Obsoleted structure t_rec_header        |
37 |                                 -- Obsoleted SetHeaderId, GetHeaderId,     |
38 |                                    SetHdrAccountingSource (all of three),  |
39 |                                    and TransactionReversal.                |
40 |                                 -- Added strucntures t_rec_header_new and  |
41 |                                    t_rec_acct_attrs                        |
42 |                                 -- Added routine SetHdrAcctAttrs.          |
43 |     11-Jul-2005 A.Wan         Changed for MPA.  4262811                    |
44 |     18-Oct-2005 V. Kumar    Removed code for Analytical Criteria           |
45 |     20-JAN-2006 A.Wan       4884853 add GetAccrualRevDate                  |
46 |     15-Apr-2006 A.Wan       5132302 applied to amt for Gain/Loss           |
47 +===========================================================================*/
48 
49 --
50 --+==========================================================================+
51 --|                                                                          |
52 --|                                                                          |
53 --| PUBLIC structures                                                        |
54 --|                                                                          |
55 --|                                                                          |
56 --+==========================================================================+
57 --
58 TYPE t_array_number   IS TABLE OF NUMBER         INDEX BY BINARY_INTEGER;
59 TYPE t_array_integer  IS TABLE OF INTEGER        INDEX BY BINARY_INTEGER;
60 TYPE t_array_date     IS TABLE OF DATE           INDEX BY BINARY_INTEGER;
61 TYPE t_array_char1    IS TABLE OF VARCHAR2(1)    INDEX BY BINARY_INTEGER;
62 TYPE t_array_char30   IS TABLE OF VARCHAR2(30)   INDEX BY BINARY_INTEGER;
63 TYPE t_array_char240  IS TABLE OF VARCHAR2(240)  INDEX BY BINARY_INTEGER;
64 TYPE t_array_char2000 IS TABLE OF VARCHAR2(2000) INDEX BY BINARY_INTEGER;
65 --
66 TYPE t_rec_acct_attrs IS RECORD
67    (array_acct_attr_code        t_array_char30
68    ,array_num_value             t_array_number
69    ,array_char_value            t_array_char2000
70    ,array_date_value            t_array_date);
71 
72 
73 --
74 TYPE t_rec_header_new IS RECORD
75 (
76 --
77 array_event_type_code             t_array_char30,
78 array_event_id                    t_array_number,
79 array_event_number                t_array_number,
80 array_entity_id                   t_array_number,
81 array_target_ledger_id            t_array_number,
82 --
83 array_actual_header_id             t_array_number,
84 array_budget_header_id             t_array_number,
85 array_encumb_header_id             t_array_number,
86 --
87 array_je_category_name             t_array_char30,
88 array_period_name                  t_array_char30,
89 --
90 array_description                  t_array_char2000,
91 --
92 array_doc_sequence_id              t_array_number,
93 array_doc_sequence_value           t_array_number,
94 array_doc_category_code            t_array_char30,
95 array_budget_version_id            t_array_number,
96 -- array_encumbrance_type_id       t_array_number, -- 4458381 Public Sector Enh
97 --
98 array_actual_status                t_array_integer,
99 array_budget_status                t_array_integer,
100 array_encumbrance_status           t_array_integer,
101 array_event_status                 t_array_char1,
102 --
103 array_party_change_option          t_array_char1,
104 array_party_change_type            t_array_char1,
105 array_new_party_id                 t_array_number,
106 array_new_party_site_id            t_array_number,
107 array_previous_party_id            t_array_number,
108 array_previous_party_site_id       t_array_number,
109 array_gl_transfer_flag             t_array_char1,
110 array_trx_acct_reversal_option     t_array_char1,
111 array_gl_date                      t_array_date,
112 --
113 array_header_num                   t_array_number,  -- 4262811
114 array_accrual_reversal_flag        t_array_char1,   -- 4262811
115 array_acc_rev_gl_date_option       t_array_char30,  -- 4262811
116 array_parent_header_id             t_array_number,  -- 4262811
117 array_parent_line_num              t_array_number,  -- 4262811
118 --
119 array_anc_id_1                     t_array_char240,
120 array_anc_id_2                     t_array_char240,
121 array_anc_id_3                     t_array_char240,
122 array_anc_id_4                     t_array_char240,
123 array_anc_id_5                     t_array_char240,
124 array_anc_id_6                     t_array_char240,
125 array_anc_id_7                     t_array_char240,
126 array_anc_id_8                     t_array_char240,
127 array_anc_id_9                     t_array_char240,
128 array_anc_id_10                    t_array_char240,
129 array_anc_id_11                    t_array_char240,
130 array_anc_id_12                    t_array_char240,
131 array_anc_id_13                    t_array_char240,
132 array_anc_id_14                    t_array_char240,
133 array_anc_id_15                    t_array_char240,
134 array_anc_id_16                    t_array_char240,
135 array_anc_id_17                    t_array_char240,
136 array_anc_id_18                    t_array_char240,
137 array_anc_id_19                    t_array_char240,
138 array_anc_id_20                    t_array_char240,
139 array_anc_id_21                    t_array_char240,
140 array_anc_id_22                    t_array_char240,
141 array_anc_id_23                    t_array_char240,
142 array_anc_id_24                    t_array_char240,
143 array_anc_id_25                    t_array_char240,
144 array_anc_id_26                    t_array_char240,
145 array_anc_id_27                    t_array_char240,
146 array_anc_id_28                    t_array_char240,
147 array_anc_id_29                    t_array_char240,
148 array_anc_id_30                    t_array_char240,
149 array_anc_id_31                    t_array_char240,
150 array_anc_id_32                    t_array_char240,
151 array_anc_id_33                    t_array_char240,
152 array_anc_id_34                    t_array_char240,
153 array_anc_id_35                    t_array_char240,
154 array_anc_id_36                    t_array_char240,
155 array_anc_id_37                    t_array_char240,
156 array_anc_id_38                    t_array_char240,
157 array_anc_id_39                    t_array_char240,
158 array_anc_id_40                    t_array_char240,
159 array_anc_id_41                    t_array_char240,
160 array_anc_id_42                    t_array_char240,
161 array_anc_id_43                    t_array_char240,
162 array_anc_id_44                    t_array_char240,
163 array_anc_id_45                    t_array_char240,
164 array_anc_id_46                    t_array_char240,
165 array_anc_id_47                    t_array_char240,
166 array_anc_id_48                    t_array_char240,
167 array_anc_id_49                    t_array_char240,
168 array_anc_id_50                    t_array_char240,
169 array_anc_id_51                    t_array_char240,
170 array_anc_id_52                    t_array_char240,
171 array_anc_id_53                    t_array_char240,
172 array_anc_id_54                    t_array_char240,
173 array_anc_id_55                    t_array_char240,
174 array_anc_id_56                    t_array_char240,
175 array_anc_id_57                    t_array_char240,
176 array_anc_id_58                    t_array_char240,
177 array_anc_id_59                    t_array_char240,
178 array_anc_id_60                    t_array_char240,
179 array_anc_id_61                    t_array_char240,
180 array_anc_id_62                    t_array_char240,
181 array_anc_id_63                    t_array_char240,
182 array_anc_id_64                    t_array_char240,
183 array_anc_id_65                    t_array_char240,
184 array_anc_id_66                    t_array_char240,
185 array_anc_id_67                    t_array_char240,
186 array_anc_id_68                    t_array_char240,
187 array_anc_id_69                    t_array_char240,
188 array_anc_id_70                    t_array_char240,
189 array_anc_id_71                    t_array_char240,
190 array_anc_id_72                    t_array_char240,
191 array_anc_id_73                    t_array_char240,
192 array_anc_id_74                    t_array_char240,
193 array_anc_id_75                    t_array_char240,
194 array_anc_id_76                    t_array_char240,
195 array_anc_id_77                    t_array_char240,
196 array_anc_id_78                    t_array_char240,
197 array_anc_id_79                    t_array_char240,
198 array_anc_id_80                    t_array_char240,
199 array_anc_id_81                    t_array_char240,
200 array_anc_id_82                    t_array_char240,
201 array_anc_id_83                    t_array_char240,
202 array_anc_id_84                    t_array_char240,
203 array_anc_id_85                    t_array_char240,
204 array_anc_id_86                    t_array_char240,
205 array_anc_id_87                    t_array_char240,
206 array_anc_id_88                    t_array_char240,
207 array_anc_id_89                    t_array_char240,
208 array_anc_id_90                    t_array_char240,
209 array_anc_id_91                    t_array_char240,
210 array_anc_id_92                    t_array_char240,
211 array_anc_id_93                    t_array_char240,
212 array_anc_id_94                    t_array_char240,
213 array_anc_id_95                    t_array_char240,
214 array_anc_id_96                    t_array_char240,
215 array_anc_id_97                    t_array_char240,
216 array_anc_id_98                    t_array_char240,
217 array_anc_id_99                    t_array_char240,
218 array_anc_id_100                   t_array_char240
219 );
220 --
221 --
222 /*======================================================================+
223 |                                                                       |
224 |  Variable Global                                                      |
225 |                                                                       |
226 +======================================================================*/
227 --
228 g_rec_header_new         t_rec_header_new;
229 g_header_idx             number;
230 g_mpa_line_num           number;   -- 4262811
231 --
232 /*======================================================================+
233 |                                                                       |
234 | Public Procedure                                                      |
235 |                                                                       |
236 |                                                                       |
237 +======================================================================*/
238 PROCEDURE InitHeader
239        (p_header_idx       in number);
240 --
241 
242 /*======================================================================+
243 |                                                                       |
244 | Public Procedure - 4884853                                            |
245 |                                                                       |
246 |                                                                       |
247 +======================================================================*/
248 PROCEDURE GetAccrualRevDate(
249   p_hdr_idx           IN NUMBER
250 , p_ledger_id         IN NUMBER
251 , p_gl_date           IN DATE
252 , p_gl_date_option    IN VARCHAR2
253 );
254 
255 /*======================================================================+
256 |                                                                       |
257 | Public Procedure - 4262811                                            |
258 |                                                                       |
259 |                                                                       |
260 +======================================================================*/
261 PROCEDURE GetRecognitionEntriesInfo(
262   p_ledger_id            IN NUMBER
263 , p_start_date           IN DATE
264 , p_end_date             IN DATE
265 , p_gl_date_option       IN VARCHAR2
266 , p_num_entries_option   IN VARCHAR2
267 , p_proration_code       IN VARCHAR2
268 , p_calculate_acctd_flag IN VARCHAR2  -- 4262811b
269 , p_same_currency        IN BOOLEAN   -- 4262811b
270 , p_accted_amt           IN NUMBER
271 , p_entered_amt          IN NUMBER
272 , p_bflow_applied_to_amt  IN NUMBER                                           -- 5132302
273 , x_num_entries          IN OUT NOCOPY NUMBER
277 , x_period_names         IN OUT NOCOPY xla_ae_journal_entry_pkg.t_array_V15L
274 , x_gl_dates             IN OUT NOCOPY xla_ae_journal_entry_pkg.t_array_date
275 , x_accted_amts          IN OUT NOCOPY xla_ae_journal_entry_pkg.t_array_num
276 , x_entered_amts         IN OUT NOCOPY xla_ae_journal_entry_pkg.t_array_num
278 , x_bflow_applied_to_amts  IN OUT NOCOPY xla_ae_journal_entry_pkg.t_array_num  -- 5132302
279 );
280 
281 
282 /*======================================================================+
283 |                                                                       |
284 | Public Procedure - 4262811                                            |
285 |                                                                       |
286 |                                                                       |
287 +======================================================================*/
288 PROCEDURE CopyHeaderInfo(
289    p_parent_hdr_idx   IN NUMBER
290  , p_hdr_idx          IN NUMBER
291 );
292 
293 /*======================================================================+
294 |                                                                       |
295 | Public  Procedure - 4262811                                           |
296 |                                                                       |
297 |                                                                       |
298 +======================================================================*/
299 FUNCTION CreateRecognitionEntries(
300   p_event_id           IN INTEGER
301 , p_num_entries        IN INTEGER
302 , p_last_hdr_idx       IN INTEGER
303 , p_recog_line_num_1   IN INTEGER
304 , p_recog_line_num_2   IN INTEGER
305 , p_gl_dates           IN xla_ae_journal_entry_pkg.t_array_date
306 , p_accted_amts        IN xla_ae_journal_entry_pkg.t_array_num
307 , p_entered_amts       IN xla_ae_journal_entry_pkg.t_array_num
308 , p_bflow_applied_to_amts   IN xla_ae_journal_entry_pkg.t_array_num  -- 5132302
309 ) RETURN NUMBER;
310 
311 
312 /*======================================================================+
313 |                                                                       |
314 | Public Procedure                                                      |
315 |                                                                       |
316 |                                                                       |
317 +======================================================================*/
318 --
319 -- This might not be required with bulk performance changes
320 --
321 /*
322 PROCEDURE SetHeaderId( p_ae_header_id        IN NUMBER
323                      , p_actual_flag         IN VARCHAR2
324                      , p_budget_flag         IN VARCHAR2
325                      , p_encumbrance_flag    IN VARCHAR2
326                      )
327 ;
328 */
329 --
330 /*======================================================================+
331 |                                                                       |
332 | Public Procedure                                                      |
333 |                                                                       |
334 |                                                                       |
335 +======================================================================*/
336 PROCEDURE SetHdrDescription(
337  p_description         IN VARCHAR2
338 )
339 ;
340 --
341 /*======================================================================+
342 |                                                                       |
343 | Public Procedure                                                      |
344 |                                                                       |
345 |                                                                       |
346 +======================================================================*/
347 /*
348 PROCEDURE SetHdrAccountingSource (
349   p_accounting_source      IN VARCHAR2
350 , p_standard_source        IN VARCHAR2
351 , p_source_code            IN VARCHAR2
352 , p_source_type_code       IN VARCHAR2
353 , p_source_application_id  IN NUMBER
354 )
355 ;
356 */
357 --
358 /*======================================================================+
359 |                                                                       |
360 | Public Procedure                                                      |
361 |                                                                       |
362 |                                                                       |
363 +======================================================================*/
364 /*
365 PROCEDURE SetHdrAccountingSource (
366   p_accounting_source      IN VARCHAR2
367 , p_standard_source        IN NUMBER
368 , p_source_code            IN VARCHAR2
369 , p_source_type_code       IN VARCHAR2
370 , p_source_application_id  IN NUMBER
371 )
372 ;
373 */
374 --
375 /*======================================================================+
376 |                                                                       |
377 | Public Procedure                                                      |
378 |                                                                       |
379 |                                                                       |
380 +======================================================================*/
381 /*
382 PROCEDURE SetHdrAccountingSource (
383   p_accounting_source      IN VARCHAR2
384 , p_standard_source        IN DATE
385 , p_source_code            IN VARCHAR2
389 ;
386 , p_source_type_code       IN VARCHAR2
387 , p_source_application_id  IN NUMBER
388 )
390 */
391 --
392 --
393 /*======================================================================+
394 |                                                                       |
395 | Public Procedure                                                      |
396 |                                                                       |
397 |                                                                       |
398 +======================================================================*/
399 PROCEDURE SetJeCategoryName
400 ;
401 --
402 --
403 /*======================================================================+
404 |                                                                       |
405 | Public Function                                                       |
406 |                                                                       |
407 |   SetAnalyticalCriteria                                               |
408 |                                                                       |
409 +======================================================================*/
410 --
411 FUNCTION SetAnalyticalCriteria(
412   p_analytical_criterion_name    IN VARCHAR2
413 , p_analytical_criterion_owner   IN VARCHAR2
414 , p_analytical_criterion_code    IN VARCHAR2
415 , p_amb_context_code             IN VARCHAR2
416 , p_balancing_flag               IN VARCHAR2
417 , p_analytical_detail_char_1     IN VARCHAR2 DEFAULT NULL
418 , p_analytical_detail_num_1      IN NUMBER   DEFAULT NULL
419 , p_analytical_detail_date_1     IN DATE     DEFAULT NULL
420 , p_analytical_detail_char_2     IN VARCHAR2 DEFAULT NULL
421 , p_analytical_detail_num_2      IN NUMBER   DEFAULT NULL
422 , p_analytical_detail_date_2     IN DATE     DEFAULT NULL
423 , p_analytical_detail_char_3     IN VARCHAR2 DEFAULT NULL
424 , p_analytical_detail_num_3      IN NUMBER   DEFAULT NULL
425 , p_analytical_detail_date_3     IN DATE     DEFAULT NULL
426 , p_analytical_detail_char_4     IN VARCHAR2 DEFAULT NULL
427 , p_analytical_detail_num_4      IN NUMBER   DEFAULT NULL
428 , p_analytical_detail_date_4     IN DATE     DEFAULT NULL
429 , p_analytical_detail_char_5     IN VARCHAR2 DEFAULT NULL
430 , p_analytical_detail_num_5      IN NUMBER   DEFAULT NULL
431 , p_analytical_detail_date_5     IN DATE     DEFAULT NULL
432 --
433 )
434 RETURN VARCHAR2
435 ;
436 
437 /*======================================================================+
438 |                                                                       |
439 | Public Procedure                                                      |
440 |                                                                       |
441 |                                                                       |
442 +======================================================================*/
443 --
444 /*
445 FUNCTION  GetHeaderId(p_balance_type_code IN VARCHAR2)
446 RETURN NUMBER
447 ;
448 */
449 --
450 /*======================================================================+
451 |                                                                       |
452 | Public Procedure                                                      |
453 |                                                                       |
454 |                                                                       |
455 +======================================================================*/
456 FUNCTION InsertHeaders
457 RETURN BOOLEAN
458 ;
459 --
460 --
461 /*======================================================================+
462 |                                                                       |
463 | Public Procedure                                                      |
464 |                                                                       |
465 |                                                                       |
466 +======================================================================*/
467 PROCEDURE change_third_party
468 ;
469 --
470 --
471 /*======================================================================+
472 |                                                                       |
473 | Public Procedure                                                      |
474 |                                                                       |
475 |                                                                       |
476 +======================================================================*/
477 PROCEDURE RefreshHeader
478 ;
479 
480 /*
481 PROCEDURE TransactionReversal
482 ;
483 */
484 --
485 -- bulk performance
486 --
487 /*======================================================================+
488 |                                                                       |
489 | Public Procedure                                                      |
490 |                                                                       |
491 |                                                                       |
492 +======================================================================*/
493 procedure SetHdrAcctAttrs
494        (p_rec_acct_attrs    in t_rec_acct_attrs);
495 --
496 /*======================================================================+
497 |                                                                       |
498 | Public Procedure                                                      |
499 |                                                                       |
500 |                                                                       |
501 +======================================================================*/
502 PROCEDURE ValidateBusinessDate
503 (p_ledger_id                      IN NUMBER);
504 
505 END xla_ae_header_pkg; -- end of package spec