1 Package hr_dei_shd AUTHID CURRENT_USER as
2 /* $Header: hrdeirhi.pkh 120.2 2010/04/07 11:45:22 tkghosh ship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- | Global Record Type Specification |
6 -- ----------------------------------------------------------------------------
7 --
8 Type g_rec_type Is Record
9 (document_extra_info_id number(15)
10 ,person_id number(10)
11 ,document_type_id number(15)
12 ,document_number varchar2(60)
13 ,date_from date
14 ,date_to date
15 ,issued_by varchar2(60)
16 ,issued_at varchar2(60)
17 ,issued_date date
18 ,issuing_authority varchar2(60)
19 ,verified_by number(15)
20 ,verified_date date
21 ,related_object_name varchar2(60)
22 ,related_object_id_col varchar2(60)
23 ,related_object_id number(15)
24 ,dei_attribute_category varchar2(30)
25 ,dei_attribute1 varchar2(150)
26 ,dei_attribute2 varchar2(150)
27 ,dei_attribute3 varchar2(150)
28 ,dei_attribute4 varchar2(150)
29 ,dei_attribute5 varchar2(150)
30 ,dei_attribute6 varchar2(150)
31 ,dei_attribute7 varchar2(150)
32 ,dei_attribute8 varchar2(150)
33 ,dei_attribute9 varchar2(150)
34 ,dei_attribute10 varchar2(150)
35 ,dei_attribute11 varchar2(150)
36 ,dei_attribute12 varchar2(150)
37 ,dei_attribute13 varchar2(150)
38 ,dei_attribute14 varchar2(150)
39 ,dei_attribute15 varchar2(150)
40 ,dei_attribute16 varchar2(150)
41 ,dei_attribute17 varchar2(150)
42 ,dei_attribute18 varchar2(150)
43 ,dei_attribute19 varchar2(150)
44 ,dei_attribute20 varchar2(150)
45 ,dei_attribute21 varchar2(150)
46 ,dei_attribute22 varchar2(150)
47 ,dei_attribute23 varchar2(150)
48 ,dei_attribute24 varchar2(150)
49 ,dei_attribute25 varchar2(150)
50 ,dei_attribute26 varchar2(150)
51 ,dei_attribute27 varchar2(150)
52 ,dei_attribute28 varchar2(150)
53 ,dei_attribute29 varchar2(150)
54 ,dei_attribute30 varchar2(150)
55 ,dei_information_category varchar2(30)
56 ,dei_information1 varchar2(150)
57 ,dei_information2 varchar2(150)
58 ,dei_information3 varchar2(150)
59 ,dei_information4 varchar2(150)
60 ,dei_information5 varchar2(150)
61 ,dei_information6 varchar2(150)
62 ,dei_information7 varchar2(150)
63 ,dei_information8 varchar2(150)
64 ,dei_information9 varchar2(150)
65 ,dei_information10 varchar2(150)
66 ,dei_information11 varchar2(150)
67 ,dei_information12 varchar2(150)
68 ,dei_information13 varchar2(150)
69 ,dei_information14 varchar2(150)
70 ,dei_information15 varchar2(150)
71 ,dei_information16 varchar2(150)
72 ,dei_information17 varchar2(150)
73 ,dei_information18 varchar2(150)
74 ,dei_information19 varchar2(150)
75 ,dei_information20 varchar2(150)
76 ,dei_information21 varchar2(150)
77 ,dei_information22 varchar2(150)
78 ,dei_information23 varchar2(150)
79 ,dei_information24 varchar2(150)
80 ,dei_information25 varchar2(150)
81 ,dei_information26 varchar2(150)
82 ,dei_information27 varchar2(150)
83 ,dei_information28 varchar2(150)
84 ,dei_information29 varchar2(150)
85 ,dei_information30 varchar2(150)
86 ,request_id number(15)
87 ,program_application_id number(15)
88 ,program_id number(15)
89 ,program_update_date date
90 ,object_version_number number(9)
91 );
92 --
93 -- ----------------------------------------------------------------------------
94 -- | Global Definitions - Internal Development Use Only |
95 -- ----------------------------------------------------------------------------
96 --
97 g_old_rec g_rec_type; -- Global record definition
98 -- Global table name
99 g_tab_nam constant varchar2(30) := 'HR_DOCUMENT_EXTRA_INFO';
100 --
101 -- ----------------------------------------------------------------------------
102 -- |---------------------------< constraint_error >---------------------------|
103 -- ----------------------------------------------------------------------------
104 -- {Start Of Comments}
105 --
106 -- Description:
107 -- This procedure is called when a constraint has been violated (i.e.
108 -- The exception hr_api.check_integrity_violated,
109 -- hr_api.parent_integrity_violated, hr_api.child_integrity_violated or
110 -- hr_api.unique_integrity_violated has been raised).
111 -- The exceptions can only be raised as follows:
112 -- 1) A check constraint can only be violated during an INSERT or UPDATE
113 -- dml operation.
114 -- 2) A parent integrity constraint can only be violated during an
115 -- INSERT or UPDATE dml operation.
116 -- 3) A child integrity constraint can only be violated during an
117 -- DELETE dml operation.
118 -- 4) A unique integrity constraint can only be violated during INSERT or
119 -- UPDATE dml operation.
120 --
121 -- Prerequisites:
122 -- 1) Either hr_api.check_integrity_violated,
123 -- hr_api.parent_integrity_violated, hr_api.child_integrity_violated or
124 -- hr_api.unique_integrity_violated has been raised with the subsequent
125 -- stripping of the constraint name from the generated error message
126 -- text.
127 -- 2) Standalone validation test which corresponds with a constraint error.
128 --
129 -- In Parameter:
130 -- p_constraint_name is in upper format and is just the constraint name
131 -- (e.g. not prefixed by brackets, schema owner etc).
132 --
133 -- Post Success:
134 -- Development dependant.
135 --
136 -- Post Failure:
137 -- Developement dependant.
138 --
139 -- Developer Implementation Notes:
140 -- For each constraint being checked the hr system package failure message
141 -- has been generated as a template only. These system error messages should
142 -- be modified as required (i.e. change the system failure message to a user
143 -- friendly defined error message).
144 --
145 -- Access Status:
146 -- Internal Development Use Only.
147 --
148 -- {End Of Comments}
149 -- ----------------------------------------------------------------------------
150 Procedure constraint_error
151 (p_constraint_name in all_constraints.constraint_name%TYPE);
152 --
153 -- ----------------------------------------------------------------------------
154 -- |-----------------------------< api_updating >-----------------------------|
155 -- ----------------------------------------------------------------------------
156 -- {Start Of Comments}
157 --
158 -- Description:
159 -- This function is used to populate the g_old_rec record with the
160 -- current row from the database for the specified primary key
161 -- provided that the primary key exists and is valid and does not
162 -- already match the current g_old_rec. The function will always return
163 -- a TRUE value if the g_old_rec is populated with the current row.
164 -- A FALSE value will be returned if all of the primary key arguments
165 -- are null.
166 --
167 -- Prerequisites:
168 -- None.
169 --
170 -- In Parameters:
171 --
172 -- Post Success:
173 -- A value of TRUE will be returned indiciating that the g_old_rec
174 -- is current.
175 -- A value of FALSE will be returned if all of the primary key arguments
176 -- have a null value (this indicates that the row has not be inserted into
177 -- the Schema), and therefore could never have a corresponding row.
178 --
179 -- Post Failure:
180 -- A failure can only occur under two circumstances:
181 -- 1) The primary key is invalid (i.e. a row does not exist for the
182 -- specified primary key values).
183 -- 2) If an object_version_number exists but is NOT the same as the current
184 -- g_old_rec value.
185 --
186 -- Developer Implementation Notes:
187 -- None.
188 --
189 -- Access Status:
190 -- Internal Development Use Only.
191 --
192 -- {End Of Comments}
193 -- ----------------------------------------------------------------------------
194 Function api_updating
195 (p_document_extra_info_id in number
196 ,p_object_version_number in number
197 ) Return Boolean;
198 --
199 -- ----------------------------------------------------------------------------
200 -- |---------------------------------< lck >----------------------------------|
201 -- ----------------------------------------------------------------------------
202 -- {Start of comments}
203 --
204 -- Description:
205 -- The Lck process has two main functions to perform. Firstly, the row to be
206 -- updated or deleted must be locked. The locking of the row will only be
207 -- successful if the row is not currently locked by another user.
208 -- Secondly, during the locking of the row, the row is selected into
209 -- the g_old_rec data structure which enables the current row values from
210 -- the server to be available to the api.
211 --
212 -- Prerequisites:
213 -- When attempting to call the lock the object version number (if defined)
214 -- is mandatory.
215 --
216 -- In Parameters:
217 -- The arguments to the Lck process are the primary key(s) which uniquely
218 -- identify the row and the object version number of row.
219 --
220 -- Post Success:
221 -- On successful completion of the Lck process the row to be updated or
222 -- deleted will be locked and selected into the global data structure
223 -- g_old_rec.
224 --
225 -- Post Failure:
226 -- The Lck process can fail for three reasons:
227 -- 1) When attempting to lock the row the row could already be locked by
228 -- another user. This will raise the HR_Api.Object_Locked exception.
229 -- 2) The row which is required to be locked doesn't exist in the HR Schema.
230 -- This error is trapped and reported using the message name
231 -- 'HR_7220_INVALID_PRIMARY_KEY'.
232 -- 3) The row although existing in the HR Schema has a different object
233 -- version number than the object version number specified.
234 -- This error is trapped and reported using the message name
235 -- 'HR_7155_OBJECT_INVALID'.
236 --
237 -- Developer Implementation Notes:
238 -- For each primary key and the object version number arguments add a
239 -- call to hr_api.mandatory_arg_error procedure to ensure that these
240 -- argument values are not null.
241 --
242 -- Access Status:
243 -- Internal Development Use Only.
244 --
245 -- {End of comments}
246 -- ----------------------------------------------------------------------------
247 Procedure lck
248 (p_document_extra_info_id in number
249 ,p_object_version_number in number
250 );
251 --
252 -- ----------------------------------------------------------------------------
253 -- |-----------------------------< convert_args >-----------------------------|
254 -- ----------------------------------------------------------------------------
255 -- {Start Of Comments}
256 --
257 -- Description:
258 -- This function is used to turn attribute parameters into the record
259 -- structure parameter g_rec_type.
260 --
261 -- Prerequisites:
262 -- This is a private function and can only be called from the ins or upd
263 -- attribute processes.
264 --
265 -- In Parameters:
266 --
267 -- Post Success:
268 -- A returning record structure will be returned.
269 --
270 -- Post Failure:
271 -- No direct error handling is required within this function. Any possible
272 -- errors within this function will be a PL/SQL value error due to
273 -- conversion of datatypes or data lengths.
274 --
275 -- Developer Implementation Notes:
276 -- None.
277 --
278 -- Access Status:
279 -- Internal Row Handler Use Only.
280 --
281 -- {End Of Comments}
282 -- ----------------------------------------------------------------------------
283 Function convert_args
284 (p_document_extra_info_id in number
285 ,p_person_id in number
286 ,p_document_type_id in number
287 ,p_document_number in varchar2
288 ,p_date_from in date
289 ,p_date_to in date
290 ,p_issued_by in varchar2
291 ,p_issued_at in varchar2
292 ,p_issued_date in date
293 ,p_issuing_authority in varchar2
294 ,p_verified_by in number
295 ,p_verified_date in date
296 ,p_related_object_name in varchar2
297 ,p_related_object_id_col in varchar2
298 ,p_related_object_id in number
299 ,p_dei_attribute_category in varchar2
300 ,p_dei_attribute1 in varchar2
301 ,p_dei_attribute2 in varchar2
302 ,p_dei_attribute3 in varchar2
303 ,p_dei_attribute4 in varchar2
304 ,p_dei_attribute5 in varchar2
305 ,p_dei_attribute6 in varchar2
306 ,p_dei_attribute7 in varchar2
307 ,p_dei_attribute8 in varchar2
308 ,p_dei_attribute9 in varchar2
309 ,p_dei_attribute10 in varchar2
310 ,p_dei_attribute11 in varchar2
311 ,p_dei_attribute12 in varchar2
312 ,p_dei_attribute13 in varchar2
313 ,p_dei_attribute14 in varchar2
314 ,p_dei_attribute15 in varchar2
315 ,p_dei_attribute16 in varchar2
316 ,p_dei_attribute17 in varchar2
317 ,p_dei_attribute18 in varchar2
318 ,p_dei_attribute19 in varchar2
319 ,p_dei_attribute20 in varchar2
320 ,p_dei_attribute21 in varchar2
321 ,p_dei_attribute22 in varchar2
322 ,p_dei_attribute23 in varchar2
323 ,p_dei_attribute24 in varchar2
324 ,p_dei_attribute25 in varchar2
325 ,p_dei_attribute26 in varchar2
326 ,p_dei_attribute27 in varchar2
327 ,p_dei_attribute28 in varchar2
328 ,p_dei_attribute29 in varchar2
329 ,p_dei_attribute30 in varchar2
330 ,p_dei_information_category in varchar2
331 ,p_dei_information1 in varchar2
332 ,p_dei_information2 in varchar2
333 ,p_dei_information3 in varchar2
334 ,p_dei_information4 in varchar2
335 ,p_dei_information5 in varchar2
336 ,p_dei_information6 in varchar2
337 ,p_dei_information7 in varchar2
338 ,p_dei_information8 in varchar2
339 ,p_dei_information9 in varchar2
340 ,p_dei_information10 in varchar2
341 ,p_dei_information11 in varchar2
342 ,p_dei_information12 in varchar2
343 ,p_dei_information13 in varchar2
344 ,p_dei_information14 in varchar2
345 ,p_dei_information15 in varchar2
346 ,p_dei_information16 in varchar2
347 ,p_dei_information17 in varchar2
348 ,p_dei_information18 in varchar2
349 ,p_dei_information19 in varchar2
350 ,p_dei_information20 in varchar2
351 ,p_dei_information21 in varchar2
352 ,p_dei_information22 in varchar2
353 ,p_dei_information23 in varchar2
354 ,p_dei_information24 in varchar2
355 ,p_dei_information25 in varchar2
356 ,p_dei_information26 in varchar2
357 ,p_dei_information27 in varchar2
358 ,p_dei_information28 in varchar2
359 ,p_dei_information29 in varchar2
360 ,p_dei_information30 in varchar2
361 ,p_request_id in number
362 ,p_program_application_id in number
363 ,p_program_id in number
364 ,p_program_update_date in date
365 ,p_object_version_number in number
366 )
367 Return g_rec_type;
368 --
369 end hr_dei_shd;
[Home] [Help]