1 package AK_OBJECT3_PVT as
2 /* $Header: akdvob3s.pls 120.2 2005/09/15 22:26:56 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_OBJECT3_PVT';
8
9 -- Procedure specs
10
11 --=======================================================
12 -- Procedure UPDATE_ATTRIBUTE
13 --
14 -- Usage Private API for updating an object attribute.
15 -- This API should only be called by other APIs
16 -- that are owned by the Core Modules Team (AK).
17 --
18 -- Desc This API updates an object attribute using the given info
19 --
20 -- Results The API returns the standard p_return_status parameter
21 -- indicating one of the standard return statuses :
22 -- * Unexpected error
23 -- * Error
24 -- * Success
25 -- Parameters Object Attribute columns
26 -- p_loader_timestamp : IN optional
27 -- If a timestamp is passed, the API will update the
28 -- record using this timestamp. Only the upload API
29 -- should call with this parameter loaded.
30 --
31 -- Version Initial version number = 1.0
32 -- History Current version number = 1.0
33 --=======================================================
34 procedure UPDATE_ATTRIBUTE (
35 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
36 p_api_version_number IN NUMBER,
37 p_init_msg_tbl IN BOOLEAN := FALSE,
38 p_msg_count OUT NOCOPY NUMBER,
39 p_msg_data OUT NOCOPY VARCHAR2,
40 p_return_status OUT NOCOPY VARCHAR2,
41 p_database_object_name IN VARCHAR2,
42 p_attribute_application_id IN NUMBER,
43 p_attribute_code IN VARCHAR2,
44 p_column_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
45 p_attribute_label_length IN NUMBER := FND_API.G_MISS_NUM,
46 p_display_value_length IN NUMBER := FND_API.G_MISS_NUM,
47 p_bold IN VARCHAR2 := FND_API.G_MISS_CHAR,
48 p_italic IN VARCHAR2 := FND_API.G_MISS_CHAR,
49 p_vertical_alignment IN VARCHAR2 := FND_API.G_MISS_CHAR,
50 p_horizontal_alignment IN VARCHAR2 := FND_API.G_MISS_CHAR,
51 p_data_source_type IN VARCHAR2 := FND_API.G_MISS_CHAR,
52 p_data_storage_type IN VARCHAR2 := FND_API.G_MISS_CHAR,
53 p_table_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
54 p_base_table_column_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
55 p_required_flag IN VARCHAR2 := FND_API.G_MISS_CHAR,
56 p_default_value_varchar2 IN VARCHAR2 := FND_API.G_MISS_CHAR,
57 p_default_value_number IN NUMBER := FND_API.G_MISS_NUM,
58 p_default_value_date IN DATE := FND_API.G_MISS_DATE,
59 p_lov_region_application_id IN NUMBER := FND_API.G_MISS_NUM,
60 p_lov_region_code IN VARCHAR2 := FND_API.G_MISS_CHAR,
61 p_lov_foreign_key_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
62 p_lov_attribute_application_id IN NUMBER := FND_API.G_MISS_NUM,
63 p_lov_attribute_code IN VARCHAR2 := FND_API.G_MISS_CHAR,
64 p_defaulting_api_pkg IN VARCHAR2 := FND_API.G_MISS_CHAR,
65 p_defaulting_api_proc IN VARCHAR2 := FND_API.G_MISS_CHAR,
66 p_validation_api_pkg IN VARCHAR2 := FND_API.G_MISS_CHAR,
67 p_validation_api_proc IN VARCHAR2 := FND_API.G_MISS_CHAR,
68 p_attribute_category IN VARCHAR2 := FND_API.G_MISS_CHAR,
69 p_attribute1 IN VARCHAR2 := FND_API.G_MISS_CHAR,
70 p_attribute2 IN VARCHAR2 := FND_API.G_MISS_CHAR,
71 p_attribute3 IN VARCHAR2 := FND_API.G_MISS_CHAR,
72 p_attribute4 IN VARCHAR2 := FND_API.G_MISS_CHAR,
73 p_attribute5 IN VARCHAR2 := FND_API.G_MISS_CHAR,
74 p_attribute6 IN VARCHAR2 := FND_API.G_MISS_CHAR,
75 p_attribute7 IN VARCHAR2 := FND_API.G_MISS_CHAR,
76 p_attribute8 IN VARCHAR2 := FND_API.G_MISS_CHAR,
77 p_attribute9 IN VARCHAR2 := FND_API.G_MISS_CHAR,
78 p_attribute10 IN VARCHAR2 := FND_API.G_MISS_CHAR,
79 p_attribute11 IN VARCHAR2 := FND_API.G_MISS_CHAR,
80 p_attribute12 IN VARCHAR2 := FND_API.G_MISS_CHAR,
81 p_attribute13 IN VARCHAR2 := FND_API.G_MISS_CHAR,
82 p_attribute14 IN VARCHAR2 := FND_API.G_MISS_CHAR,
83 p_attribute15 IN VARCHAR2 := FND_API.G_MISS_CHAR,
84 p_attribute_label_long IN VARCHAR2 := FND_API.G_MISS_CHAR,
85 p_attribute_label_short IN VARCHAR2 := FND_API.G_MISS_CHAR,
86 p_created_by IN NUMBER := FND_API.G_MISS_NUM,
87 p_creation_date IN DATE := FND_API.G_MISS_DATE,
88 p_last_updated_by IN NUMBER := FND_API.G_MISS_NUM,
89 p_last_update_date IN DATE := FND_API.G_MISS_DATE,
90 p_last_update_login IN NUMBER := FND_API.G_MISS_NUM,
91 p_loader_timestamp IN DATE := FND_API.G_MISS_DATE,
92 p_pass IN NUMBER,
93 p_copy_redo_flag IN OUT NOCOPY BOOLEAN
94 );
95
96 --=======================================================
97 -- Procedure UPDATE_ATTRIBUTE_NAVIGATION
98 --
99 -- Usage Private API for updating an attribute navigation
100 -- record. This API should only be called by other APIs
101 -- that are owned by the Core Modules Team (AK).
102 --
103 -- Desc This API updates an attribute navigation record
104 -- using the given info
105 --
106 -- Results The API returns the standard p_return_status parameter
107 -- indicating one of the standard return statuses :
108 -- * Unexpected error
109 -- * Error
110 -- * Success
111 -- Parameters Attribute Navigation columns
112 -- p_loader_timestamp : IN optional
113 -- If a timestamp is passed, the API will update the
114 -- record using this timestamp. Only the upload API
115 -- should call with this parameter loaded.
116 --
117 -- Version Initial version number = 1.0
118 -- History Current version number = 1.0
119 --=======================================================
120 procedure UPDATE_ATTRIBUTE_NAVIGATION (
121 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
122 p_api_version_number IN NUMBER,
123 p_init_msg_tbl IN BOOLEAN := FALSE,
124 p_msg_count OUT NOCOPY NUMBER,
125 p_msg_data OUT NOCOPY VARCHAR2,
126 p_return_status OUT NOCOPY VARCHAR2,
127 p_database_object_name IN VARCHAR2,
128 p_attribute_application_id IN NUMBER,
129 p_attribute_code IN VARCHAR2,
130 p_value_varchar2 IN VARCHAR2,
131 p_value_date IN DATE,
132 p_value_number IN NUMBER,
133 p_to_region_appl_id IN NUMBER := FND_API.G_MISS_NUM,
134 p_to_region_code IN VARCHAR2 := FND_API.G_MISS_CHAR,
135 p_attribute_category IN VARCHAR2 := FND_API.G_MISS_CHAR,
136 p_attribute1 IN VARCHAR2 := FND_API.G_MISS_CHAR,
137 p_attribute2 IN VARCHAR2 := FND_API.G_MISS_CHAR,
138 p_attribute3 IN VARCHAR2 := FND_API.G_MISS_CHAR,
139 p_attribute4 IN VARCHAR2 := FND_API.G_MISS_CHAR,
140 p_attribute5 IN VARCHAR2 := FND_API.G_MISS_CHAR,
141 p_attribute6 IN VARCHAR2 := FND_API.G_MISS_CHAR,
142 p_attribute7 IN VARCHAR2 := FND_API.G_MISS_CHAR,
143 p_attribute8 IN VARCHAR2 := FND_API.G_MISS_CHAR,
144 p_attribute9 IN VARCHAR2 := FND_API.G_MISS_CHAR,
145 p_attribute10 IN VARCHAR2 := FND_API.G_MISS_CHAR,
146 p_attribute11 IN VARCHAR2 := FND_API.G_MISS_CHAR,
147 p_attribute12 IN VARCHAR2 := FND_API.G_MISS_CHAR,
148 p_attribute13 IN VARCHAR2 := FND_API.G_MISS_CHAR,
149 p_attribute14 IN VARCHAR2 := FND_API.G_MISS_CHAR,
150 p_attribute15 IN VARCHAR2 := FND_API.G_MISS_CHAR,
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 p_loader_timestamp IN DATE := FND_API.G_MISS_DATE,
157 p_pass IN NUMBER,
158 p_copy_redo_flag IN OUT NOCOPY BOOLEAN
159 );
160
161 --=======================================================
162 -- Procedure UPDATE_ATTRIBUTE_VALUE
163 --
164 -- Usage Private API for updating an attribute value record.
165 -- This API should only be called by other APIs
166 -- that are owned by the Core Modules Team (AK).
167 --
168 -- Desc This API updates an attribute value record
169 -- using the given info
170 --
171 -- Results The API returns the standard p_return_status parameter
172 -- indicating one of the standard return statuses :
173 -- * Unexpected error
174 -- * Error
175 -- * Success
176 -- Parameters Attribute Value columns
177 -- p_loader_timestamp : IN optional
178 -- If a timestamp is passed, the API will update the
179 -- record using this timestamp. Only the upload API
180 -- should call with this parameter loaded.
181 --
182 -- Version Initial version number = 1.0
183 -- History Current version number = 1.0
184 --=======================================================
185 procedure UPDATE_ATTRIBUTE_VALUE (
186 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
187 p_api_version_number IN NUMBER,
188 p_init_msg_tbl IN BOOLEAN := FALSE,
189 p_msg_count OUT NOCOPY NUMBER,
190 p_msg_data OUT NOCOPY VARCHAR2,
191 p_return_status OUT NOCOPY VARCHAR2,
192 p_database_object_name IN VARCHAR2,
193 p_attribute_application_id IN NUMBER,
194 p_attribute_code IN VARCHAR2,
195 p_key_value1 IN VARCHAR2,
196 p_key_value2 IN VARCHAR2 := FND_API.G_MISS_CHAR,
197 p_key_value3 IN VARCHAR2 := FND_API.G_MISS_CHAR,
198 p_key_value4 IN VARCHAR2 := FND_API.G_MISS_CHAR,
199 p_key_value5 IN VARCHAR2 := FND_API.G_MISS_CHAR,
200 p_key_value6 IN VARCHAR2 := FND_API.G_MISS_CHAR,
201 p_key_value7 IN VARCHAR2 := FND_API.G_MISS_CHAR,
202 p_key_value8 IN VARCHAR2 := FND_API.G_MISS_CHAR,
203 p_key_value9 IN VARCHAR2 := FND_API.G_MISS_CHAR,
204 p_key_value10 IN VARCHAR2 := FND_API.G_MISS_CHAR,
205 p_value_varchar2 IN VARCHAR2 := FND_API.G_MISS_CHAR,
206 p_value_date IN DATE := FND_API.G_MISS_DATE,
207 p_value_number IN NUMBER := FND_API.G_MISS_NUM,
208 p_created_by IN NUMBER := FND_API.G_MISS_NUM,
209 p_creation_date IN DATE := FND_API.G_MISS_DATE,
210 p_last_updated_by IN NUMBER := FND_API.G_MISS_NUM,
211 p_last_update_date IN DATE := FND_API.G_MISS_DATE,
212 p_last_update_login IN NUMBER := FND_API.G_MISS_NUM,
213 p_loader_timestamp IN DATE := FND_API.G_MISS_DATE
214 );
215
216 --=======================================================
217 -- Procedure UPDATE_OBJECT
218 --
219 -- Usage Private API for updating an object.
220 -- This API should only be called by other APIs
221 -- that are owned by the Core Modules Team (AK).
222 --
223 -- Desc This API updates an object using the given info
224 --
225 -- Results The API returns the standard p_return_status parameter
226 -- indicating one of the standard return statuses :
227 -- * Unexpected error
228 -- * Error
229 -- * Success
230 -- Parameters Object columns
231 -- p_loader_timestamp : IN optional
232 -- If a timestamp is passed, the API will update the
233 -- record using this timestamp. Only the upload API
234 -- should call with this parameter loaded.
235 --
236 -- Version Initial version number = 1.0
237 -- History Current version number = 1.0
238 --=======================================================
239 procedure UPDATE_OBJECT (
240 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
241 p_api_version_number IN NUMBER,
242 p_init_msg_tbl IN BOOLEAN := FALSE,
243 p_msg_count OUT NOCOPY NUMBER,
244 p_msg_data OUT NOCOPY VARCHAR2,
245 p_return_status OUT NOCOPY VARCHAR2,
246 p_database_object_name IN VARCHAR2,
247 p_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
248 p_description IN VARCHAR2 := FND_API.G_MISS_CHAR,
249 p_application_id IN NUMBER := FND_API.G_MISS_NUM,
250 p_primary_key_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
251 p_defaulting_api_pkg IN VARCHAR2 := FND_API.G_MISS_CHAR,
252 p_defaulting_api_proc IN VARCHAR2 := FND_API.G_MISS_CHAR,
253 p_validation_api_pkg IN VARCHAR2 := FND_API.G_MISS_CHAR,
254 p_validation_api_proc IN VARCHAR2 := FND_API.G_MISS_CHAR,
255 p_attribute_category IN VARCHAR2 := FND_API.G_MISS_CHAR,
256 p_attribute1 IN VARCHAR2 := FND_API.G_MISS_CHAR,
257 p_attribute2 IN VARCHAR2 := FND_API.G_MISS_CHAR,
258 p_attribute3 IN VARCHAR2 := FND_API.G_MISS_CHAR,
259 p_attribute4 IN VARCHAR2 := FND_API.G_MISS_CHAR,
260 p_attribute5 IN VARCHAR2 := FND_API.G_MISS_CHAR,
261 p_attribute6 IN VARCHAR2 := FND_API.G_MISS_CHAR,
262 p_attribute7 IN VARCHAR2 := FND_API.G_MISS_CHAR,
263 p_attribute8 IN VARCHAR2 := FND_API.G_MISS_CHAR,
264 p_attribute9 IN VARCHAR2 := FND_API.G_MISS_CHAR,
265 p_attribute10 IN VARCHAR2 := FND_API.G_MISS_CHAR,
266 p_attribute11 IN VARCHAR2 := FND_API.G_MISS_CHAR,
267 p_attribute12 IN VARCHAR2 := FND_API.G_MISS_CHAR,
268 p_attribute13 IN VARCHAR2 := FND_API.G_MISS_CHAR,
269 p_attribute14 IN VARCHAR2 := FND_API.G_MISS_CHAR,
270 p_attribute15 IN VARCHAR2 := FND_API.G_MISS_CHAR,
271 p_created_by IN NUMBER := FND_API.G_MISS_NUM,
272 p_creation_date IN DATE := FND_API.G_MISS_DATE,
273 p_last_updated_by IN NUMBER := FND_API.G_MISS_NUM,
274 p_last_update_date IN DATE := FND_API.G_MISS_DATE,
275 p_last_update_login IN NUMBER := FND_API.G_MISS_NUM,
276 p_loader_timestamp IN DATE := FND_API.G_MISS_DATE,
277 p_pass IN NUMBER,
278 p_copy_redo_flag IN OUT NOCOPY BOOLEAN
279 );
280
281 --=======================================================
282 -- Procedure UPLOAD_OBJECT
283 --
284 -- Usage Private API for loading objects from a
285 -- loader file to the database.
286 -- This API should only be called by other APIs
287 -- that are owned by the Core Modules Team (AK).
288 --
289 -- Desc This API reads the object data (including object
290 -- attributes, foreign and unique key definitions,
291 -- attribute values, and attribute navigation records) stored
292 -- in the loader file currently being processed, parses
293 -- the data, and loads them to the database. The tables
294 -- are updated with the timestamp passed. This API
295 -- will process the file until the EOF is reached,
296 -- a parse error is encountered, or when data for
297 -- a different business object is read from the file.
298 --
299 -- Results The API returns the standard p_return_status parameter
300 -- indicating one of the standard return statuses :
304 -- Parameters p_index : IN OUT required
301 -- * Unexpected error
302 -- * Error
303 -- * Success
305 -- Index of PL/SQL file to be processed.
306 -- p_loader_timestamp : IN required
307 -- The timestamp to be used when creating or updating
308 -- records
309 -- p_line_num : IN optional
310 -- The first line number in the file to be processed.
311 -- It is used for keeping track of the line number
312 -- read so that this info can be included in the
313 -- error message when a parse error occurred.
314 -- p_buffer : IN required
315 -- The content of the first line to be processed.
316 -- The calling API has already read the first line
317 -- that needs to be parsed by this API, so this
318 -- line won't be read from the file again.
319 -- p_line_num_out : OUT
320 -- The number of the last line in the loader file
321 -- that is read by this API.
322 -- p_buffer_out : OUT
323 -- The content of the last line read by this API.
324 -- If an EOF has not reached, this line would
325 -- contain the beginning of another business object
326 -- that will need to be processed by another API.
327 --
328 -- Version Initial version number = 1.0
329 -- History Current version number = 1.0
330 --=======================================================
331 procedure UPLOAD_OBJECT (
332 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
333 p_api_version_number IN NUMBER,
334 p_return_status OUT NOCOPY VARCHAR2,
335 p_index IN OUT NOCOPY NUMBER,
336 p_loader_timestamp IN DATE,
337 p_line_num IN NUMBER := FND_API.G_MISS_NUM,
338 p_buffer IN AK_ON_OBJECTS_PUB.Buffer_Type,
339 p_line_num_out OUT NOCOPY NUMBER,
340 p_buffer_out OUT NOCOPY AK_ON_OBJECTS_PUB.Buffer_Type,
341 p_upl_loader_cur IN OUT NOCOPY AK_ON_OBJECTS_PUB.LoaderCurTyp,
342 p_pass IN NUMBER := 1
343 );
344
345 end AK_OBJECT3_PVT;
[Home] [Help]