1 Package ben_xdf_shd AUTHID CURRENT_USER as
2 /* $Header: bexdfrhi.pkh 120.1 2005/12/05 15:53:53 tjesumic noship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- | Global Record Type Specification |
6 -- ----------------------------------------------------------------------------
7 --
8
9 Type g_rec_type Is Record
10 (
11 ext_dfn_id number(15),
12 name varchar2(600),
13 xml_tag_name varchar2(80),
14 xdo_template_id number(15),
15 data_typ_cd varchar2(30),
16 ext_typ_cd varchar2(30),
17 output_name varchar2(90),
18 output_type varchar2(90),
19 apnd_rqst_id_flag varchar2(90),
20 prmy_sort_cd varchar2(90),
21 scnd_sort_cd varchar2(90),
22 strt_dt varchar2(90),
23 end_dt varchar2(90),
24 ext_crit_prfl_id number(15),
25 ext_file_id number(15),
26 business_group_id number(15),
27 legislation_code varchar2(30),
28 xdf_attribute_category varchar2(30),
29 xdf_attribute1 varchar2(150),
30 xdf_attribute2 varchar2(150),
31 xdf_attribute3 varchar2(150),
32 xdf_attribute4 varchar2(150),
33 xdf_attribute5 varchar2(150),
34 xdf_attribute6 varchar2(150),
35 xdf_attribute7 varchar2(150),
36 xdf_attribute8 varchar2(150),
37 xdf_attribute9 varchar2(150),
38 xdf_attribute10 varchar2(150),
39 xdf_attribute11 varchar2(150),
40 xdf_attribute12 varchar2(150),
41 xdf_attribute13 varchar2(150),
42 xdf_attribute14 varchar2(150),
43 xdf_attribute15 varchar2(150),
44 xdf_attribute16 varchar2(150),
45 xdf_attribute17 varchar2(150),
46 xdf_attribute18 varchar2(150),
47 xdf_attribute19 varchar2(150),
48 xdf_attribute20 varchar2(150),
49 xdf_attribute21 varchar2(150),
50 xdf_attribute22 varchar2(150),
51 xdf_attribute23 varchar2(150),
52 xdf_attribute24 varchar2(150),
53 xdf_attribute25 varchar2(150),
54 xdf_attribute26 varchar2(150),
55 xdf_attribute27 varchar2(150),
56 xdf_attribute28 varchar2(150),
57 xdf_attribute29 varchar2(150),
58 xdf_attribute30 varchar2(150),
59 last_update_date date,
60 creation_date date,
61 last_updated_by number(15),
62 last_update_login number(15),
63 created_by number(15),
64 object_version_number number(9),
65 drctry_name varchar2(150),
66 kickoff_wrt_prc_flag varchar2(30),
67 upd_cm_sent_dt_flag varchar2(30),
68 spcl_hndl_flag varchar2(30),
69 ext_global_flag varchar2(30),
70 cm_display_flag varchar2(30),
71 use_eff_dt_for_chgs_flag varchar2(30),
72 ext_post_prcs_rl number(15)
73 );
74
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_ext_dfn_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_ext_dfn_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_ext_dfn_id in number,
309 p_name in varchar2,
310 p_xml_tag_name in varchar2,
311 p_xdo_template_id in number,
312 p_data_typ_cd in varchar2,
313 p_ext_typ_cd in varchar2,
314 p_output_name in varchar2,
315 p_output_type in varchar2,
316 p_apnd_rqst_id_flag in varchar2,
317 p_prmy_sort_cd in varchar2,
318 p_scnd_sort_cd in varchar2,
319 p_strt_dt in varchar2,
320 p_end_dt in varchar2,
321 p_ext_crit_prfl_id in number,
322 p_ext_file_id in number,
323 p_business_group_id in number,
324 p_legislation_code in varchar2,
325 p_xdf_attribute_category in varchar2,
326 p_xdf_attribute1 in varchar2,
327 p_xdf_attribute2 in varchar2,
328 p_xdf_attribute3 in varchar2,
329 p_xdf_attribute4 in varchar2,
330 p_xdf_attribute5 in varchar2,
331 p_xdf_attribute6 in varchar2,
332 p_xdf_attribute7 in varchar2,
333 p_xdf_attribute8 in varchar2,
334 p_xdf_attribute9 in varchar2,
335 p_xdf_attribute10 in varchar2,
336 p_xdf_attribute11 in varchar2,
337 p_xdf_attribute12 in varchar2,
338 p_xdf_attribute13 in varchar2,
339 p_xdf_attribute14 in varchar2,
340 p_xdf_attribute15 in varchar2,
341 p_xdf_attribute16 in varchar2,
342 p_xdf_attribute17 in varchar2,
343 p_xdf_attribute18 in varchar2,
344 p_xdf_attribute19 in varchar2,
345 p_xdf_attribute20 in varchar2,
346 p_xdf_attribute21 in varchar2,
347 p_xdf_attribute22 in varchar2,
348 p_xdf_attribute23 in varchar2,
349 p_xdf_attribute24 in varchar2,
350 p_xdf_attribute25 in varchar2,
351 p_xdf_attribute26 in varchar2,
352 p_xdf_attribute27 in varchar2,
353 p_xdf_attribute28 in varchar2,
354 p_xdf_attribute29 in varchar2,
355 p_xdf_attribute30 in varchar2,
356 p_last_update_date in date,
357 p_creation_date in date,
358 p_last_updated_by in number,
359 p_last_update_login in number,
360 p_created_by in number,
361 p_object_version_number in number,
362 p_drctry_name in varchar2,
363 p_kickoff_wrt_prc_flag in varchar2,
364 p_upd_cm_sent_dt_flag in varchar2,
365 p_spcl_hndl_flag in varchar2,
366 p_ext_global_flag in varchar2,
367 p_cm_display_flag in varchar2,
368 p_use_eff_dt_for_chgs_flag in varchar2,
369 p_ext_post_prcs_rl in number
370 )
371 Return g_rec_type;
372 --
373 end ben_xdf_shd;
[Home] [Help]