DBA Data[Home] [Help]

PACKAGE BODY: APPS.PAY_EVG_INS

Source


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