DBA Data[Home] [Help]

PACKAGE BODY: APPS.HR_ITF_INS

Source


1 Package Body hr_itf_ins  as
2 /* $Header: hritfrhi.pkb 120.0 2005/05/31 00:58 appldev noship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- |                     Private Global Definitions                           |
6 -- ----------------------------------------------------------------------------
7 --
8 g_package  varchar2(33) := '  hr_itf_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_user_interface_id_i  number   default null;
14 --
15 -- ----------------------------------------------------------------------------
16 -- |------------------------< set_base_key_value >----------------------------|
17 -- ----------------------------------------------------------------------------
18 procedure set_base_key_value
19   (p_user_interface_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_itf_ins.g_user_interface_id_i := p_user_interface_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_itf_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_user_interfaces
88   --
89   insert into hr_ki_user_interfaces
90       (user_interface_id
91       ,user_interface_key
92       ,type
93       ,form_name
94       ,page_region_code
95       ,region_code
96       ,object_version_number
97       )
98   Values
99     (p_rec.user_interface_id
100     ,p_rec.user_interface_key
101     ,p_rec.type
102     ,p_rec.form_name
103     ,p_rec.page_region_code
104     ,p_rec.region_code
105     ,p_rec.object_version_number
106     );
107   --
108   --
109   --
110   hr_utility.set_location(' Leaving:'||l_proc, 10);
111 Exception
112   When hr_api.check_integrity_violated Then
113     -- A check constraint has been violated
114     --
115     hr_itf_shd.constraint_error
116       (p_constraint_name => hr_api.strip_constraint_name(SQLERRM));
117   When hr_api.parent_integrity_violated Then
118     -- Parent integrity has been violated
119     --
120     hr_itf_shd.constraint_error
121       (p_constraint_name => hr_api.strip_constraint_name(SQLERRM));
122   When hr_api.unique_integrity_violated Then
123     -- Unique integrity has been violated
124     --
125     hr_itf_shd.constraint_error
126       (p_constraint_name => hr_api.strip_constraint_name(SQLERRM));
127   When Others Then
128     --
129     Raise;
130 End insert_dml;
131 --
132 -- ----------------------------------------------------------------------------
133 -- |------------------------------< pre_insert >------------------------------|
134 -- ----------------------------------------------------------------------------
135 -- {Start Of Comments}
136 --
137 -- Description:
138 --   This private procedure contains any processing which is required before
139 --   the insert dml. Presently, if the entity has a corresponding primary
140 --   key which is maintained by an associating sequence, the primary key for
141 --   the entity will be populated with the next sequence value in
142 --   preparation for the insert dml.
143 --
144 -- Prerequisites:
145 --   This is an internal procedure which is called from the ins procedure.
146 --
147 -- In Parameters:
148 --   A Pl/Sql record structure.
149 --
150 -- Post Success:
151 --   Processing continues.
152 --
153 -- Post Failure:
154 --   If an error has occurred, an error message and exception will be raised
155 --   but not handled.
156 --
157 -- Developer Implementation Notes:
158 --   Any pre-processing required before the insert dml is issued should be
159 --   coded within this procedure. As stated above, a good example is the
160 --   generation of a primary key number via a corresponding sequence.
161 --   It is important to note that any 3rd party maintenance should be reviewed
162 --   before placing in this procedure.
163 --
164 -- Access Status:
165 --   Internal Row Handler Use Only.
166 --
167 -- {End Of Comments}
168 -- ----------------------------------------------------------------------------
169 Procedure pre_insert
170   (p_rec  in out nocopy hr_itf_shd.g_rec_type
171   ) is
172 --
173   Cursor C_Sel1 is select hr_ki_user_interfaces_s.nextval from sys.dual;
174 --
175   Cursor C_Sel2 is
176     Select null
177       from hr_ki_user_interfaces
178      where user_interface_id =
179              hr_itf_ins.g_user_interface_id_i;
180 --
181   l_proc   varchar2(72) := g_package||'pre_insert';
182   l_exists varchar2(1);
183 --
184 Begin
185   hr_utility.set_location('Entering:'||l_proc, 5);
186   --
187   If (hr_itf_ins.g_user_interface_id_i is not null) Then
188     --
189     -- Verify registered primary key values not already in use
190     --
191     Open C_Sel2;
192     Fetch C_Sel2 into l_exists;
193     If C_Sel2%found Then
194        Close C_Sel2;
195        --
196        -- The primary key values are already in use.
197        --
198        fnd_message.set_name('PER','PER_289391_KEY_ALREADY_USED');
199        fnd_message.set_token('TABLE_NAME','hr_ki_user_interfaces');
200        fnd_message.raise_error;
201     End If;
202     Close C_Sel2;
203     --
204     -- Use registered key values and clear globals
205     --
206     p_rec.user_interface_id :=
207       hr_itf_ins.g_user_interface_id_i;
208     hr_itf_ins.g_user_interface_id_i := null;
209   Else
210     --
211     -- No registerd key values, so select the next sequence number
212     --
213     --
214     -- Select the next sequence number
215     --
216     Open C_Sel1;
217     Fetch C_Sel1 Into p_rec.user_interface_id;
218     Close C_Sel1;
219   End If;
220 
221   hr_itf_shd.construct_user_interface_key
222   (
223    p_rec.type
224   ,p_rec.form_name
225   ,p_rec.page_region_code
226   ,p_rec.region_code
227   ,p_rec.user_interface_key
228   );
229   --
230   hr_utility.set_location(' Leaving:'||l_proc, 10);
231 End pre_insert;
232 --
233 -- ----------------------------------------------------------------------------
234 -- |-----------------------------< post_insert >------------------------------|
235 -- ----------------------------------------------------------------------------
236 -- {Start Of Comments}
237 --
238 -- Description:
239 --   This private procedure contains any processing which is required after
240 --   the insert dml.
241 --
242 -- Prerequisites:
243 --   This is an internal procedure which is called from the ins procedure.
244 --
245 -- In Parameters:
246 --   A Pl/Sql record structre.
247 --
248 -- Post Success:
249 --   Processing continues.
250 --
251 -- Post Failure:
252 --   If an error has occurred, an error message and exception will be raised
253 --   but not handled.
254 --
255 -- Developer Implementation Notes:
256 --   Any post-processing required after the insert dml is issued should be
257 --   coded within this procedure. It is important to note that any 3rd party
258 --   maintenance should be reviewed before placing in this procedure.
259 --
260 -- Access Status:
261 --   Internal Row Handler Use Only.
262 --
263 -- {End Of Comments}
264 -- ----------------------------------------------------------------------------
265 Procedure post_insert
266   (p_effective_date               in date
267   ,p_rec                          in hr_itf_shd.g_rec_type
268   ) is
269 --
270   l_proc  varchar2(72) := g_package||'post_insert';
271 --
272 Begin
273   hr_utility.set_location('Entering:'||l_proc, 5);
274   begin
275     --
276     hr_itf_rki.after_insert
277       (p_effective_date              => p_effective_date
278       ,p_user_interface_id
279       => p_rec.user_interface_id
280       ,p_user_interface_key
281       => p_rec.user_interface_key
282       ,p_type
283       => p_rec.type
284       ,p_form_name
285       => p_rec.form_name
286       ,p_page_region_code
287       => p_rec.page_region_code
288       ,p_region_code
289       => p_rec.region_code
290       ,p_object_version_number
291       => p_rec.object_version_number
292       );
293     --
294   exception
295     --
296     when hr_api.cannot_find_prog_unit then
297       --
298       hr_api.cannot_find_prog_unit_error
299         (p_module_name => 'HR_KI_USER_INTERFACES'
300         ,p_hook_type   => 'AI');
301       --
302   end;
303   --
304   hr_utility.set_location(' Leaving:'||l_proc, 10);
305 End post_insert;
306 --
307 -- ----------------------------------------------------------------------------
308 -- |---------------------------------< ins >----------------------------------|
309 -- ----------------------------------------------------------------------------
310 Procedure ins
311   (p_effective_date               in date
312   ,p_rec                          in out nocopy hr_itf_shd.g_rec_type
313   ) is
314 --
315   l_proc  varchar2(72) := g_package||'ins';
316 --
317 Begin
318   hr_utility.set_location('Entering:'||l_proc, 5);
319   --
320   -- Call the supporting insert validate operations
321   --
322   hr_itf_bus.insert_validate
323      (p_effective_date
324      ,p_rec
325      );
326   --
327   -- Call to raise any errors on multi-message list
328   hr_multi_message.end_validation_set;
329   --
330   -- Call the supporting pre-insert operation
331   --
332   hr_itf_ins.pre_insert(p_rec);
333   --
334   -- Insert the row
335   --
336   hr_itf_ins.insert_dml(p_rec);
337   --
338   -- Call the supporting post-insert operation
339   --
340   hr_itf_ins.post_insert
341      (p_effective_date
342      ,p_rec
343      );
344   --
345   -- Call to raise any errors on multi-message list
346   hr_multi_message.end_validation_set;
347   --
348   hr_utility.set_location('Leaving:'||l_proc, 20);
349 end ins;
350 --
351 -- ----------------------------------------------------------------------------
352 -- |---------------------------------< ins >----------------------------------|
353 -- ----------------------------------------------------------------------------
354 Procedure ins
355   (p_effective_date                 in     date
356   ,p_user_interface_key             in     varchar2 default null
357   ,p_type                           in     varchar2
358   ,p_form_name                      in     varchar2 default null
359   ,p_page_region_code               in     varchar2 default null
360   ,p_region_code                    in     varchar2 default null
361   ,p_user_interface_id                 out nocopy number
362   ,p_object_version_number             out nocopy number
363   ) is
364 --
365   l_rec   hr_itf_shd.g_rec_type;
366   l_proc  varchar2(72) := g_package||'ins';
367 --
368 Begin
369   hr_utility.set_location('Entering:'||l_proc, 5);
370   --
371   -- Call conversion function to turn arguments into the
372   -- p_rec structure.
373   --
374   l_rec :=
375   hr_itf_shd.convert_args
376     (null
377     ,p_user_interface_key
378     ,p_type
379     ,p_form_name
380     ,p_page_region_code
381     ,p_region_code
382     ,null
383     );
384   --
385   -- Having converted the arguments into the hr_itf_rec
386   -- plsql record structure we call the corresponding record business process.
387   --
388   hr_itf_ins.ins
389      (p_effective_date
390      ,l_rec
391      );
392   --
393   -- As the primary key argument(s)
394   -- are specified as an OUT's we must set these values.
395   --
396   p_user_interface_id := l_rec.user_interface_id;
397   p_object_version_number := l_rec.object_version_number;
398   --
399   hr_utility.set_location(' Leaving:'||l_proc, 10);
400 End ins;
401 --
402 end hr_itf_ins;