DBA Data[Home] [Help]

PACKAGE BODY: APPS.BEN_RAN_INS

Source


1 Package Body ben_ran_ins as
2 /* $Header: beranrhi.pkb 115.6 2002/12/11 11:49:09 lakrish ship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- |                     Private Global Definitions                           |
6 -- ----------------------------------------------------------------------------
7 --
8 g_package  varchar2(33)	:= '  ben_ran_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(p_rec in out nocopy ben_ran_shd.g_rec_type) is
54 --
55   l_proc  varchar2(72) := g_package||'insert_dml';
56 --
57 Begin
58   hr_utility.set_location('Entering:'||l_proc, 5);
59   p_rec.object_version_number := 1;  -- Initialise the object version
60   --
61   ben_ran_shd.g_api_dml := true;  -- Set the api dml status
62   --
63   -- Insert the row into: ben_batch_ranges
64   --
65   insert into ben_batch_ranges
66   (	range_id,
67 	benefit_action_id,
68 	range_status_cd,
69 	starting_person_action_id,
70 	ending_person_action_id,
71 	object_version_number
72   )
73   Values
74   (	p_rec.range_id,
75 	p_rec.benefit_action_id,
76 	p_rec.range_status_cd,
77 	p_rec.starting_person_action_id,
78 	p_rec.ending_person_action_id,
79 	p_rec.object_version_number
80   );
81   --
82   ben_ran_shd.g_api_dml := false;   -- Unset the api dml status
83   --
84   hr_utility.set_location(' Leaving:'||l_proc, 10);
85 Exception
86   When hr_api.check_integrity_violated Then
87     -- A check constraint has been violated
88     ben_ran_shd.g_api_dml := false;   -- Unset the api dml status
89     ben_ran_shd.constraint_error
90       (p_constraint_name => hr_api.strip_constraint_name(SQLERRM));
91   When hr_api.parent_integrity_violated Then
92     -- Parent integrity has been violated
93     ben_ran_shd.g_api_dml := false;   -- Unset the api dml status
94     ben_ran_shd.constraint_error
95       (p_constraint_name => hr_api.strip_constraint_name(SQLERRM));
96   When hr_api.unique_integrity_violated Then
100       (p_constraint_name => hr_api.strip_constraint_name(SQLERRM));
97     -- Unique integrity has been violated
98     ben_ran_shd.g_api_dml := false;   -- Unset the api dml status
99     ben_ran_shd.constraint_error
101   When Others Then
102     ben_ran_shd.g_api_dml := false;   -- Unset the api dml status
103     Raise;
104 End insert_dml;
105 --
106 -- ----------------------------------------------------------------------------
107 -- |------------------------------< pre_insert >------------------------------|
108 -- ----------------------------------------------------------------------------
109 -- {Start Of Comments}
110 --
111 -- Description:
112 --   This private procedure contains any processing which is required before
113 --   the insert dml. Presently, if the entity has a corresponding primary
114 --   key which is maintained by an associating sequence, the primary key for
115 --   the entity will be populated with the next sequence value in
116 --   preparation for the insert dml.
117 --
118 -- Prerequisites:
119 --   This is an internal procedure which is called from the ins procedure.
120 --
121 -- In Parameters:
122 --   A Pl/Sql record structre.
123 --
124 -- Post Success:
125 --   Processing continues.
126 --
127 -- Post Failure:
128 --   If an error has occurred, an error message and exception will be raised
129 --   but not handled.
130 --
131 -- Developer Implementation Notes:
132 --   Any pre-processing required before the insert dml is issued should be
133 --   coded within this procedure. As stated above, a good example is the
134 --   generation of a primary key number via a corresponding sequence.
135 --   It is important to note that any 3rd party maintenance should be reviewed
136 --   before placing in this procedure.
137 --
138 -- Access Status:
139 --   Internal Row Handler Use Only.
140 --
141 -- {End Of Comments}
142 -- ----------------------------------------------------------------------------
143 Procedure pre_insert(p_rec  in out nocopy ben_ran_shd.g_rec_type) is
144 --
145   l_proc  varchar2(72) := g_package||'pre_insert';
146 --
147   Cursor C_Sel1 is select ben_batch_ranges_s.nextval from sys.dual;
148 --
149 Begin
150   hr_utility.set_location('Entering:'||l_proc, 5);
151   --
152   --
153   -- Select the next sequence number
154   --
155   Open C_Sel1;
156   Fetch C_Sel1 Into p_rec.range_id;
157   Close C_Sel1;
158   --
159   hr_utility.set_location(' Leaving:'||l_proc, 10);
160 End pre_insert;
161 --
162 -- ----------------------------------------------------------------------------
163 -- |-----------------------------< post_insert >------------------------------|
164 -- ----------------------------------------------------------------------------
165 -- {Start Of Comments}
166 --
167 -- Description:
168 --   This private procedure contains any processing which is required after the
169 --   insert dml.
170 --
171 -- Prerequisites:
172 --   This is an internal procedure which is called from the ins procedure.
173 --
174 -- In Parameters:
175 --   A Pl/Sql record structre.
176 --
177 -- Post Success:
178 --   Processing continues.
179 --
180 -- Post Failure:
181 --   If an error has occurred, an error message and exception will be raised
182 --   but not handled.
183 --
184 -- Developer Implementation Notes:
185 --   Any post-processing required after the insert dml is issued should be
186 --   coded within this procedure. It is important to note that any 3rd party
187 --   maintenance should be reviewed before placing in this procedure.
188 --
189 -- Access Status:
190 --   Internal Row Handler Use Only.
191 --
192 -- {End Of Comments}
193 -- ----------------------------------------------------------------------------
194 Procedure post_insert(
195 p_effective_date in date,p_rec in ben_ran_shd.g_rec_type) is
196 --
197   l_proc  varchar2(72) := g_package||'post_insert';
198 --
199 Begin
200   hr_utility.set_location('Entering:'||l_proc, 5);
201   --
202   hr_utility.set_location(' Leaving:'||l_proc, 10);
203 End post_insert;
204 --
205 -- ----------------------------------------------------------------------------
206 -- |---------------------------------< ins >----------------------------------|
207 -- ----------------------------------------------------------------------------
208 Procedure ins
209   (
210   p_effective_date in date,
211   p_rec        in out nocopy ben_ran_shd.g_rec_type
212   ) is
213 --
214   l_proc  varchar2(72) := g_package||'ins';
215 --
216 Begin
217   hr_utility.set_location('Entering:'||l_proc, 5);
218   --
219   -- Call the supporting insert validate operations
220   --
221   ben_ran_bus.insert_validate(p_rec
222   ,p_effective_date);
223   --
224   -- Call the supporting pre-insert operation
225   --
226   pre_insert(p_rec);
227   --
228   -- Insert the row
229   --
230   insert_dml(p_rec);
231   --
232   -- Call the supporting post-insert operation
233   --
234   post_insert(
235 p_effective_date,p_rec);
236 end ins;
237 --
238 -- ----------------------------------------------------------------------------
239 -- |---------------------------------< ins >----------------------------------|
240 -- ----------------------------------------------------------------------------
241 Procedure ins
242   (
243   p_effective_date in date,
244   p_range_id                     out nocopy number,
245   p_benefit_action_id            in number,
246   p_range_status_cd              in varchar2,
247   p_starting_person_action_id    in number,
248   p_ending_person_action_id      in number,
249   p_object_version_number        out nocopy number
253   l_proc  varchar2(72) := g_package||'ins';
250   ) is
251 --
252   l_rec	  ben_ran_shd.g_rec_type;
254 --
255 Begin
256   hr_utility.set_location('Entering:'||l_proc, 5);
257   --
258   -- Call conversion function to turn arguments into the
259   -- p_rec structure.
260   --
261   l_rec :=
262   ben_ran_shd.convert_args
263   (
264   null,
265   p_benefit_action_id,
266   p_range_status_cd,
267   p_starting_person_action_id,
268   p_ending_person_action_id,
269   null
270   );
271   --
272   -- Having converted the arguments into the ben_ran_rec
273   -- plsql record structure we call the corresponding record business process.
274   --
275   ins(
276     p_effective_date,l_rec);
277   --
278   -- As the primary key argument(s)
279   -- are specified as an OUT's we must set these values.
280   --
281   p_range_id := l_rec.range_id;
282   p_object_version_number := l_rec.object_version_number;
283   --
284   hr_utility.set_location(' Leaving:'||l_proc, 10);
285 End ins;
286 --
287 end ben_ran_ins;