1 PACKAGE xla_je_validation_pkg AS
2 /* $Header: xlajebal.pkh 120.19 2006/05/23 23:56:53 wychan ship $ */
3
4 -------------------------------------------------------------------------------
5 -- declaring global constants
6 -------------------------------------------------------------------------------
7
8 TYPE t_array_int IS TABLE OF INTEGER INDEX BY BINARY_INTEGER;
9 TYPE t_array_varchar IS TABLE OF VARCHAR2(30) INDEX BY BINARY_INTEGER;
10
11 -------------------------------------------------------------------------------
12 -- Public API
13 -------------------------------------------------------------------------------
14
15 --=============================================================================
16 --
17 -- Name: balance_amounts
18 -- Description: This function handle the validation and the balancing
19 -- requirement for a standard journal entry.
20 -- Result code:
21 -- 0 - Completed successfully and no error is found
22 -- 1 - Error is found in the balancing program
23 --
24 --=============================================================================
25 FUNCTION balance_amounts
26 (p_application_id IN INTEGER
27 ,p_mode IN VARCHAR2 -- 4262811
28 ,p_end_date IN DATE DEFAULT NULL -- 4262811
29 ,p_ledger_id IN INTEGER DEFAULT NULL
30 ,p_budgetary_control_mode IN VARCHAR2
31 ,p_accounting_mode IN VARCHAR2)
32 RETURN INTEGER;
33
34 --=============================================================================
35 --
36 -- Name: balance_manual_entry
37 -- Description: This function handle the validation and the balancing
38 -- requirement for a manual journal entry.
39 -- Result code:
40 -- 0 - Completed successfully and no error is found
41 -- 1 - Error is found in the balancing program
42 --
43 --=============================================================================
44 FUNCTION balance_manual_entry
45 (p_application_id IN INTEGER
46 ,p_balance_flag IN BOOLEAN DEFAULT TRUE
47 ,p_accounting_mode IN VARCHAR2
48 ,p_ledger_ids IN t_array_int
49 ,p_ae_header_ids IN t_array_int
50 ,p_end_date IN DATE -- 4262811
51 ,p_status_codes IN OUT NOCOPY t_array_varchar)
52 RETURN INTEGER;
53
54 --=============================================================================
55 --
56 -- Name: balance_tpm_entry
57 -- Description: This function handle the validation and the balancing
58 -- requirement for third party merge journal entry.
59 -- Result code:
60 -- 0 - Completed successfully and no error is found
61 -- 1 - Error is found in the balancing program
62 --
63 --=============================================================================
64 FUNCTION balance_tpm_amounts
65 (p_application_id IN INTEGER
66 ,p_ledger_id IN INTEGER
67 ,p_ledger_array IN xla_accounting_cache_pkg.t_array_ledger_id
68 ,p_accounting_mode IN VARCHAR2
69 ) RETURN INTEGER;
70
71
72 --=============================================================================
73 --
74 -- Name: validate_period
75 -- Description: Determine the period name of the gl date, and determine if
76 -- the period is an open period.
77 -- Result code:
78 -- 0 - the gl date is valid
79 -- 1 - the gl date does not belong to an open accounting period
80 -- 2 - the gl date does not belong to any accounting period of the ledger
81 --
82 --=============================================================================
83 FUNCTION validate_period
84 (p_ledger_id IN INTEGER
85 ,p_accounting_date IN DATE
86 ,p_period_name OUT NOCOPY VARCHAR2)
87 RETURN INTEGER;
88
89 --=============================================================================
90 --
91 -- Name: get_period_name
92 -- Description: Return the period name of the gl date, and the closing status
93 -- of the period.
94 --
95 --=============================================================================
96 FUNCTION get_period_name
97 (p_ledger_id IN INTEGER
98 ,p_accounting_date IN DATE
99 ,p_closing_status OUT NOCOPY VARCHAR2
100 ,p_period_type OUT NOCOPY VARCHAR2)
101 RETURN VARCHAR2;
102
103 END xla_je_validation_pkg;