1 Package pay_eei_mig_shd as
2 /* $Header: pyeeimhi.pkh 120.0 2005/12/16 15:02:35 ndorai noship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- | Global Record Type Specification |
6 -- ----------------------------------------------------------------------------
7 --
8 Type g_rec_type Is Record
9 (element_type_extra_info_id number(15)
10 ,element_type_id number(10)
11 ,information_type varchar2(40)
12 ,request_id number(15)
13 ,program_application_id number(15)
14 ,program_id number(15)
15 ,program_update_date date
16 ,eei_attribute_category varchar2(30)
17 ,eei_attribute1 varchar2(150)
18 ,eei_attribute2 varchar2(150)
19 ,eei_attribute3 varchar2(150)
20 ,eei_attribute4 varchar2(150)
21 ,eei_attribute5 varchar2(150)
22 ,eei_attribute6 varchar2(150)
23 ,eei_attribute7 varchar2(150)
24 ,eei_attribute8 varchar2(150)
25 ,eei_attribute9 varchar2(150)
26 ,eei_attribute10 varchar2(150)
27 ,eei_attribute11 varchar2(150)
28 ,eei_attribute12 varchar2(150)
29 ,eei_attribute13 varchar2(150)
30 ,eei_attribute14 varchar2(150)
31 ,eei_attribute15 varchar2(150)
32 ,eei_attribute16 varchar2(150)
33 ,eei_attribute17 varchar2(150)
34 ,eei_attribute18 varchar2(150)
35 ,eei_attribute19 varchar2(150)
36 ,eei_attribute20 varchar2(150)
37 ,eei_information_category varchar2(30)
38 ,eei_information1 varchar2(150)
39 ,eei_information2 varchar2(150)
40 ,eei_information3 varchar2(150)
41 ,eei_information4 varchar2(150)
42 ,eei_information5 varchar2(150)
43 ,eei_information6 varchar2(150)
44 ,eei_information7 varchar2(150)
45 ,eei_information8 varchar2(150)
46 ,eei_information9 varchar2(150)
47 ,eei_information10 varchar2(150)
48 ,eei_information11 varchar2(150)
49 ,eei_information12 varchar2(150)
50 ,eei_information13 varchar2(150)
51 ,eei_information14 varchar2(150)
52 ,eei_information15 varchar2(150)
53 ,eei_information16 varchar2(150)
54 ,eei_information17 varchar2(150)
55 ,eei_information18 varchar2(150)
56 ,eei_information19 varchar2(150)
57 ,eei_information20 varchar2(150)
58 ,eei_information21 varchar2(150)
59 ,eei_information22 varchar2(150)
60 ,eei_information23 varchar2(150)
61 ,eei_information24 varchar2(150)
62 ,eei_information25 varchar2(150)
63 ,eei_information26 varchar2(150)
64 ,eei_information27 varchar2(150)
65 ,eei_information28 varchar2(150)
66 ,eei_information29 varchar2(150)
67 ,eei_information30 varchar2(150)
68 ,object_version_number number(9)
69 );
70 --
71 -- ----------------------------------------------------------------------------
72 -- | Global Definitions - Internal Development Use Only |
73 -- ----------------------------------------------------------------------------
74 --
75 g_old_rec g_rec_type; -- Global record definition
76 g_api_dml boolean; -- Global api dml status
77 --
78 -- ----------------------------------------------------------------------------
79 -- |------------------------< return_api_dml_status >-------------------------|
80 -- ----------------------------------------------------------------------------
81 -- {Start Of Comments}
82 --
83 -- Description:
84 -- This function will return the current g_api_dml private global
85 -- boolean status.
86 -- The g_api_dml status determines if at the time of the function
87 -- being executed if a dml statement (i.e. INSERT, UPDATE or DELETE)
88 -- is being issued from within an api.
89 -- If the status is TRUE then a dml statement is being issued from
90 -- within this entity api.
91 -- This function is primarily to support database triggers which
92 -- need to maintain the object_version_number for non-supported
93 -- dml statements (i.e. dml statement issued outside of the api layer).
94 --
95 -- Prerequisites:
96 -- None.
97 --
98 -- In Parameters:
99 -- None.
100 --
101 -- Post Success:
102 -- Processing continues.
103 -- If the function returns a TRUE value then, dml is being executed from
104 -- within this api.
105 --
106 -- Post Failure:
107 -- None.
108 --
109 -- Access Status:
110 -- Internal Row Handler Use Only.
111 --
112 -- {End Of Comments}
113 -- ----------------------------------------------------------------------------
114 Function return_api_dml_status Return Boolean;
115 --
116 -- ----------------------------------------------------------------------------
117 -- |---------------------------< constraint_error >---------------------------|
118 -- ----------------------------------------------------------------------------
119 -- {Start Of Comments}
120 --
121 -- Description:
122 -- This procedure is called when a constraint has been violated (i.e.
123 -- The exception hr_api.check_integrity_violated,
124 -- hr_api.parent_integrity_violated, hr_api.child_integrity_violated or
125 -- hr_api.unique_integrity_violated has been raised).
126 -- The exceptions can only be raised as follows:
127 -- 1) A check constraint can only be violated during an INSERT or UPDATE
128 -- dml operation.
129 -- 2) A parent integrity constraint can only be violated during an
130 -- INSERT or UPDATE dml operation.
131 -- 3) A child integrity constraint can only be violated during an
132 -- DELETE dml operation.
133 -- 4) A unique integrity constraint can only be violated during INSERT or
134 -- UPDATE dml operation.
135 --
136 -- Prerequisites:
137 -- 1) Either hr_api.check_integrity_violated,
138 -- hr_api.parent_integrity_violated, hr_api.child_integrity_violated or
139 -- hr_api.unique_integrity_violated has been raised with the subsequent
140 -- stripping of the constraint name from the generated error message
141 -- text.
142 -- 2) Standalone validation test which corresponds with a constraint error.
143 --
144 -- In Parameter:
145 -- p_constraint_name is in upper format and is just the constraint name
146 -- (e.g. not prefixed by brackets, schema owner etc).
147 --
148 -- Post Success:
149 -- Development dependant.
150 --
151 -- Post Failure:
152 -- Developement dependant.
153 --
154 -- Developer Implementation Notes:
155 -- For each constraint being checked the hr system package failure message
156 -- has been generated as a template only. These system error messages should
157 -- be modified as required (i.e. change the system failure message to a user
158 -- friendly defined error message).
159 --
160 -- Access Status:
161 -- Internal Development Use Only.
162 --
163 -- {End Of Comments}
164 -- ----------------------------------------------------------------------------
165 Procedure constraint_error
166 (p_constraint_name in all_constraints.constraint_name%TYPE);
167 --
168 -- ----------------------------------------------------------------------------
169 -- |-----------------------------< api_updating >-----------------------------|
170 -- ----------------------------------------------------------------------------
171 -- {Start Of Comments}
172 --
173 -- Description:
174 -- This function is used to populate the g_old_rec record with the
175 -- current row from the database for the specified primary key
176 -- provided that the primary key exists and is valid and does not
177 -- already match the current g_old_rec. The function will always return
178 -- a TRUE value if the g_old_rec is populated with the current row.
179 -- A FALSE value will be returned if all of the primary key arguments
180 -- are null.
181 --
182 -- Prerequisites:
183 -- None.
184 --
185 -- In Parameters:
186 --
187 -- Post Success:
188 -- A value of TRUE will be returned indiciating that the g_old_rec
189 -- is current.
190 -- A value of FALSE will be returned if all of the primary key arguments
191 -- have a null value (this indicates that the row has not be inserted into
192 -- the Schema), and therefore could never have a corresponding row.
193 --
194 -- Post Failure:
195 -- A failure can only occur under two circumstances:
196 -- 1) The primary key is invalid (i.e. a row does not exist for the
197 -- specified primary key values).
198 -- 2) If an object_version_number exists but is NOT the same as the current
199 -- g_old_rec value.
200 --
201 -- Developer Implementation Notes:
202 -- None.
203 --
204 -- Access Status:
205 -- Internal Development Use Only.
206 --
207 -- {End Of Comments}
208 -- ----------------------------------------------------------------------------
209 Function api_updating
210 (p_element_type_extra_info_id in number
211 ,p_object_version_number in number
212 ) Return Boolean;
213 --
214 -- ----------------------------------------------------------------------------
215 -- |---------------------------------< lck >----------------------------------|
216 -- ----------------------------------------------------------------------------
217 -- {Start of comments}
218 --
219 -- Description:
220 -- The Lck process has two main functions to perform. Firstly, the row to be
221 -- updated or deleted must be locked. The locking of the row will only be
222 -- successful if the row is not currently locked by another user.
223 -- Secondly, during the locking of the row, the row is selected into
224 -- the g_old_rec data structure which enables the current row values from the
225 -- server to be available to the api.
226 --
227 -- Prerequisites:
228 -- When attempting to call the lock the object version number (if defined)
229 -- is mandatory.
230 --
231 -- In Parameters:
232 -- The arguments to the Lck process are the primary key(s) which uniquely
233 -- identify the row and the object version number of row.
234 --
235 -- Post Success:
236 -- On successful completion of the Lck process the row to be updated or
237 -- deleted will be locked and selected into the global data structure
238 -- g_old_rec.
239 --
240 -- Post Failure:
241 -- The Lck process can fail for three reasons:
242 -- 1) When attempting to lock the row the row could already be locked by
243 -- another user. This will raise the HR_Api.Object_Locked exception.
244 -- 2) The row which is required to be locked doesn't exist in the HR Schema.
245 -- This error is trapped and reported using the message name
246 -- 'HR_7220_INVALID_PRIMARY_KEY'.
247 -- 3) The row although existing in the HR Schema has a different object
248 -- version number than the object version number specified.
249 -- This error is trapped and reported using the message name
250 -- 'HR_7155_OBJECT_INVALID'.
251 --
252 -- Developer Implementation Notes:
253 -- For each primary key and the object version number arguments add a
254 -- call to hr_api.mandatory_arg_error procedure to ensure that these
255 -- argument values are not null.
256 --
257 -- Access Status:
258 -- Internal Development Use Only.
259 --
260 -- {End of comments}
261 -- ----------------------------------------------------------------------------
262 Procedure lck
263 (p_element_type_extra_info_id in number
264 ,p_object_version_number in number
265 );
266 --
267 -- ----------------------------------------------------------------------------
268 -- |-----------------------------< convert_args >-----------------------------|
269 -- ----------------------------------------------------------------------------
270 -- {Start Of Comments}
271 --
272 -- Description:
273 -- This function is used to turn attribute parameters into the record
274 -- structure parameter g_rec_type.
275 --
276 -- Prerequisites:
277 -- This is a private function and can only be called from the ins or upd
278 -- attribute processes.
279 --
280 -- In Parameters:
281 --
282 -- Post Success:
283 -- A returning record structure will be returned.
284 --
285 -- Post Failure:
286 -- No direct error handling is required within this function. Any possible
287 -- errors within this function will be a PL/SQL value error due to conversion
288 -- of datatypes or data lengths.
289 --
290 -- Developer Implementation Notes:
291 -- None.
292 --
293 -- Access Status:
294 -- Internal Row Handler Use Only.
295 --
296 -- {End Of Comments}
297 -- ----------------------------------------------------------------------------
298 Function convert_args
299 (p_element_type_extra_info_id in number
300 ,p_element_type_id in number
301 ,p_information_type in varchar2
305 ,p_program_update_date in date
302 ,p_request_id in number
303 ,p_program_application_id in number
304 ,p_program_id in number
306 ,p_eei_attribute_category in varchar2
307 ,p_eei_attribute1 in varchar2
308 ,p_eei_attribute2 in varchar2
309 ,p_eei_attribute3 in varchar2
310 ,p_eei_attribute4 in varchar2
311 ,p_eei_attribute5 in varchar2
312 ,p_eei_attribute6 in varchar2
313 ,p_eei_attribute7 in varchar2
314 ,p_eei_attribute8 in varchar2
315 ,p_eei_attribute9 in varchar2
316 ,p_eei_attribute10 in varchar2
317 ,p_eei_attribute11 in varchar2
318 ,p_eei_attribute12 in varchar2
319 ,p_eei_attribute13 in varchar2
320 ,p_eei_attribute14 in varchar2
321 ,p_eei_attribute15 in varchar2
322 ,p_eei_attribute16 in varchar2
323 ,p_eei_attribute17 in varchar2
324 ,p_eei_attribute18 in varchar2
325 ,p_eei_attribute19 in varchar2
326 ,p_eei_attribute20 in varchar2
327 ,p_eei_information_category in varchar2
328 ,p_eei_information1 in varchar2
329 ,p_eei_information2 in varchar2
330 ,p_eei_information3 in varchar2
331 ,p_eei_information4 in varchar2
332 ,p_eei_information5 in varchar2
333 ,p_eei_information6 in varchar2
334 ,p_eei_information7 in varchar2
335 ,p_eei_information8 in varchar2
336 ,p_eei_information9 in varchar2
337 ,p_eei_information10 in varchar2
338 ,p_eei_information11 in varchar2
339 ,p_eei_information12 in varchar2
340 ,p_eei_information13 in varchar2
341 ,p_eei_information14 in varchar2
342 ,p_eei_information15 in varchar2
343 ,p_eei_information16 in varchar2
344 ,p_eei_information17 in varchar2
345 ,p_eei_information18 in varchar2
346 ,p_eei_information19 in varchar2
347 ,p_eei_information20 in varchar2
348 ,p_eei_information21 in varchar2
349 ,p_eei_information22 in varchar2
350 ,p_eei_information23 in varchar2
351 ,p_eei_information24 in varchar2
352 ,p_eei_information25 in varchar2
353 ,p_eei_information26 in varchar2
354 ,p_eei_information27 in varchar2
355 ,p_eei_information28 in varchar2
356 ,p_eei_information29 in varchar2
357 ,p_eei_information30 in varchar2
358 ,p_object_version_number in number
359 )
360 Return g_rec_type;
361 --
362 end pay_eei_mig_shd;
[Home] [Help]