DBA Data[Home] [Help]

PACKAGE: APPS.XLA_AE_HEADER_PKG

Source


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