DBA Data[Home] [Help]

PACKAGE: APPS.AMS_XML_ELEMENT_PVT

Source


1 PACKAGE AMS_Xml_Element_PVT AUTHID CURRENT_USER AS
2 /* $Header: amsvxels.pls 115.4 2002/11/12 23:43:46 jieli noship $ */
3 -- ===============================================================
4 -- Start of Comments
5 -- Package name
6 --          AMS_Xml_Element_PVT
7 -- Purpose
8 --    Manage XML Elements.
9 --
10 -- History
11 --    05/13/2002 DMVINCEN  Created.
12 --
13 -- NOTE
14 --
15 -- End of Comments
16 -- ===============================================================
17 
18 -- Default number of records fetch per call
19 G_DEFAULT_NUM_REC_FETCH  NUMBER := 30;
20 
21 --
22 -- Corresponding type def for the PL/SQL data type "JTF_NUMBER_TABLE"
23 -- since Rosetta does not support nested tables.
24 --
25 TYPE num_data_set_type_w IS
26   TABLE OF NUMBER INDEX BY BINARY_INTEGER;
27 
28 --
29 -- Corresponding type def for the PL/SQL data type "JTF_NUMBER_TABLE"
30 -- since Rosetta does not support nested tables.
31 --
32 TYPE varchar2_2000_set_type IS
33 	TABLE OF VARCHAR2(2000) INDEX BY BINARY_INTEGER;
34 
35 --===================================================================
36 --    Start of Comments
37 --   -------------------------------------------------------
38 --    Record name
39 --             xml_element_rec_type
40 --   -------------------------------------------------------
41 --   Parameters:
42 --       imp_xml_element_id
43 --       last_updated_by
44 --       object_version_number
45 --       created_by
46 --       last_update_login
47 --       last_update_date
48 --       creation_date
49 --       imp_xml_document_id
50 --       order_initial
51 --       order_final
52 --       column_name
53 --       data
54 --       num_attr
55 --       data_type
56 --       load_status
57 --       error_text
58 --
59 --    Required
60 --
61 --    Defaults
62 --
63 --    Note: This is automatic generated record definition, it includes all columns
64 --          defined in the table, developer must manually add or delete some of the attributes.
65 --
66 --   End of Comments
67 
68 --===================================================================
69 TYPE xml_element_rec_type IS RECORD
70 (
71        imp_xml_element_id              NUMBER := FND_API.G_MISS_NUM,
72        last_updated_by                 NUMBER := FND_API.G_MISS_NUM,
73        object_version_number           NUMBER := FND_API.G_MISS_NUM,
74        created_by                      NUMBER := FND_API.G_MISS_NUM,
75        last_update_login               NUMBER := FND_API.G_MISS_NUM,
76        last_update_date                DATE := FND_API.G_MISS_DATE,
77        creation_date                   DATE := FND_API.G_MISS_DATE,
78        imp_xml_document_id             NUMBER := FND_API.G_MISS_NUM,
79        order_initial                   NUMBER := FND_API.G_MISS_NUM,
80        order_final                     NUMBER := FND_API.G_MISS_NUM,
81        column_name                     VARCHAR2(2000) := FND_API.G_MISS_CHAR,
82        data                            VARCHAR2(2000) := FND_API.G_MISS_CHAR,
83        num_attr                        NUMBER := FND_API.G_MISS_NUM,
84        data_type                       VARCHAR2(1) := FND_API.G_MISS_CHAR,
85        load_status                     VARCHAR2(30) := FND_API.G_MISS_CHAR,
86        error_text                      VARCHAR2(250) := FND_API.G_MISS_CHAR
87 );
88 
89 g_miss_xml_element_rec          xml_element_rec_type;
90 TYPE  xml_element_tbl_type      IS TABLE OF xml_element_rec_type INDEX BY BINARY_INTEGER;
91 g_miss_xml_element_tbl          xml_element_tbl_type;
92 
93 --   ==============================================================================
94 --    Start of Comments
95 --   ==============================================================================
96 --   API Name
97 --           Create_Xml_Element
98 --   Type
99 --           Private
100 --   Pre-Req
101 --
102 --   Parameters
103 --
104 --   IN
105 --       p_api_version_number      IN   NUMBER     Required
106 --       p_init_msg_list           IN   VARCHAR2   Optional  Default = FND_API_G_FALSE
107 --       p_commit                  IN   VARCHAR2   Optional  Default = FND_API.G_FALSE
108 --       p_validation_level        IN   NUMBER     Optional  Default = FND_API.G_VALID_LEVEL_FULL
109 --       p_xml_element_rec            IN   xml_element_rec_type  Required
110 --
111 --   OUT
112 --       x_return_status           OUT  VARCHAR2
113 --       x_msg_count               OUT  NUMBER
114 --       x_msg_data                OUT  VARCHAR2
115 --   Version : Current version 1.0
116 --   Note: This automatic generated procedure definition, it includes standard IN/OUT parameters
117 --         and basic operation, developer must manually add parameters and business logic as necessary.
118 --
119 --   End of Comments
120 --   ==============================================================================
121 --
122 
123 PROCEDURE Create_Xml_Element(
124     p_api_version_number         IN   NUMBER,
125     p_init_msg_list              IN   VARCHAR2     := FND_API.G_FALSE,
126     p_commit                     IN   VARCHAR2     := FND_API.G_FALSE,
127     p_validation_level           IN   NUMBER       := FND_API.G_VALID_LEVEL_FULL,
128 
129     x_return_status              OUT NOCOPY  VARCHAR2,
130     x_msg_count                  OUT NOCOPY  NUMBER,
131     x_msg_data                   OUT NOCOPY  VARCHAR2,
132 
133     p_xml_element_rec               IN   xml_element_rec_type  := g_miss_xml_element_rec,
134     x_imp_xml_element_id                   OUT NOCOPY  NUMBER
135      );
136 
137 --   ==============================================================================
138 --    Start of Comments
139 --   ==============================================================================
140 --   API Name
141 --           Update_Xml_Element
142 --   Type
143 --           Private
144 --   Pre-Req
145 --
146 --   Parameters
147 --
148 --   IN
149 --       p_api_version_number      IN   NUMBER     Required
150 --       p_init_msg_list           IN   VARCHAR2   Optional  Default = FND_API_G_FALSE
151 --       p_commit                  IN   VARCHAR2   Optional  Default = FND_API.G_FALSE
152 --       p_validation_level        IN   NUMBER     Optional  Default = FND_API.G_VALID_LEVEL_FULL
153 --       p_xml_element_rec            IN   xml_element_rec_type  Required
154 --
155 --   OUT
156 --       x_return_status           OUT  VARCHAR2
157 --       x_msg_count               OUT  NUMBER
158 --       x_msg_data                OUT  VARCHAR2
159 --   Version : Current version 1.0
160 --   Note: This automatic generated procedure definition, it includes standard IN/OUT parameters
161 --         and basic operation, developer must manually add parameters and business logic as necessary.
162 --
163 --   End of Comments
164 --   ==============================================================================
165 --
166 
167 PROCEDURE Update_Error_Xml_Element (
168     p_api_version_number         IN   NUMBER,
169     p_init_msg_list              IN   VARCHAR2     := FND_API.G_FALSE,
170     p_commit                     IN   VARCHAR2     := FND_API.G_FALSE,
171     p_validation_level           IN   NUMBER       := FND_API.G_VALID_LEVEL_FULL,
172     p_xml_element_rec            IN   xml_element_rec_type,
173 	 p_xml_element_ids            IN   num_data_set_type_w,
174 	 p_xml_elements_data          IN   varchar2_2000_set_type,
175 	 p_xml_elements_col_name      IN   varchar2_2000_set_type,
176 	 x_return_status              OUT NOCOPY  VARCHAR2,
177     x_msg_count                  OUT NOCOPY  NUMBER,
178     x_msg_data                   OUT NOCOPY  VARCHAR2,
179     x_object_version_number      OUT NOCOPY  NUMBER
180     );
181 
182 
183 
184 --   ==============================================================================
185 --    Start of Comments
186 --   ==============================================================================
187 --   API Name
188 --           Update_Xml_Element
189 --   Type
190 --           Private
191 --   Pre-Req
192 --
193 --   Parameters
194 --
195 --   IN
196 --       p_api_version_number      IN   NUMBER     Required
197 --       p_init_msg_list           IN   VARCHAR2   Optional  Default = FND_API_G_FALSE
198 --       p_commit                  IN   VARCHAR2   Optional  Default = FND_API.G_FALSE
199 --       p_validation_level        IN   NUMBER     Optional  Default = FND_API.G_VALID_LEVEL_FULL
200 --       p_xml_element_rec            IN   xml_element_rec_type  Required
201 --
202 --   OUT
203 --       x_return_status           OUT  VARCHAR2
204 --       x_msg_count               OUT  NUMBER
205 --       x_msg_data                OUT  VARCHAR2
206 --   Version : Current version 1.0
207 --   Note: This automatic generated procedure definition, it includes standard IN/OUT parameters
208 --         and basic operation, developer must manually add parameters and business logic as necessary.
209 --
210 --   End of Comments
211 --   ==============================================================================
212 --
213 
214 PROCEDURE Update_Xml_Element(
215     p_api_version_number         IN   NUMBER,
216     p_init_msg_list              IN   VARCHAR2     := FND_API.G_FALSE,
217     p_commit                     IN   VARCHAR2     := FND_API.G_FALSE,
218     p_validation_level           IN  NUMBER       := FND_API.G_VALID_LEVEL_FULL,
219 
220     x_return_status              OUT NOCOPY  VARCHAR2,
221     x_msg_count                  OUT NOCOPY  NUMBER,
222     x_msg_data                   OUT NOCOPY  VARCHAR2,
223 
224     p_xml_element_rec               IN    xml_element_rec_type,
225     x_object_version_number      OUT NOCOPY  NUMBER
226     );
227 
228 --   ==============================================================================
229 --    Start of Comments
230 --   ==============================================================================
231 --   API Name
232 --           Delete_Xml_Element
233 --   Type
234 --           Private
235 --   Pre-Req
236 --
237 --   Parameters
238 --
239 --   IN
240 --       p_api_version_number      IN   NUMBER     Required
241 --       p_init_msg_list           IN   VARCHAR2   Optional  Default = FND_API_G_FALSE
242 --       p_commit                  IN   VARCHAR2   Optional  Default = FND_API.G_FALSE
243 --       p_validation_level        IN   NUMBER     Optional  Default = FND_API.G_VALID_LEVEL_FULL
244 --       p_IMP_XML_ELEMENT_ID                IN   NUMBER
245 --       p_object_version_number   IN   NUMBER     Optional  Default = NULL
246 --
247 --   OUT
248 --       x_return_status           OUT  VARCHAR2
249 --       x_msg_count               OUT  NUMBER
250 --       x_msg_data                OUT  VARCHAR2
251 --   Version : Current version 1.0
252 --   Note: This automatic generated procedure definition, it includes standard IN/OUT parameters
253 --         and basic operation, developer must manually add parameters and business logic as necessary.
254 --
255 --   End of Comments
256 --   ==============================================================================
257 --
258 
259 PROCEDURE Delete_Xml_Element(
260     p_api_version_number         IN   NUMBER,
261     p_init_msg_list              IN   VARCHAR2     := FND_API.G_FALSE,
262     p_commit                     IN   VARCHAR2     := FND_API.G_FALSE,
263     p_validation_level           IN   NUMBER       := FND_API.G_VALID_LEVEL_FULL,
264     x_return_status              OUT NOCOPY  VARCHAR2,
265     x_msg_count                  OUT NOCOPY  NUMBER,
266     x_msg_data                   OUT NOCOPY  VARCHAR2,
267     p_imp_xml_element_id                   IN  NUMBER,
268     p_object_version_number      IN   NUMBER
269     );
270 
271 --   ==============================================================================
272 --    Start of Comments
273 --   ==============================================================================
274 --   API Name
275 --           Lock_Xml_Element
276 --   Type
277 --           Private
278 --   Pre-Req
279 --
280 --   Parameters
281 --
282 --   IN
283 --       p_api_version_number      IN   NUMBER     Required
284 --       p_init_msg_list           IN   VARCHAR2   Optional  Default = FND_API_G_FALSE
285 --       p_commit                  IN   VARCHAR2   Optional  Default = FND_API.G_FALSE
286 --       p_validation_level        IN   NUMBER     Optional  Default = FND_API.G_VALID_LEVEL_FULL
287 --       p_xml_element_rec            IN   xml_element_rec_type  Required
288 --
289 --   OUT
290 --       x_return_status           OUT  VARCHAR2
291 --       x_msg_count               OUT  NUMBER
292 --       x_msg_data                OUT  VARCHAR2
293 --   Version : Current version 1.0
294 --   Note: This automatic generated procedure definition, it includes standard IN/OUT parameters
295 --         and basic operation, developer must manually add parameters and business logic as necessary.
296 --
297 --   End of Comments
298 --   ==============================================================================
299 --
300 
301 PROCEDURE Lock_Xml_Element(
302     p_api_version_number         IN   NUMBER,
303     p_init_msg_list              IN   VARCHAR2     := FND_API.G_FALSE,
304 
305     x_return_status              OUT NOCOPY  VARCHAR2,
306     x_msg_count                  OUT NOCOPY  NUMBER,
307     x_msg_data                   OUT NOCOPY  VARCHAR2,
308 
309     p_imp_xml_element_id                   IN  NUMBER,
310     p_object_version             IN  NUMBER
311     );
312 
313 
314 -- Start of Comments
315 --
316 --  validation procedures
317 --
318 -- p_validation_mode is a constant defined in null_UTILITY_PVT package
319 --                  For create: G_CREATE, for update: G_UPDATE
320 -- Note: 1. This is automated generated item level validation procedure.
321 --          The actual validation detail is needed to be added.
322 --       2. We can also validate table instead of record. There will be an option for user to choose.
323 -- End of Comments
324 
325 PROCEDURE Validate_xml_element(
326     p_api_version_number         IN   NUMBER,
327     p_init_msg_list              IN   VARCHAR2     := FND_API.G_FALSE,
328     p_validation_level           IN   NUMBER := FND_API.G_VALID_LEVEL_FULL,
329     p_xml_element_rec               IN   xml_element_rec_type,
330     p_validation_mode            IN    VARCHAR2,
331     x_return_status              OUT NOCOPY  VARCHAR2,
332     x_msg_count                  OUT NOCOPY  NUMBER,
333     x_msg_data                   OUT NOCOPY  VARCHAR2
334     );
335 
336 -- Start of Comments
337 --
338 --  validation procedures
339 --
340 -- p_validation_mode is a constant defined in null_UTILITY_PVT package
341 --                  For create: G_CREATE, for update: G_UPDATE
342 -- Note: 1. This is automated generated item level validation procedure.
343 --          The actual validation detail is needed to be added.
344 --       2. Validate the unique keys, lookups here
345 -- End of Comments
346 
347 PROCEDURE Check_xml_element_Items (
348     P_xml_element_rec     IN    xml_element_rec_type,
349     p_validation_mode  IN    VARCHAR2,
350     x_return_status    OUT NOCOPY   VARCHAR2
351     );
352 
353 -- Start of Comments
354 --
355 -- Record level validation procedures
356 --
357 -- p_validation_mode is a constant defined in null_UTILITY_PVT package
358 --                  For create: G_CREATE, for update: G_UPDATE
359 -- Note: 1. This is automated generated item level validation procedure.
360 --          The actual validation detail is needed to be added.
361 --       2. Developer can manually added inter-field level validation.
362 -- End of Comments
363 
364 PROCEDURE Validate_xml_element_rec(
365     p_api_version_number         IN   NUMBER,
366     p_init_msg_list              IN   VARCHAR2     := FND_API.G_FALSE,
367     x_return_status              OUT NOCOPY  VARCHAR2,
368     x_msg_count                  OUT NOCOPY  NUMBER,
369     x_msg_data                   OUT NOCOPY  VARCHAR2,
370     p_xml_element_rec               IN    xml_element_rec_type
371     );
372 END AMS_Xml_Element_PVT;