1 Package ben_enb_shd AUTHID CURRENT_USER as
2 /* $Header: beenbrhi.pkh 120.0.12020000.2 2012/07/03 12:07:58 amnaraya ship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- | Global Record Type Specification |
6 -- ----------------------------------------------------------------------------
7 --
8 Type g_rec_type Is Record
9 (
10 enrt_bnft_id NUMBER(15,0) ,
11 dflt_flag VARCHAR2(30) ,
12 val_has_bn_prortd_flag VARCHAR2(30) ,
13 bndry_perd_cd VARCHAR2(30) ,
14 val NUMBER ,
15 nnmntry_uom VARCHAR2(30) ,
16 bnft_typ_cd VARCHAR2(30) ,
17 entr_val_at_enrt_flag VARCHAR2(30),
18 --Bug 14092338
19 --mn_val NUMBER(15,2) ,
20 --mx_val NUMBER(15,2) ,
21 --incrmt_val NUMBER(15,2) ,
22 --dflt_val NUMBER(15,2) ,
23 mn_val NUMBER ,
24 mx_val NUMBER ,
25 incrmt_val NUMBER ,
26 dflt_val NUMBER ,
27 --Bug 14092338
28 rt_typ_cd VARCHAR2(30) ,
29 cvg_mlt_cd VARCHAR2(30) ,
30 ctfn_rqd_flag VARCHAR2(30) ,
31 ordr_num NUMBER(15) ,
32 crntly_enrld_flag VARCHAR2(30) ,
33 elig_per_elctbl_chc_id NUMBER(15,0) ,
34 prtt_enrt_rslt_id NUMBER(15,0) ,
35 comp_lvl_fctr_id NUMBER(15) ,
36 business_group_id NUMBER(15) ,
37 enb_attribute_category VARCHAR2(30) ,
38 enb_attribute1 VARCHAR2(150),
39 enb_attribute2 VARCHAR2(150),
40 enb_attribute3 VARCHAR2(150),
41 enb_attribute4 VARCHAR2(150),
42 enb_attribute5 VARCHAR2(150),
43 enb_attribute6 VARCHAR2(150),
44 enb_attribute7 VARCHAR2(150),
45 enb_attribute8 VARCHAR2(150),
46 enb_attribute9 VARCHAR2(150),
47 enb_attribute10 VARCHAR2(150),
48 enb_attribute11 VARCHAR2(150),
49 enb_attribute12 VARCHAR2(150),
50 enb_attribute13 VARCHAR2(150),
51 enb_attribute14 VARCHAR2(150),
52 enb_attribute15 VARCHAR2(150),
53 enb_attribute16 VARCHAR2(150),
54 enb_attribute17 VARCHAR2(150),
55 enb_attribute18 VARCHAR2(150),
56 enb_attribute19 VARCHAR2(150),
57 enb_attribute20 VARCHAR2(150),
58 enb_attribute21 VARCHAR2(150),
59 enb_attribute22 VARCHAR2(150),
60 enb_attribute23 VARCHAR2(150),
61 enb_attribute24 VARCHAR2(150),
62 enb_attribute25 VARCHAR2(150),
63 enb_attribute26 VARCHAR2(150),
64 enb_attribute27 VARCHAR2(150),
65 enb_attribute28 VARCHAR2(150),
66 enb_attribute29 VARCHAR2(150),
67 enb_attribute30 VARCHAR2(150),
68 request_id NUMBER(15) ,
69 program_application_id NUMBER(15) ,
70 program_id NUMBER(15) ,
71 mx_wout_ctfn_val NUMBER ,
72 mx_wo_ctfn_flag varchar2(30) ,
73 program_update_date DATE ,
74 object_version_number NUMBER(9)
75 );
76 --
77 -- ----------------------------------------------------------------------------
78 -- | Global Definitions - Internal Development Use Only |
79 -- ----------------------------------------------------------------------------
80 --
81 g_old_rec g_rec_type; -- Global record definition
82 g_api_dml boolean; -- Global api dml status
83 --
84 -- ----------------------------------------------------------------------------
85 -- |------------------------< return_api_dml_status >-------------------------|
86 -- ----------------------------------------------------------------------------
87 -- {Start Of Comments}
88 --
89 -- Description:
90 -- This function will return the current g_api_dml private global
91 -- boolean status.
92 -- The g_api_dml status determines if at the time of the function
93 -- being executed if a dml statement (i.e. INSERT, UPDATE or DELETE)
94 -- is being issued from within an api.
95 -- If the status is TRUE then a dml statement is being issued from
96 -- within this entity api.
97 -- This function is primarily to support database triggers which
98 -- need to maintain the object_version_number for non-supported
99 -- dml statements (i.e. dml statement issued outside of the api layer).
100 --
101 -- Prerequisites:
102 -- None.
103 --
104 -- In Parameters:
105 -- None.
106 --
107 -- Post Success:
108 -- Processing continues.
109 -- If the function returns a TRUE value then, dml is being executed from
110 -- within this api.
111 --
112 -- Post Failure:
113 -- None.
114 --
115 -- Access Status:
116 -- Internal Row Handler Use Only.
117 --
118 -- {End Of Comments}
119 -- ----------------------------------------------------------------------------
120 Function return_api_dml_status Return Boolean;
121 --
122 -- ----------------------------------------------------------------------------
123 -- |---------------------------< constraint_error >---------------------------|
124 -- ----------------------------------------------------------------------------
125 -- {Start Of Comments}
126 --
127 -- Description:
128 -- This procedure is called when a constraint has been violated (i.e.
129 -- The exception hr_api.check_integrity_violated,
130 -- hr_api.parent_integrity_violated, hr_api.child_integrity_violated or
131 -- hr_api.unique_integrity_violated has been raised).
132 -- The exceptions can only be raised as follows:
133 -- 1) A check constraint can only be violated during an INSERT or UPDATE
134 -- dml operation.
135 -- 2) A parent integrity constraint can only be violated during an
136 -- INSERT or UPDATE dml operation.
137 -- 3) A child integrity constraint can only be violated during an
138 -- DELETE dml operation.
139 -- 4) A unique integrity constraint can only be violated during INSERT or
140 -- UPDATE dml operation.
141 --
142 -- Prerequisites:
143 -- 1) Either hr_api.check_integrity_violated,
144 -- hr_api.parent_integrity_violated, hr_api.child_integrity_violated or
145 -- hr_api.unique_integrity_violated has been raised with the subsequent
146 -- stripping of the constraint name from the generated error message
147 -- text.
148 -- 2) Standalone validation test which corresponds with a constraint error.
149 --
150 -- In Parameter:
151 -- p_constraint_name is in upper format and is just the constraint name
152 -- (e.g. not prefixed by brackets, schema owner etc).
153 --
154 -- Post Success:
155 -- Development dependant.
156 --
157 -- Post Failure:
158 -- Developement dependant.
159 --
160 -- Developer Implementation Notes:
161 -- For each constraint being checked the hr system package failure message
162 -- has been generated as a template only. These system error messages should
163 -- be modified as required (i.e. change the system failure message to a user
164 -- friendly defined error message).
165 --
166 -- Access Status:
167 -- Internal Development Use Only.
168 --
169 -- {End Of Comments}
170 -- ----------------------------------------------------------------------------
171 Procedure constraint_error
172 (p_constraint_name in all_constraints.constraint_name%TYPE);
173 --
174 -- ----------------------------------------------------------------------------
175 -- |-----------------------------< api_updating >-----------------------------|
176 -- ----------------------------------------------------------------------------
177 -- {Start Of Comments}
178 --
179 -- Description:
180 -- This function is used to populate the g_old_rec record with the
181 -- current row from the database for the specified primary key
182 -- provided that the primary key exists and is valid and does not
183 -- already match the current g_old_rec. The function will always return
184 -- a TRUE value if the g_old_rec is populated with the current row.
185 -- A FALSE value will be returned if all of the primary key arguments
186 -- are null.
187 --
188 -- Prerequisites:
189 -- None.
190 --
191 -- In Parameters:
192 --
193 -- Post Success:
194 -- A value of TRUE will be returned indiciating that the g_old_rec
195 -- is current.
196 -- A value of FALSE will be returned if all of the primary key arguments
197 -- have a null value (this indicates that the row has not be inserted into
198 -- the Schema), and therefore could never have a corresponding row.
199 --
200 -- Post Failure:
201 -- A failure can only occur under two circumstances:
202 -- 1) The primary key is invalid (i.e. a row does not exist for the
203 -- specified primary key values).
204 -- 2) If an object_version_number exists but is NOT the same as the current
205 -- g_old_rec value.
206 --
207 -- Developer Implementation Notes:
208 -- None.
209 --
210 -- Access Status:
211 -- Internal Development Use Only.
212 --
213 -- {End Of Comments}
214 -- ----------------------------------------------------------------------------
215 Function api_updating
216 (
217 p_enrt_bnft_id in number,
218 p_object_version_number in number
219 ) Return Boolean;
220 --
221 -- ----------------------------------------------------------------------------
222 -- |---------------------------------< lck >----------------------------------|
223 -- ----------------------------------------------------------------------------
224 -- {Start Of Comments}
225 --
226 -- Description:
227 -- The Lck process has two main functions to perform. Firstly, the row to be
228 -- updated or deleted must be locked. The locking of the row will only be
229 -- successful if the row is not currently locked by another user.
230 -- Secondly, during the locking of the row, the row is selected into
231 -- the g_old_rec data structure which enables the current row values from the
232 -- server to be available to the api.
233 --
234 -- Prerequisites:
235 -- When attempting to call the lock the object version number (if defined)
236 -- is mandatory.
237 --
238 -- In Parameters:
239 -- The arguments to the Lck process are the primary key(s) which uniquely
240 -- identify the row and the object version number of row.
241 --
242 -- Post Success:
243 -- On successful completion of the Lck process the row to be updated or
244 -- deleted will be locked and selected into the global data structure
245 -- g_old_rec.
246 --
247 -- Post Failure:
248 -- The Lck process can fail for three reasons:
249 -- 1) When attempting to lock the row the row could already be locked by
250 -- another user. This will raise the HR_Api.Object_Locked exception.
251 -- 2) The row which is required to be locked doesn't exist in the HR Schema.
252 -- This error is trapped and reported using the message name
253 -- 'HR_7220_INVALID_PRIMARY_KEY'.
254 -- 3) The row although existing in the HR Schema has a different object
255 -- version number than the object version number specified.
256 -- This error is trapped and reported using the message name
257 -- 'HR_7155_OBJECT_INVALID'.
258 --
259 -- Developer Implementation Notes:
260 -- For each primary key and the object version number arguments add a
261 -- call to hr_api.mandatory_arg_error procedure to ensure that these
262 -- argument values are not null.
263 --
264 -- Access Status:
265 -- Internal Development Use Only.
266 --
267 -- {End Of Comments}
268 -- ----------------------------------------------------------------------------
269 Procedure lck
270 (
271 p_enrt_bnft_id in number,
272 p_object_version_number in number
273 );
274 --
275 -- ----------------------------------------------------------------------------
276 -- |-----------------------------< convert_args >-----------------------------|
277 -- ----------------------------------------------------------------------------
278 -- {Start Of Comments}
279 --
280 -- Description:
281 -- This function is used to turn attribute parameters into the record
282 -- structure parameter g_rec_type.
283 --
284 -- Prerequisites:
285 -- This is a private function and can only be called from the ins or upd
286 -- attribute processes.
287 --
288 -- In Parameters:
289 --
290 -- Post Success:
291 -- A returning record structure will be returned.
292 --
293 -- Post Failure:
294 -- No direct error handling is required within this function. Any possible
295 -- errors within this function will be a PL/SQL value error due to conversion
296 -- of datatypes or data lengths.
297 --
298 -- Developer Implementation Notes:
299 -- None.
300 --
301 -- Access Status:
302 -- Internal Row Handler Use Only.
303 --
304 -- {End Of Comments}
305 -- ----------------------------------------------------------------------------
306 Function convert_args
307 (
308 p_enrt_bnft_id in number
309 ,p_dflt_flag in varchar2
310 ,p_val_has_bn_prortd_flag in varchar2
311 ,p_bndry_perd_cd in varchar2
312 ,p_val in number
313 ,p_nnmntry_uom in varchar2
314 ,p_bnft_typ_cd in varchar2
315 ,p_entr_val_at_enrt_flag in varchar2
316 ,p_mn_val in number
317 ,p_mx_val in number
318 ,p_incrmt_val in number
319 ,p_dflt_val in number
320 ,p_rt_typ_cd in varchar2
321 ,p_cvg_mlt_cd in varchar2
322 ,p_ctfn_rqd_flag in varchar2
323 ,p_ordr_num in number
324 ,p_crntly_enrld_flag in varchar2
325 ,p_elig_per_elctbl_chc_id in number
326 ,p_prtt_enrt_rslt_id in number
327 ,p_comp_lvl_fctr_id in number
328 ,p_business_group_id in number
329 ,p_enb_attribute_category in varchar2
330 ,p_enb_attribute1 in varchar2
331 ,p_enb_attribute2 in varchar2
332 ,p_enb_attribute3 in varchar2
333 ,p_enb_attribute4 in varchar2
334 ,p_enb_attribute5 in varchar2
335 ,p_enb_attribute6 in varchar2
336 ,p_enb_attribute7 in varchar2
337 ,p_enb_attribute8 in varchar2
338 ,p_enb_attribute9 in varchar2
339 ,p_enb_attribute10 in varchar2
340 ,p_enb_attribute11 in varchar2
341 ,p_enb_attribute12 in varchar2
342 ,p_enb_attribute13 in varchar2
343 ,p_enb_attribute14 in varchar2
344 ,p_enb_attribute15 in varchar2
345 ,p_enb_attribute16 in varchar2
346 ,p_enb_attribute17 in varchar2
347 ,p_enb_attribute18 in varchar2
348 ,p_enb_attribute19 in varchar2
349 ,p_enb_attribute20 in varchar2
350 ,p_enb_attribute21 in varchar2
351 ,p_enb_attribute22 in varchar2
352 ,p_enb_attribute23 in varchar2
353 ,p_enb_attribute24 in varchar2
354 ,p_enb_attribute25 in varchar2
355 ,p_enb_attribute26 in varchar2
356 ,p_enb_attribute27 in varchar2
357 ,p_enb_attribute28 in varchar2
358 ,p_enb_attribute29 in varchar2
359 ,p_enb_attribute30 in varchar2
360 ,p_request_id in number
361 ,p_program_application_id in number
362 ,p_program_id in number
363 ,p_mx_wout_ctfn_val in number
364 ,p_mx_wo_ctfn_flag in varchar2
365 ,p_program_update_date in date
366 ,p_object_version_number in number
367 )
368 Return g_rec_type;
369 --
370 end ben_enb_shd;
[Home] [Help]