DBA Data[Home] [Help]

PACKAGE: APPS.XLA_CMP_TAB_PKG

Source


1 PACKAGE xla_cmp_tab_pkg AS
2 /* $Header: xlacptab.pkh 120.1 2004/06/21 15:15:27 aquaglia ship $ */
3 /*======================================================================+
4 |             Copyright (c) 1995-2002 Oracle Corporation                |
5 |                       Redwood Shores, CA, USA                         |
6 |                         All rights reserved.                          |
7 +=======================================================================+
8 | PACKAGE NAME                                                          |
9 |    xla_cmp_tab_pkg                                                    |
10 |                                                                       |
11 | DESCRIPTION                                                           |
12 |    Transaction Account Builder API compiler                           |
13 |                                                                       |
14 | HISTORY                                                               |
15 |    26-JAN-04 A.Quaglia      Created                                   |
16 |    21-JUN-04 A.Quaglia      get_ccid_additional_info:                 |
17 |                                removed x_concatenated_values          |
18 |                                                                       |
19 |                                                                       |
20 |                                                                       |
21 |                                                                       |
22 |                                                                       |
23 +======================================================================*/
24 
25 
26    TYPE gt_table_of_varchar2_1        IS TABLE OF VARCHAR2(1);
27    TYPE gt_table_of_varchar2_10       IS TABLE OF VARCHAR2(10);
28    TYPE gt_table_of_varchar2_30       IS TABLE OF VARCHAR2(30);
29 
30    g_all_object_name_affixes          gt_table_of_varchar2_10;
31    g_compiled_object_name_affixes     gt_table_of_varchar2_10;
32 
33    g_table_of_sources                 gt_table_of_varchar2_30;
34 
35 
36 /*======================================================================+
37 |                                                                       |
38 | Public Procedure                                                      |
39 |                                                                       |
40 | compile_api_srs                                                       |
41 |                                                                       |
42 | SRS wrapper for compile_api                                           |
43 |	p_retcode := 0 means that the compilation was successful.       |
44 |	p_retcode := 2 means that errors were encountered and that the  |
45 |                      generation of the API was unsuccessful.          |
46 +======================================================================*/
47 PROCEDURE compile_api_srs
48                            ( p_errbuf               OUT NOCOPY VARCHAR2
49                             ,p_retcode              OUT NOCOPY NUMBER
50                             ,p_application_id       IN         NUMBER
51                            );
52 
53 
54 /*======================================================================+
55 |                                                                       |
56 | Public Function                                                       |
57 |                                                                       |
58 | compile_api                                                           |
59 |                                                                       |
60 | It generates the Transaction Account Builder API for the specified    |
61 | application.                                                          |
62 | It generates one package header and one package body in the <APPS>    |
63 | schema and one or more global temporary tables in the Product schema  |
64 | (e.g. AP, AR etc.).                                                   |
65 | The number of interface tables actually generated depends on the      |
66 | number of distinct values of object_name_affix defined for the        |
67 | different Transaction Account Types within the specified application. |
68 |                                                                       |
69 | It returns a BOOLEAN value.                                           |
70 |     TRUE  means that the compilation was successful.                  |
71 |     FALSE means that errors were encountered and that the generation  |
72 |                 of the API was unsuccessful.                          |
73 +======================================================================*/
74 FUNCTION compile_api
75                            ( p_application_id       IN         NUMBER
76                            )
77 RETURN BOOLEAN
78 ;
79 
80 /*======================================================================+
81 |                                                                       |
82 | Public Function                                                       |
83 |                                                                       |
84 | get_distinct_affixes                                                  |
85 |                                                                       |
86 |                                                                       |
87 | Returns false if no affixes are found                                 |
88 |                                                                       |
89 +======================================================================*/
90 FUNCTION read_distinct_affixes
91                            ( p_application_id        IN NUMBER
92                            )
93 RETURN BOOLEAN;
94 
95 
96 /*======================================================================+
97 |                                                                       |
98 | Public Function                                                       |
99 |                                                                       |
100 | get_interface_object_names                                            |
101 |                                                                       |
102 | Return the names of the objects that form the TAB API interface for   |
103 | the specified affix.                                                  |
104 |                                                                       |
105 | Returns TRUE if successful, FALSE otherwise.                          |
106 |                                                                       |
107 +======================================================================*/
108 FUNCTION get_interface_object_names
109             (
110               p_application_id           IN         VARCHAR2
111              ,p_object_name_affix        IN         VARCHAR2
112              ,x_global_table_name        OUT NOCOPY VARCHAR2
113              ,x_plsql_table_name         OUT NOCOPY VARCHAR2
114             )
115 RETURN BOOLEAN;
116 
117 
118 
119 
120 /*======================================================================+
121 |                                                                       |
122 | Public Function                                                       |
123 |                                                                       |
124 | get_interface_sources                                                 |
125 |                                                                       |
126 | Return a list of the sources included in the TAB API interface for    |
127 | the specified affix.                                                  |
128 |                                                                       |
129 | Returns TRUE if successful, FALSE otherwise.                          |
130 |                                                                       |
131 +======================================================================*/
132 FUNCTION get_interface_sources
133             (
134               p_application_id            IN         VARCHAR2
135              ,p_object_name_affix         IN         VARCHAR2
136              ,x_table_of_sources          OUT NOCOPY gt_table_of_varchar2_30
137              ,x_table_of_source_datatypes OUT NOCOPY gt_table_of_varchar2_1
138             )
139 RETURN BOOLEAN;
140 
141 
142 
143 
144 /*======================================================================+
145 |                                                                       |
146 | Public Function                                                       |
147 |                                                                       |
148 | get_tab_api_package_name                                              |
149 |                                                                       |
150 | Return the names of the objects that form the TAB API interface for   |
151 | the specified affix.                                                  |
152 |                                                                       |
153 | Returns TRUE if successful, FALSE otherwise.                          |
154 |                                                                       |
155 +======================================================================*/
156 FUNCTION get_tab_api_package_name
157             (
158               p_application_id           IN         VARCHAR2
159              ,x_tab_api_package_name     OUT NOCOPY VARCHAR2
160             )
161 RETURN BOOLEAN;
162 
163 
164 
165 /*======================================================================+
166 |                                                                       |
167 | Public Function                                                       |
168 |                                                                       |
169 | get_tab_api_info_for_tat                                              |
170 |                                                                       |
171 | Returns information about the TAB API interface for the specified     |
172 | Transaction Account Type                                              |
173 |                                                                       |
174 | Returns TRUE if successful, FALSE otherwise.                          |
175 |                                                                       |
176 +======================================================================*/
177 FUNCTION get_tab_api_info_for_tat
178             (
179               p_application_id            IN         VARCHAR2
180              ,p_account_type_code         IN         VARCHAR2
181              ,x_object_name_affix         OUT NOCOPY VARCHAR2
182              ,x_tab_api_package_name      OUT NOCOPY VARCHAR2
183              ,x_global_table_name         OUT NOCOPY VARCHAR2
184              ,x_plsql_table_name          OUT NOCOPY VARCHAR2
185              ,x_write_proc_name           OUT NOCOPY VARCHAR2
186              ,x_read_proc_name            OUT NOCOPY VARCHAR2
187              ,x_table_of_sources          OUT NOCOPY FND_TABLE_OF_VARCHAR2_30
188              ,x_table_of_source_datatypes OUT NOCOPY FND_TABLE_OF_VARCHAR2_1
189             )
190 RETURN BOOLEAN;
191 
192 
193 /*======================================================================+
194 |                                                                       |
195 | Public Function                                                       |
196 |                                                                       |
197 | get_ccid_additional_info                                              |
198 |                                                                       |
199 | Returns information about a code combination id                       |
200 |                                                                       |
201 | Returns TRUE if successful, FALSE otherwise.                          |
202 |                                                                       |
203 +======================================================================*/
204 FUNCTION get_ccid_additional_info
205             (
206               p_chart_of_accounts_id      IN         NUMBER
207              ,p_ccid                      IN         NUMBER
208              ,x_concatenated_descriptions OUT NOCOPY VARCHAR2
209             )
210 RETURN BOOLEAN;
211 
212 
213 
214 /*======================================================================+
215 |                                                                       |
216 | Public Function                                                       |
217 |                                                                       |
218 | remove_deleted_tats                                                   |
219 |                                                                       |
220 | Removes Transaction Account Types headers that have been              |
221 | deleted in the UI.                                                    |
222 |                                                                       |
223 | It returns a BOOLEAN value.                                           |
224 |     TRUE  means that the function was successful.                     |
225 |     FALSE means that errors were encountered                          |
226 |                                                                       |
227 +======================================================================*/
228 
229 FUNCTION remove_deleted_tats
230              (
231                 p_application_id IN NUMBER
232              )
233 RETURN BOOLEAN;
234 
235 
236 END xla_cmp_tab_pkg;