1 package AK_KEY_GRP as
2 /* $Header: akdgkeys.pls 120.2 2005/09/15 22:26:35 tshort ship $ */
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_KEY_GRP';
8
9 -- Procedure specs
10
11 --=======================================================
12 -- Procedure CREATE_FOREIGN_KEY
13 --
14 -- Usage Group API for creating a foreign key
15 --
16 -- Desc Calls the private API to creates a foreign key
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 Foreign Key columns
25 --
26 -- Version Initial version number = 1.0
27 -- History Current version number = 1.0
28 --=======================================================
29 procedure CREATE_FOREIGN_KEY (
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_foreign_key_name IN VARCHAR2,
37 p_database_object_name IN VARCHAR2,
38 p_unique_key_name IN VARCHAR2,
39 p_application_id IN NUMBER,
40 p_from_to_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
41 p_from_to_description IN VARCHAR2 := FND_API.G_MISS_CHAR,
42 p_to_from_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
43 p_to_from_description IN VARCHAR2 := FND_API.G_MISS_CHAR,
44 p_created_by IN NUMBER := FND_API.G_MISS_NUM,
45 p_creation_date IN DATE := FND_API.G_MISS_DATE,
46 p_last_updated_by IN NUMBER := FND_API.G_MISS_NUM,
47 p_last_update_date IN DATE := FND_API.G_MISS_DATE,
48 p_last_update_login IN NUMBER := FND_API.G_MISS_NUM
49 );
50
51 --=======================================================
52 -- Procedure CREATE_FOREIGN_KEY_COLUMN
53 --
54 -- Usage Group API for creating a foreign key column record
55 --
56 -- Desc Calls the private API to creates a foreign key
57 -- column record using the given info
58 --
59 -- Results The API returns the standard p_return_status parameter
60 -- indicating one of the standard return statuses :
61 -- * Unexpected error
62 -- * Error
63 -- * Success
64 -- Parameters Foreign Key Column columns
65 --
66 -- Version Initial version number = 1.0
67 -- History Current version number = 1.0
68 --=======================================================
69 procedure CREATE_FOREIGN_KEY_COLUMN (
70 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
71 p_api_version_number IN NUMBER,
72 p_init_msg_tbl IN BOOLEAN := FALSE,
73 p_msg_count OUT NOCOPY NUMBER,
74 p_msg_data OUT NOCOPY VARCHAR2,
75 p_return_status OUT NOCOPY VARCHAR2,
76 p_foreign_key_name IN VARCHAR2,
77 p_attribute_application_id IN NUMBER,
78 p_attribute_code IN VARCHAR2,
79 p_foreign_key_sequence IN NUMBER,
80 p_created_by IN NUMBER := FND_API.G_MISS_NUM,
81 p_creation_date IN DATE := FND_API.G_MISS_DATE,
82 p_last_updated_by IN NUMBER := FND_API.G_MISS_NUM,
83 p_last_update_date IN DATE := FND_API.G_MISS_DATE,
84 p_last_update_login IN NUMBER := FND_API.G_MISS_NUM
85 );
86
87 --=======================================================
88 -- Procedure CREATE_UNIQUE_KEY
89 --
90 -- Usage Group API for creating a unique key
91 --
92 -- Desc Calls the private API to creates a unique key
93 -- using the given info
94 --
95 -- Results The API returns the standard p_return_status parameter
96 -- indicating one of the standard return statuses :
97 -- * Unexpected error
98 -- * Error
99 -- * Success
100 -- Parameters Unique Key columns
101 --
102 -- Version Initial version number = 1.0
103 -- History Current version number = 1.0
104 --=======================================================
105 procedure CREATE_UNIQUE_KEY (
106 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
107 p_api_version_number IN NUMBER,
108 p_init_msg_tbl IN BOOLEAN := FALSE,
109 p_msg_count OUT NOCOPY NUMBER,
110 p_msg_data OUT NOCOPY VARCHAR2,
111 p_return_status OUT NOCOPY VARCHAR2,
112 p_unique_key_name IN VARCHAR2,
113 p_database_object_name IN VARCHAR2,
114 p_application_id IN NUMBER,
115 p_created_by IN NUMBER := FND_API.G_MISS_NUM,
116 p_creation_date IN DATE := FND_API.G_MISS_DATE,
117 p_last_updated_by IN NUMBER := FND_API.G_MISS_NUM,
118 p_last_update_date IN DATE := FND_API.G_MISS_DATE,
119 p_last_update_login IN NUMBER := FND_API.G_MISS_NUM
120 );
121
122 --=======================================================
123 -- Procedure CREATE_UNIQUE_KEY_COLUMN
124 --
125 -- Usage Group API for creating a unique key column record
126 --
127 -- Desc Calls the private API to creates a unique key
128 -- column record using the given info
129 --
130 -- Results The API returns the standard p_return_status parameter
131 -- indicating one of the standard return statuses :
132 -- * Unexpected error
133 -- * Error
134 -- * Success
135 -- Parameters Unique Key Column columns
136 --
137 -- Version Initial version number = 1.0
138 -- History Current version number = 1.0
139 --=======================================================
140 procedure CREATE_UNIQUE_KEY_COLUMN (
141 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
142 p_api_version_number IN NUMBER,
143 p_init_msg_tbl IN BOOLEAN := FALSE,
144 p_msg_count OUT NOCOPY NUMBER,
145 p_msg_data OUT NOCOPY VARCHAR2,
146 p_return_status OUT NOCOPY VARCHAR2,
147 p_unique_key_name IN VARCHAR2,
148 p_attribute_application_id IN NUMBER,
149 p_attribute_code IN VARCHAR2,
150 p_unique_key_sequence IN NUMBER,
151 p_created_by IN NUMBER := FND_API.G_MISS_NUM,
152 p_creation_date IN DATE := FND_API.G_MISS_DATE,
153 p_last_updated_by IN NUMBER := FND_API.G_MISS_NUM,
154 p_last_update_date IN DATE := FND_API.G_MISS_DATE,
155 p_last_update_login IN NUMBER := FND_API.G_MISS_NUM
156 );
157
158 --=======================================================
159 -- Procedure DELETE_FOREIGN_KEY
160 --
161 -- Usage Group API for deleting a foreign key record
162 --
163 -- Desc Calls the private API to deletes a foreign key
164 -- record with the given key value.
165 --
166 -- Results The API returns the standard p_return_status parameter
167 -- indicating one of the standard return statuses :
168 -- * Unexpected error
169 -- * Error
170 -- * Success
171 -- Parameters p_foreign_key_name : IN required
172 -- Name of the Foreign Key to be deleted.
173 -- p_delete_cascade : IN required
174 -- If p_delete_cascade flag is 'Y', also delete all
175 -- rows in other tables that references this record.
176 -- Otherwise, this record will not be deleted if there
177 -- are any other rows referencing it.
178 --
179 -- Version Initial version number = 1.0
180 -- History Current version number = 1.0
181 --=======================================================
182 procedure DELETE_FOREIGN_KEY (
183 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
184 p_api_version_number IN NUMBER,
185 p_init_msg_tbl IN BOOLEAN := FALSE,
186 p_msg_count OUT NOCOPY NUMBER,
187 p_msg_data OUT NOCOPY VARCHAR2,
188 p_return_status OUT NOCOPY VARCHAR2,
189 p_foreign_key_name IN VARCHAR2,
190 p_delete_cascade IN VARCHAR2 := 'N'
191 );
192
193 --=======================================================
194 -- Procedure DELETE_FOREIGN_KEY_COLUMN
195 --
196 -- Usage Group API for deleting a foreign key column record
197 --
198 -- Desc Calls the private API to deletes a foreign key
199 -- column record with the given key value.
200 --
201 -- Results The API returns the standard p_return_status parameter
202 -- indicating one of the standard return statuses :
203 -- * Unexpected error
204 -- * Error
205 -- * Success
206 -- Parameters p_foreign_key_name : IN required
207 -- p_attribute_application_id : IN required
208 -- p_attribute_code : IN required
209 -- Key for the Foreign Key Column record to be deleted.
210 -- p_delete_cascade : IN required
211 -- If p_delete_cascade flag is 'Y', also delete all
212 -- rows in other tables that references this record.
213 -- Otherwise, this record will not be deleted if there
214 -- are any other rows referencing it.
215 --
216 -- Version Initial version number = 1.0
217 -- History Current version number = 1.0
218 --=======================================================
219 procedure DELETE_FOREIGN_KEY_COLUMN (
220 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
221 p_api_version_number IN NUMBER,
222 p_init_msg_tbl IN BOOLEAN := FALSE,
223 p_msg_count OUT NOCOPY NUMBER,
224 p_msg_data OUT NOCOPY VARCHAR2,
225 p_return_status OUT NOCOPY VARCHAR2,
226 p_foreign_key_name IN VARCHAR2,
227 p_attribute_application_id IN NUMBER,
228 p_attribute_code IN VARCHAR2,
229 p_delete_cascade IN VARCHAR2 := 'N'
230 );
231
232 --=======================================================
233 -- Procedure DELETE_UNIQUE_KEY
234 --
235 -- Usage Group API for deleting a unique key record
236 --
237 -- Desc Calls the private API to deletes a unique key
238 -- record with the given key value.
239 --
240 -- Results The API returns the standard p_return_status parameter
241 -- indicating one of the standard return statuses :
242 -- * Unexpected error
243 -- * Error
244 -- * Success
245 -- Parameters p_unique_key_name : IN required
246 -- Name of the Unique Key to be deleted.
247 -- p_delete_cascade : IN required
248 -- If p_delete_cascade flag is 'Y', also delete all
249 -- rows in other tables that references this record.
250 -- Otherwise, this record will not be deleted if there
251 -- are any other rows referencing it.
252 --
253 -- Version Initial version number = 1.0
254 -- History Current version number = 1.0
255 --=======================================================
256 procedure DELETE_UNIQUE_KEY (
257 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
258 p_api_version_number IN NUMBER,
259 p_init_msg_tbl IN BOOLEAN := FALSE,
260 p_msg_count OUT NOCOPY NUMBER,
261 p_msg_data OUT NOCOPY VARCHAR2,
262 p_return_status OUT NOCOPY VARCHAR2,
263 p_unique_key_name IN VARCHAR2,
264 p_delete_cascade IN VARCHAR2 := 'N'
265 );
266
267 --=======================================================
268 -- Procedure DELETE_UNIQUE_KEY_COLUMN
269 --
270 -- Usage Group API for deleting a Unique key column record
271 --
272 -- Desc Calls the private API to deletes a unique key
273 -- column record with the given key value.
274 --
275 -- Results The API returns the standard p_return_status parameter
276 -- indicating one of the standard return statuses :
277 -- * Unexpected error
278 -- * Error
279 -- * Success
280 -- Parameters p_unique_key_name : IN required
281 -- p_attribute_application_id : IN required
282 -- p_attribute_code : IN required
283 -- Key for the Unique Key Column record to be deleted.
284 -- p_delete_cascade : IN required
285 -- If p_delete_cascade flag is 'Y', also delete all
286 -- rows in other tables that references this record.
287 -- Otherwise, this record will not be deleted if there
288 -- are any other rows referencing it.
289 --
290 -- Version Initial version number = 1.0
291 -- History Current version number = 1.0
292 --=======================================================
293 procedure DELETE_UNIQUE_KEY_COLUMN (
294 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
295 p_api_version_number IN NUMBER,
296 p_init_msg_tbl IN BOOLEAN := FALSE,
297 p_msg_count OUT NOCOPY NUMBER,
298 p_msg_data OUT NOCOPY VARCHAR2,
299 p_return_status OUT NOCOPY VARCHAR2,
300 p_unique_key_name IN VARCHAR2,
301 p_attribute_application_id IN NUMBER,
302 p_attribute_code IN VARCHAR2,
303 p_delete_cascade IN VARCHAR2 := 'N'
304 );
305
306 --=======================================================
307 -- Procedure UPDATE_FOREIGN_KEY
308 --
309 -- Usage Group API for updating a foreign key record
310 --
311 -- Desc This API calls the private API to update
312 -- a foreign key record using the given info
313 --
314 -- Results The API returns the standard p_return_status parameter
315 -- indicating one of the standard return statuses :
316 -- * Unexpected error
317 -- * Error
318 -- * Success
319 -- Parameters Foreign Key columns
320 --
321 -- Version Initial version number = 1.0
322 -- History Current version number = 1.0
323 --=======================================================
324 procedure UPDATE_FOREIGN_KEY (
325 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
326 p_api_version_number IN NUMBER,
327 p_init_msg_tbl IN BOOLEAN := FALSE,
328 p_msg_count OUT NOCOPY NUMBER,
329 p_msg_data OUT NOCOPY VARCHAR2,
330 p_return_status OUT NOCOPY VARCHAR2,
331 p_foreign_key_name IN VARCHAR2,
332 p_database_object_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
333 p_unique_key_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
334 p_application_id IN NUMBER := FND_API.G_MISS_NUM,
335 p_from_to_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
336 p_from_to_description IN VARCHAR2 := FND_API.G_MISS_CHAR,
337 p_to_from_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
338 p_to_from_description IN VARCHAR2 := FND_API.G_MISS_CHAR,
339 p_created_by IN NUMBER := FND_API.G_MISS_NUM,
340 p_creation_date IN DATE := FND_API.G_MISS_DATE,
341 p_last_updated_by IN NUMBER := FND_API.G_MISS_NUM,
342 p_last_update_date IN DATE := FND_API.G_MISS_DATE,
343 p_last_update_login IN NUMBER := FND_API.G_MISS_NUM
344 );
345
349 -- Usage Group API for updating a foreign key column record
346 --=======================================================
347 -- Procedure UPDATE_FOREIGN_KEY_COLUMN
348 --
350 --
351 -- Desc This API calls the private API to update
352 -- a foreign key column record using the given info
353 --
354 -- Results The API returns the standard p_return_status parameter
355 -- indicating one of the standard return statuses :
356 -- * Unexpected error
357 -- * Error
358 -- * Success
359 -- Parameters Foreign Key Column columns
360 --
361 -- Version Initial version number = 1.0
362 -- History Current version number = 1.0
363 --=======================================================
364 procedure UPDATE_FOREIGN_KEY_COLUMN (
365 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
366 p_api_version_number IN NUMBER,
367 p_init_msg_tbl IN BOOLEAN := FALSE,
368 p_msg_count OUT NOCOPY NUMBER,
369 p_msg_data OUT NOCOPY VARCHAR2,
370 p_return_status OUT NOCOPY VARCHAR2,
371 p_foreign_key_name IN VARCHAR2,
372 p_attribute_application_id IN NUMBER,
373 p_attribute_code IN VARCHAR2,
374 p_foreign_key_sequence IN NUMBER := FND_API.G_MISS_NUM,
375 p_created_by IN NUMBER := FND_API.G_MISS_NUM,
376 p_creation_date IN DATE := FND_API.G_MISS_DATE,
377 p_last_updated_by IN NUMBER := FND_API.G_MISS_NUM,
378 p_last_update_date IN DATE := FND_API.G_MISS_DATE,
379 p_last_update_login IN NUMBER := FND_API.G_MISS_NUM
380 );
381
382 --=======================================================
383 -- Procedure UPDATE_UNIQUE_KEY
384 --
385 -- Usage Group API for updating a unique key record
386 --
387 -- Desc This API calls the private API to update
388 -- a unique key record using the given info
389 --
390 -- Results The API returns the standard p_return_status parameter
391 -- indicating one of the standard return statuses :
392 -- * Unexpected error
393 -- * Error
394 -- * Success
395 -- Parameters Unique Key columns
396 --
397 -- Version Initial version number = 1.0
398 -- History Current version number = 1.0
399 --=======================================================
400 procedure UPDATE_UNIQUE_KEY (
401 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
402 p_api_version_number IN NUMBER,
403 p_init_msg_tbl IN BOOLEAN := FALSE,
404 p_msg_count OUT NOCOPY NUMBER,
405 p_msg_data OUT NOCOPY VARCHAR2,
406 p_return_status OUT NOCOPY VARCHAR2,
407 p_unique_key_name IN VARCHAR2,
408 p_database_object_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
409 p_application_id IN NUMBER := FND_API.G_MISS_NUM,
410 p_created_by IN NUMBER := FND_API.G_MISS_NUM,
411 p_creation_date IN DATE := FND_API.G_MISS_DATE,
412 p_last_updated_by IN NUMBER := FND_API.G_MISS_NUM,
413 p_last_update_date IN DATE := FND_API.G_MISS_DATE,
414 p_last_update_login IN NUMBER := FND_API.G_MISS_NUM
415 );
416
417 --=======================================================
418 -- Procedure UPDATE_UNIQUE_KEY_COLUMN
419 --
420 -- Usage Group API for updating a unique key column record
421 --
422 -- Desc This API calls the private API to update
423 -- a uniquekey column record using the given info
424 --
425 -- Results The API returns the standard p_return_status parameter
426 -- indicating one of the standard return statuses :
427 -- * Unexpected error
428 -- * Error
429 -- * Success
430 -- Parameters Unique Key Column columns
431 --
432 -- Version Initial version number = 1.0
433 -- History Current version number = 1.0
434 --=======================================================
435 procedure UPDATE_UNIQUE_KEY_COLUMN (
436 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
437 p_api_version_number IN NUMBER,
438 p_init_msg_tbl IN BOOLEAN := FALSE,
439 p_msg_count OUT NOCOPY NUMBER,
440 p_msg_data OUT NOCOPY VARCHAR2,
441 p_return_status OUT NOCOPY VARCHAR2,
442 p_unique_key_name IN VARCHAR2,
443 p_attribute_application_id IN NUMBER,
444 p_attribute_code IN VARCHAR2,
445 p_unique_key_sequence IN NUMBER := FND_API.G_MISS_NUM,
446 p_created_by IN NUMBER := FND_API.G_MISS_NUM,
447 p_creation_date IN DATE := FND_API.G_MISS_DATE,
448 p_last_updated_by IN NUMBER := FND_API.G_MISS_NUM,
449 p_last_update_date IN DATE := FND_API.G_MISS_DATE,
450 p_last_update_login IN NUMBER := FND_API.G_MISS_NUM
451 );
452
453 end AK_KEY_GRP;
[Home] [Help]