DBA Data[Home] [Help]

PACKAGE BODY: APPS.HR_UCX_INS

Source


1 Package Body hr_ucx_ins as
2 /* $Header: hrucxrhi.pkb 120.0 2005/05/31 03:38 appldev noship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- |                     Private Global Definitions                           |
6 -- ----------------------------------------------------------------------------
7 --
8 g_package  varchar2(33) := '  hr_ucx_ins.';  -- Global package name
9 --
10 -- The following global variables are only to be used by
11 -- the set_base_key_value and pre_insert procedures.
12 --
13 g_ui_context_id_i  number   default null;
14 --
15 -- ----------------------------------------------------------------------------
16 -- |------------------------< set_base_key_value >----------------------------|
17 -- ----------------------------------------------------------------------------
18 procedure set_base_key_value
19   (p_ui_context_id  in  number) is
20 --
21   l_proc       varchar2(72) := g_package||'set_base_key_value';
22 --
23 Begin
24   hr_utility.set_location('Entering:'||l_proc, 10);
25   --
26   hr_ucx_ins.g_ui_context_id_i := p_ui_context_id;
27   --
28   hr_utility.set_location(' Leaving:'||l_proc, 20);
29 End set_base_key_value;
30 --
31 --
32 -- ----------------------------------------------------------------------------
33 -- |------------------------------< insert_dml >------------------------------|
34 -- ----------------------------------------------------------------------------
35 -- {Start Of Comments}
36 --
37 -- Description:
38 --   This procedure controls the actual dml insert logic. The processing of
39 --   this procedure are as follows:
40 --   1) Initialise the object_version_number to 1 if the object_version_number
41 --      is defined as an attribute for this entity.
42 --   2) To set and unset the g_api_dml status as required (as we are about to
43 --      perform dml).
44 --   3) To insert the row into the schema.
45 --   4) To trap any constraint violations that may have occurred.
46 --   5) To raise any other errors.
47 --
48 -- Prerequisites:
49 --   This is an internal private procedure which must be called from the ins
50 --   procedure and must have all mandatory attributes set (except the
51 --   object_version_number which is initialised within this procedure).
52 --
53 -- In Parameters:
54 --   A Pl/Sql record structre.
55 --
56 -- Post Success:
57 --   The specified row will be inserted into the schema.
58 --
59 -- Post Failure:
60 --   On the insert dml failure it is important to note that we always reset the
61 --   g_api_dml status to false.
62 --   If a check, unique or parent integrity constraint violation is raised the
63 --   constraint_error procedure will be called.
64 --   If any other error is reported, the error will be raised after the
65 --   g_api_dml status is reset.
66 --
67 -- Developer Implementation Notes:
68 --   None.
69 --
70 -- Access Status:
71 --   Internal Row Handler Use Only.
72 --
73 -- {End Of Comments}
74 -- ----------------------------------------------------------------------------
75 Procedure insert_dml
76   (p_rec in out nocopy hr_ucx_shd.g_rec_type
77   ) is
78 --
79   l_proc  varchar2(72) := g_package||'insert_dml';
80 --
81 Begin
82   hr_utility.set_location('Entering:'||l_proc, 5);
83   p_rec.object_version_number := 1;  -- Initialise the object version
84   --
85   --
86   --
87   -- Insert the row into: hr_ki_ui_contexts
88   --
89   insert into hr_ki_ui_contexts
90       (ui_context_id
91       ,ui_context_key
92       ,user_interface_id
93       ,label
94       ,location
95       ,object_version_number
96       )
97   Values
98     (p_rec.ui_context_id
99     ,p_rec.ui_context_key
100     ,p_rec.user_interface_id
101     ,p_rec.label
102     ,p_rec.location
103     ,p_rec.object_version_number
104     );
105   --
106   --
107   --
108   hr_utility.set_location(' Leaving:'||l_proc, 10);
109 Exception
110   When hr_api.check_integrity_violated Then
111     -- A check constraint has been violated
112     --
113     hr_ucx_shd.constraint_error
114       (p_constraint_name => hr_api.strip_constraint_name(SQLERRM));
115   When hr_api.parent_integrity_violated Then
116     -- Parent integrity has been violated
117     --
118     hr_ucx_shd.constraint_error
119       (p_constraint_name => hr_api.strip_constraint_name(SQLERRM));
120   When hr_api.unique_integrity_violated Then
121     -- Unique integrity has been violated
122     --
123     hr_ucx_shd.constraint_error
124       (p_constraint_name => hr_api.strip_constraint_name(SQLERRM));
125   When Others Then
126     --
127     Raise;
128 End insert_dml;
129 --
130 -- ----------------------------------------------------------------------------
131 -- |------------------------------< pre_insert >------------------------------|
132 -- ----------------------------------------------------------------------------
133 -- {Start Of Comments}
134 --
135 -- Description:
136 --   This private procedure contains any processing which is required before
137 --   the insert dml. Presently, if the entity has a corresponding primary
138 --   key which is maintained by an associating sequence, the primary key for
139 --   the entity will be populated with the next sequence value in
140 --   preparation for the insert dml.
141 --
142 -- Prerequisites:
143 --   This is an internal procedure which is called from the ins procedure.
144 --
145 -- In Parameters:
146 --   A Pl/Sql record structure.
147 --
148 -- Post Success:
149 --   Processing continues.
150 --
151 -- Post Failure:
152 --   If an error has occurred, an error message and exception will be raised
153 --   but not handled.
154 --
155 -- Developer Implementation Notes:
156 --   Any pre-processing required before the insert dml is issued should be
157 --   coded within this procedure. As stated above, a good example is the
158 --   generation of a primary key number via a corresponding sequence.
159 --   It is important to note that any 3rd party maintenance should be reviewed
160 --   before placing in this procedure.
161 --
162 -- Access Status:
163 --   Internal Row Handler Use Only.
164 --
165 -- {End Of Comments}
166 -- ----------------------------------------------------------------------------
167 Procedure pre_insert
168   (p_rec  in out nocopy hr_ucx_shd.g_rec_type
169   ) is
170 --
171   Cursor C_Sel1 is select hr_ki_ui_contexts_s.nextval from sys.dual;
172 --
173   Cursor C_Sel2 is
174     Select null
175       from hr_ki_ui_contexts
176      where ui_context_id =
177              hr_ucx_ins.g_ui_context_id_i;
178 --
179   l_proc   varchar2(72) := g_package||'pre_insert';
180   l_exists varchar2(1);
181 --
182 Begin
183   hr_utility.set_location('Entering:'||l_proc, 5);
184   --
185   If (hr_ucx_ins.g_ui_context_id_i is not null) Then
186     --
187     -- Verify registered primary key values not already in use
188     --
189     Open C_Sel2;
190     Fetch C_Sel2 into l_exists;
191     If C_Sel2%found Then
192        Close C_Sel2;
193        --
194        -- The primary key values are already in use.
195        --
196        fnd_message.set_name('PER','PER_289391_KEY_ALREADY_USED');
197        fnd_message.set_token('TABLE_NAME','hr_ki_ui_contexts');
198        fnd_message.raise_error;
199     End If;
200     Close C_Sel2;
201     --
202     -- Use registered key values and clear globals
203     --
204     p_rec.ui_context_id :=
205       hr_ucx_ins.g_ui_context_id_i;
206     hr_ucx_ins.g_ui_context_id_i := null;
207   Else
208     --
209     -- No registerd key values, so select the next sequence number
210     --
211     --
212     -- Select the next sequence number
213     --
214     Open C_Sel1;
215     Fetch C_Sel1 Into p_rec.ui_context_id;
216     Close C_Sel1;
217 
218   End If;
219 
220   hr_ucx_shd.construct_ui_context_key
221   (
222    p_rec.user_interface_id
223   ,p_rec.label
224   ,p_rec.ui_context_key
225   );
226 
227 
228   --
229   hr_utility.set_location(' Leaving:'||l_proc, 10);
230 End pre_insert;
231 --
232 -- ----------------------------------------------------------------------------
233 -- |-----------------------------< post_insert >------------------------------|
234 -- ----------------------------------------------------------------------------
235 -- {Start Of Comments}
236 --
237 -- Description:
238 --   This private procedure contains any processing which is required after
239 --   the insert dml.
240 --
241 -- Prerequisites:
242 --   This is an internal procedure which is called from the ins procedure.
243 --
244 -- In Parameters:
245 --   A Pl/Sql record structre.
246 --
247 -- Post Success:
248 --   Processing continues.
249 --
250 -- Post Failure:
251 --   If an error has occurred, an error message and exception will be raised
252 --   but not handled.
253 --
254 -- Developer Implementation Notes:
255 --   Any post-processing required after the insert dml is issued should be
256 --   coded within this procedure. It is important to note that any 3rd party
257 --   maintenance should be reviewed before placing in this procedure.
258 --
259 -- Access Status:
260 --   Internal Row Handler Use Only.
261 --
262 -- {End Of Comments}
263 -- ----------------------------------------------------------------------------
264 Procedure post_insert
265   (p_rec                          in hr_ucx_shd.g_rec_type
266   ) is
267 --
268   l_proc  varchar2(72) := g_package||'post_insert';
269 --
270 Begin
271   hr_utility.set_location('Entering:'||l_proc, 5);
272   begin
273     --
274     hr_ucx_rki.after_insert
275       (p_ui_context_id
276       => p_rec.ui_context_id
277       ,p_ui_context_key
278       => p_rec.ui_context_key
279       ,p_user_interface_id
280       => p_rec.user_interface_id
281       ,p_label
282       => p_rec.label
283       ,p_location
284       => p_rec.location
285       ,p_object_version_number
286       => p_rec.object_version_number
287       );
288     --
289   exception
290     --
291     when hr_api.cannot_find_prog_unit then
292       --
293       hr_api.cannot_find_prog_unit_error
294         (p_module_name => 'HR_KI_UI_CONTEXTS'
295         ,p_hook_type   => 'AI');
296       --
297   end;
298   --
299   hr_utility.set_location(' Leaving:'||l_proc, 10);
300 End post_insert;
301 --
302 -- ----------------------------------------------------------------------------
303 -- |---------------------------------< ins >----------------------------------|
304 -- ----------------------------------------------------------------------------
305 Procedure ins
306   (p_rec                          in out nocopy hr_ucx_shd.g_rec_type
307   ) is
308 --
309   l_proc  varchar2(72) := g_package||'ins';
310 --
311 Begin
312   hr_utility.set_location('Entering:'||l_proc, 5);
313   --
314   -- Call the supporting insert validate operations
315   --
316   hr_ucx_bus.insert_validate
317      (p_rec
318      );
319   --
320   -- Call to raise any errors on multi-message list
321   hr_multi_message.end_validation_set;
322   --
323   -- Call the supporting pre-insert operation
324   --
325   hr_ucx_ins.pre_insert(p_rec);
326   --
327   -- Insert the row
328   --
329   hr_ucx_ins.insert_dml(p_rec);
330   --
331   -- Call the supporting post-insert operation
332   --
333   hr_ucx_ins.post_insert
334      (p_rec
335      );
336   --
337   -- Call to raise any errors on multi-message list
338   hr_multi_message.end_validation_set;
339   --
340   hr_utility.set_location('Leaving:'||l_proc, 20);
341 end ins;
342 --
343 -- ----------------------------------------------------------------------------
344 -- |---------------------------------< ins >----------------------------------|
345 -- ----------------------------------------------------------------------------
346 Procedure ins
347   (p_ui_context_key                 in     varchar2 default null
348   ,p_user_interface_id              in     number
349   ,p_label                          in     varchar2
350   ,p_location                       in     varchar2
351   ,p_ui_context_id                     out nocopy number
352   ,p_object_version_number             out nocopy number
353   ) is
354 --
355   l_rec   hr_ucx_shd.g_rec_type;
356   l_proc  varchar2(72) := g_package||'ins';
357 --
358 Begin
359   hr_utility.set_location('Entering:'||l_proc, 5);
360   --
361   -- Call conversion function to turn arguments into the
362   -- p_rec structure.
363   --
364   l_rec :=
365   hr_ucx_shd.convert_args
366     (null
367     ,p_ui_context_key
368     ,p_user_interface_id
369     ,p_label
370     ,p_location
371     ,null
372     );
373   --
374   -- Having converted the arguments into the hr_ucx_rec
375   -- plsql record structure we call the corresponding record business process.
376   --
377   hr_ucx_ins.ins
378      (l_rec
379      );
380   --
381   -- As the primary key argument(s)
382   -- are specified as an OUT's we must set these values.
383   --
384   p_ui_context_id := l_rec.ui_context_id;
385   p_object_version_number := l_rec.object_version_number;
386   --
387   hr_utility.set_location(' Leaving:'||l_proc, 10);
388 End ins;
389 --
390 end hr_ucx_ins;