1 Package pe_aei_shd as
2 /* $Header: peaeirhi.pkh 120.0 2005/05/31 05:08:28 appldev noship $ */
3 --
4 -- ----------------------------------------------------------------------------+
5 -- | Global Record Type Specification |
6 -- ----------------------------------------------------------------------------+
7 --
8 Type g_rec_type Is Record
9 (
10 assignment_extra_info_id number(15),
11 assignment_id per_assignment_extra_info.assignment_id%TYPE,
12 information_type varchar2(40),
13 request_id number(15),
14 program_application_id number(15),
15 program_id number(15),
16 program_update_date date,
17 aei_attribute_category varchar2(30),
18 aei_attribute1 varchar2(150),
19 aei_attribute2 varchar2(150),
20 aei_attribute3 varchar2(150),
21 aei_attribute4 varchar2(150),
22 aei_attribute5 varchar2(150),
23 aei_attribute6 varchar2(150),
24 aei_attribute7 varchar2(150),
25 aei_attribute8 varchar2(150),
26 aei_attribute9 varchar2(150),
27 aei_attribute10 varchar2(150),
28 aei_attribute11 varchar2(150),
29 aei_attribute12 varchar2(150),
30 aei_attribute13 varchar2(150),
31 aei_attribute14 varchar2(150),
32 aei_attribute15 varchar2(150),
33 aei_attribute16 varchar2(150),
34 aei_attribute17 varchar2(150),
35 aei_attribute18 varchar2(150),
36 aei_attribute19 varchar2(150),
37 aei_attribute20 varchar2(150),
38 aei_information_category varchar2(30),
39 aei_information1 varchar2(150),
40 aei_information2 varchar2(150),
41 aei_information3 varchar2(150),
42 aei_information4 varchar2(150),
43 aei_information5 varchar2(150),
44 aei_information6 varchar2(150),
45 aei_information7 varchar2(150),
46 aei_information8 varchar2(150),
47 aei_information9 varchar2(150),
48 aei_information10 varchar2(150),
49 aei_information11 varchar2(150),
50 aei_information12 varchar2(150),
51 aei_information13 varchar2(150),
52 aei_information14 varchar2(150),
53 aei_information15 varchar2(150),
54 aei_information16 varchar2(150),
55 aei_information17 varchar2(150),
56 aei_information18 varchar2(150),
57 aei_information19 varchar2(150),
58 aei_information20 varchar2(150),
59 aei_information21 varchar2(150),
60 aei_information22 varchar2(150),
61 aei_information23 varchar2(150),
62 aei_information24 varchar2(150),
63 aei_information25 varchar2(150),
64 aei_information26 varchar2(150),
65 aei_information27 varchar2(150),
66 aei_information28 varchar2(150),
67 aei_information29 varchar2(150),
68 aei_information30 varchar2(150),
69 object_version_number number(9)
70 );
71 --
72 -- ----------------------------------------------------------------------------
73 -- | Global Definitions - Internal Development Use Only |
74 -- ----------------------------------------------------------------------------
75 --
76 g_old_rec g_rec_type; -- Global record definition
77 g_called_from_form boolean := FALSE; -- Global flag set to true by forms
78 -- code calling the RH. If true,
79 -- flexfield validation is not
80 -- performed.
81 --
82 -- ----------------------------------------------------------------------------
83 -- |---------------------------< constraint_error >---------------------------|
84 -- ----------------------------------------------------------------------------
85 -- {Start Of Comments}
86 --
87 -- Description:
88 -- This procedure is called when a constraint has been violated (i.e.
89 -- The exception hr_api.check_integrity_violated,
90 -- hr_api.parent_integrity_violated, hr_api.child_integrity_violated or
91 -- hr_api.unique_integrity_violated has been raised).
92 -- The exceptions can only be raised as follows:
93 -- 1) A check constraint can only be violated during an INSERT or UPDATE
94 -- dml operation.
95 -- 2) A parent integrity constraint can only be violated during an
96 -- INSERT or UPDATE dml operation.
97 -- 3) A child integrity constraint can only be violated during an
98 -- DELETE dml operation.
99 -- 4) A unique integrity constraint can only be violated during INSERT or
100 -- UPDATE dml operation.
101 --
102 -- Pre Conditions:
103 -- 1) Either hr_api.check_integrity_violated,
104 -- hr_api.parent_integrity_violated, hr_api.child_integrity_violated or
105 -- hr_api.unique_integrity_violated has been raised with the subsequent
106 -- stripping of the constraint name from the generated error message
107 -- text.
108 -- 2) Standalone validation test which corresponds with a constraint error.
109 --
110 -- In Parameter:
111 -- p_constraint_name is in upper format and is just the constraint name
112 -- (e.g. not prefixed by brackets, schema owner etc).
113 --
114 -- Post Success:
115 -- Development dependant.
116 --
117 -- Post Failure:
118 -- Developement dependant.
119 --
120 -- Developer Implementation Notes:
121 -- For each constraint being checked the hr system package failure message
122 -- has been generated as a template only. These system error messages should
123 -- be modified as required (i.e. change the system failure message to a user
124 -- friendly defined error message).
125 --
126 -- Access Status:
127 -- Internal Development Use Only.
128 --
129 -- {End Of Comments}
130 -- ----------------------------------------------------------------------------
131 Procedure constraint_error
132 (p_constraint_name in all_constraints.constraint_name%TYPE);
133 --
134 -- ----------------------------------------------------------------------------
135 -- |-----------------------------< api_updating >-----------------------------|
136 -- ----------------------------------------------------------------------------
137 -- {Start Of Comments}
138 --
139 -- Description:
140 -- This function is used to populate the g_old_rec record with the
141 -- current row from the database for the specified primary key
142 -- provided that the primary key exists and is valid and does not
143 -- already match the current g_old_rec. The function will always return
144 -- a TRUE value if the g_old_rec is populated with the current row.
145 -- A FALSE value will be returned if all of the primary key arguments
146 -- are null.
147 --
148 -- Pre Conditions:
149 -- None.
150 --
151 -- In Parameters:
152 --
153 -- Post Success:
154 -- A value of TRUE will be returned indiciating that the g_old_rec
155 -- is current.
156 -- A value of FALSE will be returned if all of the primary key arguments
157 -- have a null value (this indicates that the row has not be inserted into
158 -- the Schema), and therefore could never have a corresponding row.
159 --
160 -- Post Failure:
161 -- A failure can only occur under two circumstances:
162 -- 1) The primary key is invalid (i.e. a row does not exist for the
163 -- specified primary key values).
164 -- 2) If an object_version_number exists but is NOT the same as the current
165 -- g_old_rec value.
166 --
167 -- Developer Implementation Notes:
168 -- None.
169 --
170 -- Access Status:
171 -- Internal Development Use Only.
172 --
173 -- {End Of Comments}
174 -- ----------------------------------------------------------------------------
175 Function api_updating
176 (
177 p_assignment_extra_info_id in number,
178 p_object_version_number in number
179 ) Return Boolean;
180 --
181 -- ----------------------------------------------------------------------------
182 -- |---------------------------------< lck >----------------------------------|
183 -- ----------------------------------------------------------------------------
184 -- {Start Of Comments}
185 --
186 -- Description:
187 -- The Lck process has two main functions to perform. Firstly, the row to be
188 -- updated or deleted must be locked. The locking of the row will only be
189 -- successful if the row is not currently locked by another user.
190 -- Secondly, during the locking of the row, the row is selected into
191 -- the g_old_rec data structure which enables the current row values from the
192 -- server to be available to the api.
193 --
194 -- Pre Conditions:
195 -- When attempting to call the lock the object version number (if defined)
196 -- is mandatory.
197 --
198 -- In Parameters:
199 -- The arguments to the Lck process are the primary key(s) which uniquely
200 -- identify the row and the object version number of row.
201 --
202 -- Post Success:
203 -- On successful completion of the Lck process the row to be updated or
204 -- deleted will be locked and selected into the global data structure
205 -- g_old_rec.
206 --
207 -- Post Failure:
208 -- The Lck process can fail for three reasons:
209 -- 1) When attempting to lock the row the row could already be locked by
210 -- another user. This will raise the HR_Api.Object_Locked exception.
211 -- 2) The row which is required to be locked doesn't exist in the HR Schema.
212 -- This error is trapped and reported using the message name
213 -- 'HR_7220_INVALID_PRIMARY_KEY'.
214 -- 3) The row although existing in the HR Schema has a different object
215 -- version number than the object version number specified.
216 -- This error is trapped and reported using the message name
217 -- 'HR_7155_OBJECT_INVALID'.
218 --
219 -- Developer Implementation Notes:
220 -- For each primary key and the object version number arguments add a
221 -- call to hr_api.mandatory_arg_error procedure to ensure that these
222 -- argument values are not null.
223 --
224 -- Access Status:
225 -- Internal Development Use Only.
226 --
227 -- {End Of Comments}
228 -- ----------------------------------------------------------------------------
229 Procedure lck
230 (
231 p_assignment_extra_info_id in number,
232 p_object_version_number in number
233 );
234 --
235 -- ----------------------------------------------------------------------------
236 -- |-----------------------------< convert_args >-----------------------------|
237 -- ----------------------------------------------------------------------------
238 -- {Start Of Comments}
239 --
240 -- Description:
241 -- This function is used to turn attribute parameters into the record
242 -- structure parameter g_rec_type.
243 --
244 -- Pre Conditions:
245 -- This is a private function and can only be called from the ins or upd
246 -- attribute processes.
247 --
248 -- In Parameters:
249 --
250 -- Post Success:
251 -- A returning record structure will be returned.
252 --
253 -- Post Failure:
254 -- No direct error handling is required within this function. Any possible
255 -- errors within this function will be a PL/SQL value error due to conversion
256 -- of datatypes or data lengths.
257 --
258 -- Developer Implementation Notes:
259 -- None.
260 --
261 -- Access Status:
262 -- Internal Table Handler Use Only.
263 --
264 -- {End Of Comments}
265 -- ----------------------------------------------------------------------------
266 Function convert_args
267 (
268 p_assignment_extra_info_id in number,
269 p_assignment_id in number,
270 p_information_type in varchar2,
271 p_request_id in number,
272 p_program_application_id in number,
273 p_program_id in number,
274 p_program_update_date in date,
275 p_aei_attribute_category in varchar2,
276 p_aei_attribute1 in varchar2,
277 p_aei_attribute2 in varchar2,
278 p_aei_attribute3 in varchar2,
279 p_aei_attribute4 in varchar2,
280 p_aei_attribute5 in varchar2,
281 p_aei_attribute6 in varchar2,
282 p_aei_attribute7 in varchar2,
283 p_aei_attribute8 in varchar2,
284 p_aei_attribute9 in varchar2,
285 p_aei_attribute10 in varchar2,
286 p_aei_attribute11 in varchar2,
287 p_aei_attribute12 in varchar2,
288 p_aei_attribute13 in varchar2,
289 p_aei_attribute14 in varchar2,
290 p_aei_attribute15 in varchar2,
291 p_aei_attribute16 in varchar2,
292 p_aei_attribute17 in varchar2,
293 p_aei_attribute18 in varchar2,
294 p_aei_attribute19 in varchar2,
295 p_aei_attribute20 in varchar2,
296 p_aei_information_category in varchar2,
297 p_aei_information1 in varchar2,
298 p_aei_information2 in varchar2,
299 p_aei_information3 in varchar2,
300 p_aei_information4 in varchar2,
301 p_aei_information5 in varchar2,
302 p_aei_information6 in varchar2,
303 p_aei_information7 in varchar2,
304 p_aei_information8 in varchar2,
305 p_aei_information9 in varchar2,
306 p_aei_information10 in varchar2,
307 p_aei_information11 in varchar2,
308 p_aei_information12 in varchar2,
309 p_aei_information13 in varchar2,
310 p_aei_information14 in varchar2,
311 p_aei_information15 in varchar2,
312 p_aei_information16 in varchar2,
313 p_aei_information17 in varchar2,
314 p_aei_information18 in varchar2,
315 p_aei_information19 in varchar2,
316 p_aei_information20 in varchar2,
317 p_aei_information21 in varchar2,
318 p_aei_information22 in varchar2,
319 p_aei_information23 in varchar2,
320 p_aei_information24 in varchar2,
321 p_aei_information25 in varchar2,
322 p_aei_information26 in varchar2,
323 p_aei_information27 in varchar2,
324 p_aei_information28 in varchar2,
325 p_aei_information29 in varchar2,
326 p_aei_information30 in varchar2,
327 p_object_version_number in number
328 )
329 Return g_rec_type;
330 --
331 -- ----------------------------------------------------------------------------
332 -- |-------------------------< set_called_from_form >-------------------------|
333 -- ----------------------------------------------------------------------------
334 -- {Start Of Comments}
335 --
336 -- Description:
337 -- This procedure is used to set the global g_called_from_form which controls
338 -- the execution of the df and ddf data validation. When set the df and ddf
339 -- validation is bypassed.
340 --
341 -- Pre Conditions:
342 -- This is a public function
343 --
344 -- In Parameters:
345 --
346 -- Post Success:
347 -- The global variable is set.
348 --
349 -- Post Failure:
350 -- No failure condition exists.
351 --
352 -- Developer Implementation Notes:
353 -- None.
354 --
355 -- Access Status:
356 -- Internal Development Use Only.
357 --
358 -- {End Of Comments}
359 -- ----------------------------------------------------------------------------
360 Procedure set_called_from_form
361 ( p_flag in boolean );
362 --
363 end pe_aei_shd;
[Home] [Help]