1 Package pqh_rei_shd as
2 /* $Header: pqreirhi.pkh 120.0 2005/05/29 02:27:10 appldev noship $ */
3
4 --
5 -- ----------------------------------------------------------------------------
6 -- | Global Record Type Specification |
7 -- ----------------------------------------------------------------------------
8 --
9 Type g_rec_type Is Record
10 (role_extra_info_id number(15)
11 ,role_id number(15)
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 ,attribute_category varchar2(30)
18 ,attribute1 varchar2(150)
19 ,attribute2 varchar2(150)
20 ,attribute3 varchar2(150)
21 ,attribute4 varchar2(150)
22 ,attribute5 varchar2(150)
23 ,attribute6 varchar2(150)
24 ,attribute7 varchar2(150)
25 ,attribute8 varchar2(150)
26 ,attribute9 varchar2(150)
27 ,attribute10 varchar2(150)
28 ,attribute11 varchar2(150)
29 ,attribute12 varchar2(150)
30 ,attribute13 varchar2(150)
31 ,attribute14 varchar2(150)
32 ,attribute15 varchar2(150)
33 ,attribute16 varchar2(150)
34 ,attribute17 varchar2(150)
35 ,attribute18 varchar2(150)
36 ,attribute19 varchar2(150)
37 ,attribute20 varchar2(150)
38 ,attribute21 varchar2(150)
39 ,attribute22 varchar2(150)
40 ,attribute23 varchar2(150)
41 ,attribute24 varchar2(150)
42 ,attribute25 varchar2(150)
43 ,attribute26 varchar2(150)
44 ,attribute27 varchar2(150)
45 ,attribute28 varchar2(150)
46 ,attribute29 varchar2(150)
47 ,attribute30 varchar2(150)
48 ,information_category varchar2(30)
49 ,information1 varchar2(150)
50 ,information2 varchar2(150)
51 ,information3 varchar2(150)
52 ,information4 varchar2(150)
53 ,information5 varchar2(150)
54 ,information6 varchar2(150)
55 ,information7 varchar2(150)
56 ,information8 varchar2(150)
57 ,information9 varchar2(150)
58 ,information10 varchar2(150)
59 ,information11 varchar2(150)
60 ,information12 varchar2(150)
61 ,information13 varchar2(150)
62 ,information14 varchar2(150)
63 ,information15 varchar2(150)
64 ,information16 varchar2(150)
65 ,information17 varchar2(150)
66 ,information18 varchar2(150)
67 ,information19 varchar2(150)
68 ,information20 varchar2(150)
69 ,information21 varchar2(150)
70 ,information22 varchar2(150)
71 ,information23 varchar2(150)
72 ,information24 varchar2(150)
73 ,information25 varchar2(150)
74 ,information26 varchar2(150)
75 ,information27 varchar2(150)
76 ,information28 varchar2(150)
77 ,information29 varchar2(150)
78 ,information30 varchar2(150)
79 ,object_version_number number(9)
80 );
81 --
82 -- ----------------------------------------------------------------------------
83 -- | Global Definitions - Internal Development Use Only |
84 -- ----------------------------------------------------------------------------
85 --
86 g_old_rec g_rec_type; -- Global record definition
87 -- Global table name
88 g_tab_nam constant varchar2(30) := 'PQH_ROLE_EXTRA_INFO';
89 --
90 -- ----------------------------------------------------------------------------
91 -- |---------------------------< constraint_error >---------------------------|
92 -- ----------------------------------------------------------------------------
93 -- {Start Of Comments}
94 --
95 -- Description:
96 -- This procedure is called when a constraint has been violated (i.e.
97 -- The exception hr_api.check_integrity_violated,
98 -- hr_api.parent_integrity_violated, hr_api.child_integrity_violated or
99 -- hr_api.unique_integrity_violated has been raised).
100 -- The exceptions can only be raised as follows:
101 -- 1) A check constraint can only be violated during an INSERT or UPDATE
102 -- dml operation.
103 -- 2) A parent integrity constraint can only be violated during an
104 -- INSERT or UPDATE dml operation.
105 -- 3) A child integrity constraint can only be violated during an
106 -- DELETE dml operation.
107 -- 4) A unique integrity constraint can only be violated during INSERT or
108 -- UPDATE dml operation.
109 --
110 -- Prerequisites:
111 -- 1) Either hr_api.check_integrity_violated,
112 -- hr_api.parent_integrity_violated, hr_api.child_integrity_violated or
113 -- hr_api.unique_integrity_violated has been raised with the subsequent
114 -- stripping of the constraint name from the generated error message
115 -- text.
116 -- 2) Standalone validation test which corresponds with a constraint error.
117 --
118 -- In Parameter:
119 -- p_constraint_name is in upper format and is just the constraint name
120 -- (e.g. not prefixed by brackets, schema owner etc).
121 --
122 -- Post Success:
123 -- Development dependant.
124 --
125 -- Post Failure:
126 -- Developement dependant.
127 --
128 -- Developer Implementation Notes:
129 -- For each constraint being checked the hr system package failure message
130 -- has been generated as a template only. These system error messages should
131 -- be modified as required (i.e. change the system failure message to a user
132 -- friendly defined error message).
133 --
134 -- Access Status:
135 -- Internal Development Use Only.
136 --
137 -- {End Of Comments}
138 -- ----------------------------------------------------------------------------
139 Procedure constraint_error
140 (p_constraint_name in all_constraints.constraint_name%TYPE);
141 --
142 -- ----------------------------------------------------------------------------
143 -- |-----------------------------< api_updating >-----------------------------|
144 -- ----------------------------------------------------------------------------
145 -- {Start Of Comments}
146 --
147 -- Description:
148 -- This function is used to populate the g_old_rec record with the
149 -- current row from the database for the specified primary key
150 -- provided that the primary key exists and is valid and does not
151 -- already match the current g_old_rec. The function will always return
152 -- a TRUE value if the g_old_rec is populated with the current row.
153 -- A FALSE value will be returned if all of the primary key arguments
154 -- are null.
155 --
156 -- Prerequisites:
157 -- None.
158 --
159 -- In Parameters:
160 --
161 -- Post Success:
162 -- A value of TRUE will be returned indiciating that the g_old_rec
163 -- is current.
164 -- A value of FALSE will be returned if all of the primary key arguments
165 -- have a null value (this indicates that the row has not be inserted into
166 -- the Schema), and therefore could never have a corresponding row.
167 --
168 -- Post Failure:
169 -- A failure can only occur under two circumstances:
170 -- 1) The primary key is invalid (i.e. a row does not exist for the
171 -- specified primary key values).
172 -- 2) If an object_version_number exists but is NOT the same as the current
173 -- g_old_rec value.
174 --
175 -- Developer Implementation Notes:
176 -- None.
177 --
178 -- Access Status:
179 -- Internal Development Use Only.
180 --
181 -- {End Of Comments}
182 -- ----------------------------------------------------------------------------
183 Function api_updating
184 (p_role_extra_info_id in number
185 ,p_object_version_number in number
186 ) Return Boolean;
187 --
188 -- ----------------------------------------------------------------------------
189 -- |---------------------------------< lck >----------------------------------|
190 -- ----------------------------------------------------------------------------
191 -- {Start of comments}
192 --
193 -- Description:
194 -- The Lck process has two main functions to perform. Firstly, the row to be
195 -- updated or deleted must be locked. The locking of the row will only be
196 -- successful if the row is not currently locked by another user.
197 -- Secondly, during the locking of the row, the row is selected into
198 -- the g_old_rec data structure which enables the current row values from
199 -- the server to be available to the api.
200 --
201 -- Prerequisites:
202 -- When attempting to call the lock the object version number (if defined)
203 -- is mandatory.
204 --
205 -- In Parameters:
206 -- The arguments to the Lck process are the primary key(s) which uniquely
207 -- identify the row and the object version number of row.
208 --
209 -- Post Success:
210 -- On successful completion of the Lck process the row to be updated or
211 -- deleted will be locked and selected into the global data structure
212 -- g_old_rec.
213 --
214 -- Post Failure:
215 -- The Lck process can fail for three reasons:
216 -- 1) When attempting to lock the row the row could already be locked by
217 -- another user. This will raise the HR_Api.Object_Locked exception.
218 -- 2) The row which is required to be locked doesn't exist in the HR Schema.
219 -- This error is trapped and reported using the message name
220 -- 'HR_7220_INVALID_PRIMARY_KEY'.
221 -- 3) The row although existing in the HR Schema has a different object
222 -- version number than the object version number specified.
223 -- This error is trapped and reported using the message name
224 -- 'HR_7155_OBJECT_INVALID'.
225 --
226 -- Developer Implementation Notes:
227 -- For each primary key and the object version number arguments add a
228 -- call to hr_api.mandatory_arg_error procedure to ensure that these
229 -- argument values are not null.
230 --
231 -- Access Status:
232 -- Internal Development Use Only.
233 --
234 -- {End of comments}
235 -- ----------------------------------------------------------------------------
236 Procedure lck
237 (p_role_extra_info_id in number
238 ,p_object_version_number in number
239 );
240 --
241 -- ----------------------------------------------------------------------------
242 -- |-----------------------------< convert_args >-----------------------------|
243 -- ----------------------------------------------------------------------------
244 -- {Start Of Comments}
245 --
246 -- Description:
247 -- This function is used to turn attribute parameters into the record
248 -- structure parameter g_rec_type.
249 --
250 -- Prerequisites:
251 -- This is a private function and can only be called from the ins or upd
252 -- attribute processes.
253 --
254 -- In Parameters:
255 --
256 -- Post Success:
257 -- A returning record structure will be returned.
258 --
259 -- Post Failure:
260 -- No direct error handling is required within this function. Any possible
261 -- errors within this function will be a PL/SQL value error due to
262 -- conversion of datatypes or data lengths.
263 --
264 -- Developer Implementation Notes:
265 -- None.
266 --
267 -- Access Status:
268 -- Internal Row Handler Use Only.
269 --
270 -- {End Of Comments}
271 -- ----------------------------------------------------------------------------
272 Function convert_args
273 (p_role_extra_info_id in number
274 ,p_role_id in number
275 ,p_information_type in varchar2
276 ,p_request_id in number
277 ,p_program_application_id in number
278 ,p_program_id in number
279 ,p_program_update_date in date
280 ,p_attribute_category in varchar2
281 ,p_attribute1 in varchar2
282 ,p_attribute2 in varchar2
283 ,p_attribute3 in varchar2
284 ,p_attribute4 in varchar2
285 ,p_attribute5 in varchar2
286 ,p_attribute6 in varchar2
287 ,p_attribute7 in varchar2
288 ,p_attribute8 in varchar2
289 ,p_attribute9 in varchar2
290 ,p_attribute10 in varchar2
291 ,p_attribute11 in varchar2
292 ,p_attribute12 in varchar2
293 ,p_attribute13 in varchar2
294 ,p_attribute14 in varchar2
295 ,p_attribute15 in varchar2
296 ,p_attribute16 in varchar2
297 ,p_attribute17 in varchar2
298 ,p_attribute18 in varchar2
299 ,p_attribute19 in varchar2
300 ,p_attribute20 in varchar2
301 ,p_attribute21 in varchar2
302 ,p_attribute22 in varchar2
303 ,p_attribute23 in varchar2
304 ,p_attribute24 in varchar2
305 ,p_attribute25 in varchar2
306 ,p_attribute26 in varchar2
307 ,p_attribute27 in varchar2
308 ,p_attribute28 in varchar2
309 ,p_attribute29 in varchar2
310 ,p_attribute30 in varchar2
311 ,p_information_category in varchar2
312 ,p_information1 in varchar2
313 ,p_information2 in varchar2
314 ,p_information3 in varchar2
315 ,p_information4 in varchar2
316 ,p_information5 in varchar2
317 ,p_information6 in varchar2
318 ,p_information7 in varchar2
319 ,p_information8 in varchar2
320 ,p_information9 in varchar2
321 ,p_information10 in varchar2
322 ,p_information11 in varchar2
323 ,p_information12 in varchar2
324 ,p_information13 in varchar2
325 ,p_information14 in varchar2
326 ,p_information15 in varchar2
327 ,p_information16 in varchar2
328 ,p_information17 in varchar2
329 ,p_information18 in varchar2
330 ,p_information19 in varchar2
331 ,p_information20 in varchar2
332 ,p_information21 in varchar2
333 ,p_information22 in varchar2
334 ,p_information23 in varchar2
335 ,p_information24 in varchar2
336 ,p_information25 in varchar2
337 ,p_information26 in varchar2
338 ,p_information27 in varchar2
339 ,p_information28 in varchar2
340 ,p_information29 in varchar2
341 ,p_information30 in varchar2
342 ,p_object_version_number in number
343 )
344 Return g_rec_type;
345 --
346 end pqh_rei_shd;
[Home] [Help]