DBA Data[Home] [Help]

PACKAGE BODY: APPS.IRC_CMC_INS

Source


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