1 package AK_CUSTOM_GRP as
2 /* $Header: akdgcres.pls 120.2 2005/09/15 22:26:32 tshort noship $ */
3
4 -- Global constants holding the package and file names to be used by
5 -- messaging routines in the case of an unexpected error.
6
7 G_PKG_NAME CONSTANT VARCHAR2(30) := 'AK_CUSTOM_GRP';
8
9 /* Procedure specs */
10
11 --=======================================================
12 -- Procedure CREATE_CUSTOM
13 --
14 -- Usage Group API for creating a region
15 --
16 -- Desc Calls the private API to create a region
17 -- using the given info
18 --
19 -- Results The API returns the standard p_return_status parameter
20 -- indicating one of the standard return statuses :
21 -- * Unexpected error
22 -- * Error
23 -- * Success
24 -- Parameters Region columns
25 --
26 -- Version Initial version number = 1.0
27 -- History Current version number = 1.0
28 --=======================================================
29 procedure CREATE_CUSTOM (
30 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
31 p_api_version_number IN NUMBER,
32 p_init_msg_tbl IN BOOLEAN := FALSE,
33 p_msg_count OUT NOCOPY NUMBER,
34 p_msg_data OUT NOCOPY VARCHAR2,
35 p_return_status OUT NOCOPY VARCHAR2,
36 p_custom_appl_id IN NUMBER,
37 p_custom_code IN VARCHAR2,
38 p_region_appl_id IN NUMBER,
39 p_region_code IN VARCHAR2,
40 p_verticalization_id IN VARCHAR2 := FND_API.G_MISS_CHAR,
41 p_localization_code IN VARCHAR2 := FND_API.G_MISS_CHAR,
42 p_org_id IN NUMBER := FND_API.G_MISS_NUM,
43 p_site_id IN NUMBER := FND_API.G_MISS_NUM,
44 p_responsibility_id IN NUMBER := FND_API.G_MISS_NUM,
45 p_web_user_id IN NUMBER := FND_API.G_MISS_NUM,
46 p_default_customization_flag IN VARCHAR2 := FND_API.G_MISS_CHAR,
47 p_customization_level_id IN NUMBER := FND_API.G_MISS_NUM,
48 p_developer_mode IN VARCHAR2 := FND_API.G_MISS_CHAR,
49 p_reference_path IN VARCHAR2 := FND_API.G_MISS_CHAR,
50 p_function_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
51 p_start_date_active IN DATE := FND_API.G_MISS_DATE,
52 p_end_date_active IN DATE := FND_API.G_MISS_DATE,
53 p_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
54 p_description IN VARCHAR2 := FND_API.G_MISS_CHAR,
55 p_created_by IN NUMBER := FND_API.G_MISS_NUM,
56 p_creation_date IN DATE := FND_API.G_MISS_DATE,
57 p_last_updated_by IN NUMBER := FND_API.G_MISS_NUM,
58 p_last_update_date IN DATE := FND_API.G_MISS_DATE,
59 p_last_update_login IN NUMBER := FND_API.G_MISS_NUM,
60 p_loader_timestamp IN DATE := FND_API.G_MISS_DATE,
61 p_pass IN NUMBER,
62 p_copy_redo_flag IN OUT NOCOPY BOOLEAN
63 );
64
65 --=======================================================
66 -- Procedure CREATE_CUST_REGION
67 --
68 -- Usage Group API for creating a region item
69 --
70 -- Desc Calls the private API to creates a region item
71 -- using the given info
72 --
73 -- Results The API returns the standard p_return_status parameter
74 -- indicating one of the standard return statuses :
75 -- * Unexpected error
76 -- * Error
77 -- * Success
78 -- Parameters Region Item columns
79 --
80 -- Version Initial version number = 1.0
81 -- History Current version number = 1.0
82 --=======================================================
83 procedure CREATE_CUST_REGION (
84 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
85 p_api_version_number IN NUMBER,
86 p_init_msg_tbl IN BOOLEAN := FALSE,
87 p_msg_count OUT NOCOPY NUMBER,
88 p_msg_data OUT NOCOPY VARCHAR2,
89 p_return_status OUT NOCOPY VARCHAR2,
90 p_custom_appl_id IN NUMBER,
91 p_custom_code IN VARCHAR2,
92 p_region_appl_id IN NUMBER,
93 p_region_code IN VARCHAR2,
94 p_property_name IN VARCHAR2,
95 p_property_varchar2_value IN VARCHAR2 := FND_API.G_MISS_CHAR,
96 p_property_number_value IN NUMBER := FND_API.G_MISS_NUM,
97 p_criteria_join_condition IN VARCHAR2 := FND_API.G_MISS_CHAR,
98 p_property_varchar2_value_tl IN VARCHAR2 := FND_API.G_MISS_CHAR,
99 p_created_by IN NUMBER := FND_API.G_MISS_NUM,
100 p_creation_date IN DATE := FND_API.G_MISS_DATE,
101 p_last_updated_by IN NUMBER := FND_API.G_MISS_NUM,
102 p_last_update_date IN DATE := FND_API.G_MISS_DATE,
103 p_last_update_login IN NUMBER := FND_API.G_MISS_NUM,
104 p_loader_timestamp IN DATE := FND_API.G_MISS_DATE,
105 p_pass IN NUMBER,
106 p_copy_redo_flag IN OUT NOCOPY BOOLEAN
107 );
108
109 --=======================================================
110 -- Procedure CREATE_CUST_REG_ITEM
111 --
112 -- Usage Group API for creating a region item
113 --
114 -- Desc Calls the private API to creates a region item
115 -- using the given info
116 --
117 -- Results The API returns the standard p_return_status parameter
118 -- indicating one of the standard return statuses :
119 -- * Unexpected error
120 -- * Error
121 -- * Success
122 -- Parameters Region Item columns
123 --
124 -- Version Initial version number = 1.0
125 -- History Current version number = 1.0
126 --=======================================================
127 procedure CREATE_CUST_REG_ITEM (
128 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
129 p_api_version_number IN NUMBER,
130 p_init_msg_tbl IN BOOLEAN := FALSE,
131 p_msg_count OUT NOCOPY NUMBER,
132 p_msg_data OUT NOCOPY VARCHAR2,
133 p_return_status OUT NOCOPY VARCHAR2,
134 p_custom_appl_id IN NUMBER,
135 p_custom_code IN VARCHAR2,
136 p_region_appl_id IN NUMBER,
137 p_region_code IN VARCHAR2,
138 p_attr_appl_id IN NUMBER,
139 p_attr_code IN VARCHAR2,
140 p_property_name IN VARCHAR2,
141 p_property_varchar2_value IN VARCHAR2 := FND_API.G_MISS_CHAR,
142 p_property_number_value IN NUMBER := FND_API.G_MISS_NUM,
143 p_property_date_value IN VARCHAR2 := FND_API.G_MISS_CHAR,
144 p_property_varchar2_value_tl IN VARCHAR2 := FND_API.G_MISS_CHAR,
145 p_created_by IN NUMBER := FND_API.G_MISS_NUM,
146 p_creation_date IN DATE := FND_API.G_MISS_DATE,
147 p_last_updated_by IN NUMBER := FND_API.G_MISS_NUM,
148 p_last_update_date IN DATE := FND_API.G_MISS_DATE,
149 p_last_update_login IN NUMBER := FND_API.G_MISS_NUM,
150 p_loader_timestamp IN DATE := FND_API.G_MISS_DATE,
151 p_pass IN NUMBER,
152 p_copy_redo_flag IN OUT NOCOPY BOOLEAN
153 );
154
155 --=======================================================
156 -- Procedure CREATE_CRITERIA
157 --
158 -- Usage Group API for creating a region item
159 --
160 -- Desc Calls the private API to creates a region item
161 -- using the given info
162 --
163 -- Results The API returns the standard p_return_status parameter
164 -- indicating one of the standard return statuses :
165 -- * Unexpected error
166 -- * Error
167 -- * Success
168 -- Parameters Region Item columns
169 --
170 -- Version Initial version number = 1.0
171 -- History Current version number = 1.0
172 --=======================================================
173 procedure CREATE_CRITERIA (
174 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
175 p_api_version_number IN NUMBER,
176 p_init_msg_tbl IN BOOLEAN := FALSE,
177 p_msg_count OUT NOCOPY NUMBER,
178 p_msg_data OUT NOCOPY VARCHAR2,
179 p_return_status OUT NOCOPY VARCHAR2,
180 p_custom_appl_id IN NUMBER,
181 p_custom_code IN VARCHAR2,
182 p_region_appl_id IN NUMBER,
183 p_region_code IN VARCHAR2,
184 p_attr_appl_id IN NUMBER,
185 p_attr_code IN VARCHAR2,
186 p_sequence_number IN NUMBER,
187 p_operation IN VARCHAR2 := FND_API.G_MISS_CHAR,
188 p_value_varchar2 IN VARCHAR2 := FND_API.G_MISS_CHAR,
189 p_value_number IN NUMBER := FND_API.G_MISS_NUM,
190 p_value_date IN DATE := FND_API.G_MISS_DATE,
191 p_start_date_active IN DATE := FND_API.G_MISS_DATE,
192 p_end_date_active IN DATE := FND_API.G_MISS_DATE,
193 p_created_by IN NUMBER := FND_API.G_MISS_NUM,
194 p_creation_date IN DATE := FND_API.G_MISS_DATE,
195 p_last_updated_by IN NUMBER := FND_API.G_MISS_NUM,
196 p_last_update_date IN DATE := FND_API.G_MISS_DATE,
197 p_last_update_login IN NUMBER := FND_API.G_MISS_NUM,
198 p_loader_timestamp IN DATE := FND_API.G_MISS_DATE,
199 p_pass IN NUMBER,
200 p_copy_redo_flag IN OUT NOCOPY BOOLEAN
201 );
202
203 --=======================================================
204 -- Procedure DOWNLOAD_CUSTOM
205 --
206 -- Usage Group API for downloading customized regions
207 --
208 -- Desc This API first write out standard loader
209 -- file header for customized regions to a flat file.
210 -- Then it calls the private API to extract the
211 -- regions selected by application ID or by
212 -- key values from the database to the output file.
213 -- If a region is selected for writing to the loader
214 -- file, all its children records will also be written.
215 --
216 -- Results The API returns the standard p_return_status parameter
217 -- indicating one of the standard return statuses :
218 -- * Unexpected error
219 -- * Error
220 -- * Success
221 -- Parameters
222 -- p_nls_language : IN optional
223 -- NLS language for database. If none if given,
224 -- the current NLS language will be used.
225 --
226 -- One of the following three parameters must be given:
227 --
228 -- p_application_id : IN optional
229 -- If given, all regions for this application ID
230 -- will be written to the output file.
231 -- p_application_short_name : IN optional
232 -- If given, all regions for this application short
233 -- name will be written to the output file.
234 -- Application short name will be ignored if an
235 -- application ID is given.
236 -- p_custom_pk_tbl : IN optional
237 -- If given, only regions whose key values are
238 -- included in this table will be written to the
239 -- output file.
240 --
241 --
242 -- Version Initial version number = 1.0
243 -- History Current version number = 1.0
244 --=======================================================
245 procedure DOWNLOAD_CUSTOM (
246 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
247 p_api_version_number IN NUMBER,
248 p_init_msg_tbl IN BOOLEAN := FALSE,
249 p_msg_count OUT NOCOPY NUMBER,
250 p_msg_data OUT NOCOPY VARCHAR2,
251 p_return_status OUT NOCOPY VARCHAR2,
252 p_nls_language IN VARCHAR2 := FND_API.G_MISS_CHAR,
253 p_application_id IN NUMBER := FND_API.G_MISS_NUM,
254 p_application_short_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
255 p_custom_pk_tbl IN AK_CUSTOM_PUB.Custom_PK_Tbl_Type := AK_CUSTOM_PUB.G_MISS_CUSTOM_PK_TBL,
256 p_level IN VARCHAR2 := FND_API.G_MISS_CHAR,
257 p_levelpk IN VARCHAR2 := FND_API.G_MISS_CHAR
258 );
259
260 --=======================================================
261 -- Procedure UPDATE_CUSTOM
262 --
263 -- Usage Group API for updating a region
264 --
265 -- Desc This API calls the private API to update
266 -- a region using the given info
267 --
268 -- Results The API returns the standard p_return_status parameter
269 -- indicating one of the standard return statuses :
270 -- * Unexpected error
271 -- * Error
272 -- * Success
273 -- Parameters Region columns
274 --
275 -- Version Initial version number = 1.0
276 -- History Current version number = 1.0
277 --=======================================================
278 procedure UPDATE_CUSTOM (
279 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
280 p_api_version_number IN NUMBER,
281 p_init_msg_tbl IN BOOLEAN := FALSE,
282 p_msg_count OUT NOCOPY NUMBER,
283 p_msg_data OUT NOCOPY VARCHAR2,
284 p_return_status OUT NOCOPY VARCHAR2,
285 p_custom_appl_id IN NUMBER,
286 p_custom_appl_code IN VARCHAR2,
287 p_region_application_id IN NUMBER,
288 p_region_code IN VARCHAR2,
289 p_verticalization_id IN VARCHAR2 := FND_API.G_MISS_CHAR,
290 p_localization_code IN VARCHAR2 := FND_API.G_MISS_CHAR,
291 p_org_id IN NUMBER := FND_API.G_MISS_NUM,
292 p_site_id IN NUMBER := FND_API.G_MISS_NUM,
293 p_responsibility_id IN NUMBER := FND_API.G_MISS_NUM,
294 p_web_user_id IN NUMBER := FND_API.G_MISS_NUM,
295 p_default_customization_flag IN VARCHAR2 := FND_API.G_MISS_CHAR,
296 p_customization_level_id IN NUMBER := FND_API.G_MISS_NUM,
297 p_developer_mode IN VARCHAR2 := FND_API.G_MISS_CHAR,
298 p_reference_path IN VARCHAR2 := FND_API.G_MISS_CHAR,
299 p_function_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
300 p_start_date_active IN DATE := FND_API.G_MISS_DATE,
304 p_created_by IN NUMBER := FND_API.G_MISS_NUM,
301 p_end_date_active IN DATE := FND_API.G_MISS_DATE,
302 p_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
303 p_description IN VARCHAR2 := FND_API.G_MISS_CHAR,
305 p_creation_date IN DATE := FND_API.G_MISS_DATE,
306 p_last_updated_by IN NUMBER := FND_API.G_MISS_NUM,
307 p_last_update_date IN DATE := FND_API.G_MISS_DATE,
308 p_last_update_login IN NUMBER := FND_API.G_MISS_NUM
309 );
310
311 --=======================================================
312 -- Procedure UPDATE_CUST_REGION
313 --
314 -- Usage Group API for updating a region
315 --
316 -- Desc This API calls the private API to update
317 -- a region using the given info
318 --
319 -- Results The API returns the standard p_return_status parameter
320 -- indicating one of the standard return statuses :
321 -- * Unexpected error
322 -- * Error
323 -- * Success
324 -- Parameters Region columns
325 --
326 -- Version Initial version number = 1.0
327 -- History Current version number = 1.0
328 --=======================================================
329 procedure UPDATE_CUST_REGION (
330 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
331 p_api_version_number IN NUMBER,
332 p_init_msg_tbl IN BOOLEAN := FALSE,
333 p_msg_count OUT NOCOPY NUMBER,
334 p_msg_data OUT NOCOPY VARCHAR2,
335 p_return_status OUT NOCOPY VARCHAR2,
336 p_custom_appl_id IN NUMBER,
337 p_custom_appl_code IN VARCHAR2,
338 p_region_application_id IN NUMBER,
339 p_region_code IN VARCHAR2,
340 p_property_name IN VARCHAR2,
341 p_property_varchar2_value IN VARCHAR2 := FND_API.G_MISS_CHAR,
342 p_property_number_value IN NUMBER := FND_API.G_MISS_NUM,
343 p_criteria_join_condition IN VARCHAR2 := FND_API.G_MISS_CHAR,
344 p_property_varchar2_value_tl IN VARCHAR2 := FND_API.G_MISS_CHAR,
345 p_created_by IN NUMBER := FND_API.G_MISS_NUM,
346 p_creation_date IN DATE := FND_API.G_MISS_DATE,
347 p_last_updated_by IN NUMBER := FND_API.G_MISS_NUM,
348 p_last_update_date IN DATE := FND_API.G_MISS_DATE,
349 p_last_update_login IN NUMBER := FND_API.G_MISS_NUM
350 );
351
352 --=======================================================
353 -- Procedure UPDATE_CUST_REG_ITEM
354 --
355 -- Usage Group API for updating a region
356 --
357 -- Desc This API calls the private API to update
358 -- a region using the given info
359 --
360 -- Results The API returns the standard p_return_status parameter
361 -- indicating one of the standard return statuses :
362 -- * Unexpected error
363 -- * Error
364 -- * Success
365 -- Parameters Region columns
366 --
367 -- Version Initial version number = 1.0
368 -- History Current version number = 1.0
369 --=======================================================
370 procedure UPDATE_CUST_REG_ITEM (
371 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
372 p_api_version_number IN NUMBER,
373 p_init_msg_tbl IN BOOLEAN := FALSE,
374 p_msg_count OUT NOCOPY NUMBER,
375 p_msg_data OUT NOCOPY VARCHAR2,
376 p_return_status OUT NOCOPY VARCHAR2,
377 p_custom_appl_id IN NUMBER,
378 p_custom_appl_code IN VARCHAR2,
379 p_region_application_id IN NUMBER,
380 p_region_code IN VARCHAR2,
381 p_attribute_appl_id IN NUMBER,
382 p_attribute_code IN VARCHAR2,
383 p_property_name IN VARCHAR2,
384 p_property_varchar2_value IN VARCHAR2 := FND_API.G_MISS_CHAR,
385 p_property_number_value IN NUMBER := FND_API.G_MISS_NUM,
386 p_property_date_value IN VARCHAR2 := FND_API.G_MISS_CHAR,
387 p_property_varchar2_value_tl IN VARCHAR2 := FND_API.G_MISS_CHAR,
388 p_created_by IN NUMBER := FND_API.G_MISS_NUM,
389 p_creation_date IN DATE := FND_API.G_MISS_DATE,
390 p_last_updated_by IN NUMBER := FND_API.G_MISS_NUM,
391 p_last_update_date IN DATE := FND_API.G_MISS_DATE,
392 p_last_update_login IN NUMBER := FND_API.G_MISS_NUM
393 );
394
395 --=======================================================
396 -- Procedure UPDATE_CRITERIA
397 --
398 -- Usage Group API for updating a region
399 --
400 -- Desc This API calls the private API to update
401 -- a region using the given info
402 --
403 -- Results The API returns the standard p_return_status parameter
404 -- indicating one of the standard return statuses :
405 -- * Unexpected error
406 -- * Error
407 -- * Success
408 -- Parameters Region columns
409 --
410 -- Version Initial version number = 1.0
411 -- History Current version number = 1.0
412 --=======================================================
413 procedure UPDATE_CRITERIA (
414 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
418 p_msg_data OUT NOCOPY VARCHAR2,
415 p_api_version_number IN NUMBER,
416 p_init_msg_tbl IN BOOLEAN := FALSE,
417 p_msg_count OUT NOCOPY NUMBER,
419 p_return_status OUT NOCOPY VARCHAR2,
420 p_custom_appl_id IN NUMBER,
421 p_custom_appl_code IN VARCHAR2,
422 p_region_application_id IN NUMBER,
423 p_region_code IN VARCHAR2,
424 p_attribute_appl_id IN NUMBER,
425 p_attribute_code IN VARCHAR2,
426 p_sequence_number IN NUMBER,
427 p_operation IN VARCHAR2,
428 p_value_varchar2 IN VARCHAR2 := FND_API.G_MISS_CHAR,
429 p_value_number IN NUMBER := FND_API.G_MISS_NUM,
430 p_value_date IN DATE := FND_API.G_MISS_DATE,
431 p_start_date_Active IN DATE := FND_API.G_MISS_DATE,
432 p_end_date_active IN DATE := FND_API.G_MISS_DATE,
433 p_created_by IN NUMBER := FND_API.G_MISS_NUM,
434 p_creation_date IN DATE := FND_API.G_MISS_DATE,
435 p_last_updated_by IN NUMBER := FND_API.G_MISS_NUM,
436 p_last_update_date IN DATE := FND_API.G_MISS_DATE,
437 p_last_update_login IN NUMBER := FND_API.G_MISS_NUM
438 );
439
440 end AK_CUSTOM_GRP;
[Home] [Help]