[Home] [Help]
PACKAGE: APPS.XLA_AAD_LOADER_UTIL_PVT
Source
1 PACKAGE xla_aad_loader_util_pvt AS
2 /* $Header: xlaalutl.pkh 120.8 2006/05/04 18:55:03 wychan ship $ */
3
4 -------------------------------------------------------------------------------
5 -- declaring global constants
6 -------------------------------------------------------------------------------
7 -------------------------------------------------------------------------------
8 -- declaring types
9 -------------------------------------------------------------------------------
10 -------------------------------------------------------------------------------
11 -- Public API
12 -------------------------------------------------------------------------------
13
14 --=============================================================================
15 --
16 -- Name: get_staging_context_code
17 -- Description: This API retrieve the AMB context code of the staging area of
18 -- the specified application and AMB context.
19 --
20 --=============================================================================
21 FUNCTION get_staging_context_code
22 (p_application_id INTEGER
23 ,p_amb_context_code VARCHAR2
24 ) RETURN VARCHAR2;
25
26 --=============================================================================
27 --
28 -- Name: lock_area
29 -- Description: This API locks all the records in amb tables of the amb context.
30 --
31 --=============================================================================
32 FUNCTION lock_area
33 (p_application_id INTEGER
34 ,p_amb_context_code VARCHAR2
35 ) RETURN VARCHAR2;
36
37 --=============================================================================
38 --
39 -- Name: purge
40 -- Description: This API purge all application accounting definitions and its
41 -- component from a specified AMB context code except mapping sets
42 -- and analytical criteria.
43 --
44 --=============================================================================
45 PROCEDURE purge
46 (p_application_id INTEGER
47 ,p_amb_context_code VARCHAR2);
48
49 --=============================================================================
50 --
51 -- Name: merge_history
52 -- Description:
53 --
54 --=============================================================================
55 PROCEDURE merge_history
56 (p_application_id INTEGER
57 ,p_staging_context_code VARCHAR2);
58
59 --=============================================================================
60 --
61 -- Name: get_segment
62 -- Description:
63 --
64 --=============================================================================
65 FUNCTION get_segment
66 (p_chart_of_accounts_id INTEGER
67 ,p_code_combination_id INTEGER
68 ,p_segment_num INTEGER)
69 RETURN VARCHAR2;
70
71 --=============================================================================
72 --
73 -- Name: reset_errors
74 -- Description: This API deletes the error from the log table and
75 -- resets the error stack
76 --
77 --=============================================================================
78 PROCEDURE reset_errors
79 (p_application_id INTEGER
80 ,p_amb_context_code VARCHAR2
81 ,p_request_code VARCHAR2);
82
83 --=============================================================================
84 --
85 -- Name: stack_errors
86 -- Description: This API stacks the error to the error array
87 --
88 --=============================================================================
89 PROCEDURE stack_error
90 (p_appli_s_name VARCHAR2
91 ,p_msg_name VARCHAR2);
92
93 PROCEDURE stack_error
94 (p_appli_s_name VARCHAR2
95 ,p_msg_name VARCHAR2
96 ,p_token_1 VARCHAR2
97 ,p_value_1 VARCHAR2);
98
99 PROCEDURE stack_error
100 (p_appli_s_name VARCHAR2
101 ,p_msg_name VARCHAR2
102 ,p_token_1 VARCHAR2
103 ,p_value_1 VARCHAR2
104 ,p_token_2 VARCHAR2
105 ,p_value_2 VARCHAR2);
106
107 PROCEDURE stack_error
108 (p_appli_s_name VARCHAR2
109 ,p_msg_name VARCHAR2
110 ,p_token_1 VARCHAR2
111 ,p_value_1 VARCHAR2
112 ,p_token_2 VARCHAR2
113 ,p_value_2 VARCHAR2
114 ,p_token_3 VARCHAR2
115 ,p_value_3 VARCHAR2);
116
117 PROCEDURE stack_error
118 (p_appli_s_name VARCHAR2
119 ,p_msg_name VARCHAR2
120 ,p_token_1 VARCHAR2
121 ,p_value_1 VARCHAR2
122 ,p_token_2 VARCHAR2
123 ,p_value_2 VARCHAR2
124 ,p_token_3 VARCHAR2
125 ,p_value_3 VARCHAR2
126 ,p_token_4 VARCHAR2
127 ,p_value_4 VARCHAR2);
128
129 --=============================================================================
130 --
131 -- Name: insert_errors
132 -- Description: This API inserts the errors from the array to the error table
133 --
134 --=============================================================================
135 PROCEDURE insert_errors
136 (p_application_id INTEGER
137 ,p_amb_context_code VARCHAR2
138 ,p_request_code VARCHAR2);
139
140 --=============================================================================
141 --
142 -- Name: wait_for_request
143 -- Description: This API waits for the Upload Application Accounting
144 -- Definitions request to be completed
145 --
146 --=============================================================================
147 FUNCTION wait_for_request
148 (p_req_id INTEGER)
149 RETURN VARCHAR2;
150
151 --=============================================================================
152 --
153 -- Name: compatible_api_call
154 -- Description:
155 --
156 --=============================================================================
157 FUNCTION compatible_api_call
158 (p_current_version_number NUMBER
159 ,p_caller_version_number NUMBER
160 ,p_api_name VARCHAR2
161 ,p_pkg_name VARCHAR2)
162 RETURN BOOLEAN;
163
164 --=============================================================================
165 --
166 -- Name: compile
167 -- Description: This API compiles all AADs for an application in an AMB context
168 --
169 --=============================================================================
170 FUNCTION compile
171 (p_amb_context_code IN VARCHAR2
172 ,p_application_id IN INTEGER)
173 RETURN BOOLEAN;
174
175 --=============================================================================
176 --
177 -- Name: purge_subledger_seed
178 -- Description: This API purge the SLA-related seed data for the subledger
179 --
180 --=============================================================================
181 PROCEDURE purge_subledger_seed
182 (p_api_version IN NUMBER
183 ,x_return_status IN OUT NOCOPY VARCHAR2
184 ,p_application_id IN INTEGER);
185
186 --=============================================================================
187 --
188 -- Name: purge_aad
189 -- Description: This API purge the application accounting definition of an
190 -- application for an AMB context
191 --
192 --=============================================================================
193 PROCEDURE purge_aad
194 (p_api_version IN NUMBER
195 ,x_return_status IN OUT NOCOPY VARCHAR2
196 ,p_application_id IN INTEGER
197 ,p_amb_context_code IN VARCHAR2);
198
199 --=============================================================================
200 --
201 -- Name: rebuild_ac_views
202 -- Description: This API rebuild the view_column_name for the analytical detail
203 -- and rebuild the views.
204 --
205 --=============================================================================
206 PROCEDURE rebuild_ac_views;
207
208 --=============================================================================
209 --
210 -- Name: validate_adr_compatibility
211 -- Description: This API validate if the AAD includes any ADR from other
212 -- application that has incompatible version
213 --
214 --=============================================================================
215 FUNCTION validate_adr_compatibility
216 (p_application_id IN INTEGER
217 ,p_amb_context_code IN VARCHAR2
218 ,p_staging_context_code IN VARCHAR2
219 ) RETURN VARCHAR2;
220
221 --=============================================================================
222 --
223 -- Name: purge_history
224 -- Description: This API reset the version of the AADs, ADRs, etc of an
225 -- application to 0 and clear all its version history.
226 --
227 --=============================================================================
228 PROCEDURE purge_history
229 (p_api_version IN NUMBER
230 ,x_return_status IN OUT NOCOPY VARCHAR2
231 ,p_application_id IN INTEGER);
232
233 END xla_aad_loader_util_pvt;