1 Package hr_lei_shd as
2 /* $Header: hrleirhi.pkh 120.0.12000000.1 2007/01/21 17:09:16 appldev ship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- | Global Record Type Specification |
6 -- ----------------------------------------------------------------------------
7 --
8 Type g_rec_type Is Record
9 (
10 location_extra_info_id number(15),
11 information_type varchar2(40),
12 location_id number(15),
13 request_id number(15),
14 program_application_id number(15),
15 program_id number(15),
16 program_update_date date,
17 lei_attribute_category varchar2(30),
18 lei_attribute1 varchar2(150),
19 lei_attribute2 varchar2(150),
20 lei_attribute3 varchar2(150),
21 lei_attribute4 varchar2(150),
22 lei_attribute5 varchar2(150),
23 lei_attribute6 varchar2(150),
24 lei_attribute7 varchar2(150),
25 lei_attribute8 varchar2(150),
26 lei_attribute9 varchar2(150),
27 lei_attribute10 varchar2(150),
28 lei_attribute11 varchar2(150),
29 lei_attribute12 varchar2(150),
30 lei_attribute13 varchar2(150),
31 lei_attribute14 varchar2(150),
32 lei_attribute15 varchar2(150),
33 lei_attribute16 varchar2(150),
34 lei_attribute17 varchar2(150),
35 lei_attribute18 varchar2(150),
36 lei_attribute19 varchar2(150),
37 lei_attribute20 varchar2(150),
38 lei_information_category varchar2(30),
39 lei_information1 varchar2(150),
40 lei_information2 varchar2(150),
41 lei_information3 varchar2(150),
42 lei_information4 varchar2(150),
43 lei_information5 varchar2(150),
44 lei_information6 varchar2(150),
45 lei_information7 varchar2(150),
46 lei_information8 varchar2(150),
47 lei_information9 varchar2(150),
48 lei_information10 varchar2(150),
49 lei_information11 varchar2(150),
50 lei_information12 varchar2(150),
51 lei_information13 varchar2(150),
52 lei_information14 varchar2(150),
53 lei_information15 varchar2(150),
54 lei_information16 varchar2(150),
55 lei_information17 varchar2(150),
56 lei_information18 varchar2(150),
57 lei_information19 varchar2(150),
58 lei_information20 varchar2(150),
59 lei_information21 varchar2(150),
60 lei_information22 varchar2(150),
61 lei_information23 varchar2(150),
62 lei_information24 varchar2(150),
63 lei_information25 varchar2(150),
64 lei_information26 varchar2(150),
65 lei_information27 varchar2(150),
66 lei_information28 varchar2(150),
67 lei_information29 varchar2(150),
68 lei_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 -- ----------------------------------------------------------------------------
78 -- |---------------------------< constraint_error >---------------------------|
79 -- ----------------------------------------------------------------------------
80 -- {Start Of Comments}
81 --
82 -- Description:
83 -- This procedure is called when a constraint has been violated (i.e.
84 -- The exception hr_api.check_integrity_violated,
85 -- hr_api.parent_integrity_violated, hr_api.child_integrity_violated or
86 -- hr_api.unique_integrity_violated has been raised).
87 -- The exceptions can only be raised as follows:
88 -- 1) A check constraint can only be violated during an INSERT or UPDATE
89 -- dml operation.
90 -- 2) A parent integrity constraint can only be violated during an
91 -- INSERT or UPDATE dml operation.
92 -- 3) A child integrity constraint can only be violated during an
93 -- DELETE dml operation.
94 -- 4) A unique integrity constraint can only be violated during INSERT or
95 -- UPDATE dml operation.
96 --
97 -- Pre Conditions:
98 -- 1) Either hr_api.check_integrity_violated,
99 -- hr_api.parent_integrity_violated, hr_api.child_integrity_violated or
100 -- hr_api.unique_integrity_violated has been raised with the subsequent
101 -- stripping of the constraint name from the generated error message
102 -- text.
103 -- 2) Standalone validation test which corresponds with a constraint error.
104 --
105 -- In Parameter:
106 -- p_constraint_name is in upper format and is just the constraint name
107 -- (e.g. not prefixed by brackets, schema owner etc).
108 --
109 -- Post Success:
110 -- Development dependant.
111 --
112 -- Post Failure:
113 -- Developement dependant.
114 --
115 -- Developer Implementation Notes:
116 -- For each constraint being checked the hr system package failure message
117 -- has been generated as a template only. These system error messages should
118 -- be modified as required (i.e. change the system failure message to a user
119 -- friendly defined error message).
120 --
121 -- Access Status:
122 -- Internal Development Use Only.
123 --
124 -- {End Of Comments}
125 -- ----------------------------------------------------------------------------
126 Procedure constraint_error
127 (p_constraint_name in all_constraints.constraint_name%TYPE);
128 --
129 -- ----------------------------------------------------------------------------
130 -- |-----------------------------< api_updating >-----------------------------|
131 -- ----------------------------------------------------------------------------
132 -- {Start Of Comments}
133 --
134 -- Description:
135 -- This function is used to populate the g_old_rec record with the
136 -- current row from the database for the specified primary key
137 -- provided that the primary key exists and is valid and does not
138 -- already match the current g_old_rec. The function will always return
139 -- a TRUE value if the g_old_rec is populated with the current row.
140 -- A FALSE value will be returned if all of the primary key arguments
141 -- are null.
142 --
143 -- Pre Conditions:
144 -- None.
145 --
146 -- In Parameters:
147 --
148 -- Post Success:
149 -- A value of TRUE will be returned indiciating that the g_old_rec
150 -- is current.
151 -- A value of FALSE will be returned if all of the primary key arguments
152 -- have a null value (this indicates that the row has not be inserted into
153 -- the Schema), and therefore could never have a corresponding row.
154 --
155 -- Post Failure:
156 -- A failure can only occur under two circumstances:
157 -- 1) The primary key is invalid (i.e. a row does not exist for the
158 -- specified primary key values).
159 -- 2) If an object_version_number exists but is NOT the same as the current
160 -- g_old_rec value.
161 --
162 -- Developer Implementation Notes:
163 -- None.
164 --
165 -- Access Status:
166 -- Internal Development Use Only.
167 --
168 -- {End Of Comments}
169 -- ----------------------------------------------------------------------------
170 Function api_updating
171 (
172 p_location_extra_info_id in number,
173 p_object_version_number in number
174 ) Return Boolean;
175 --
176 -- ----------------------------------------------------------------------------
177 -- |---------------------------------< lck >----------------------------------|
178 -- ----------------------------------------------------------------------------
179 -- {Start Of Comments}
180 --
181 -- Description:
182 -- The Lck process has two main functions to perform. Firstly, the row to be
183 -- updated or deleted must be locked. The locking of the row will only be
184 -- successful if the row is not currently locked by another user.
185 -- Secondly, during the locking of the row, the row is selected into
186 -- the g_old_rec data structure which enables the current row values from the
187 -- server to be available to the api.
188 --
189 -- Pre Conditions:
190 -- When attempting to call the lock the object version number (if defined)
191 -- is mandatory.
192 --
193 -- In Parameters:
194 -- The arguments to the Lck process are the primary key(s) which uniquely
195 -- identify the row and the object version number of row.
196 --
197 -- Post Success:
198 -- On successful completion of the Lck process the row to be updated or
199 -- deleted will be locked and selected into the global data structure
200 -- g_old_rec.
201 --
202 -- Post Failure:
203 -- The Lck process can fail for three reasons:
204 -- 1) When attempting to lock the row the row could already be locked by
205 -- another user. This will raise the HR_Api.Object_Locked exception.
206 -- 2) The row which is required to be locked doesn't exist in the HR Schema.
207 -- This error is trapped and reported using the message name
208 -- 'HR_7220_INVALID_PRIMARY_KEY'.
209 -- 3) The row although existing in the HR Schema has a different object
210 -- version number than the object version number specified.
211 -- This error is trapped and reported using the message name
212 -- 'HR_7155_OBJECT_INVALID'.
213 --
214 -- Developer Implementation Notes:
215 -- For each primary key and the object version number arguments add a
216 -- call to hr_api.mandatory_arg_error procedure to ensure that these
217 -- argument values are not null.
218 --
219 -- Access Status:
220 -- Internal Development Use Only.
221 --
222 -- {End Of Comments}
223 -- ----------------------------------------------------------------------------
224 Procedure lck
225 (
226 p_location_extra_info_id in number,
227 p_object_version_number in number
228 );
229 --
230 -- ----------------------------------------------------------------------------
231 -- |-----------------------------< convert_args >-----------------------------|
232 -- ----------------------------------------------------------------------------
233 -- {Start Of Comments}
234 --
235 -- Description:
236 -- This function is used to turn attribute parameters into the record
237 -- structure parameter g_rec_type.
238 --
239 -- Pre Conditions:
240 -- This is a private function and can only be called from the ins or upd
241 -- attribute processes.
242 --
243 -- In Parameters:
244 --
245 -- Post Success:
246 -- A returning record structure will be returned.
247 --
248 -- Post Failure:
249 -- No direct error handling is required within this function. Any possible
250 -- errors within this function will be a PL/SQL value error due to conversion
251 -- of datatypes or data lengths.
252 --
253 -- Developer Implementation Notes:
254 -- None.
255 --
256 -- Access Status:
257 -- Internal Table Handler Use Only.
258 --
259 -- {End Of Comments}
260 -- ----------------------------------------------------------------------------
261 Function convert_args
262 (
263 p_location_extra_info_id in number,
264 p_information_type in varchar2,
265 p_location_id in number,
266 p_request_id in number,
267 p_program_application_id in number,
268 p_program_id in number,
269 p_program_update_date in date,
270 p_lei_attribute_category in varchar2,
271 p_lei_attribute1 in varchar2,
272 p_lei_attribute2 in varchar2,
273 p_lei_attribute3 in varchar2,
274 p_lei_attribute4 in varchar2,
275 p_lei_attribute5 in varchar2,
276 p_lei_attribute6 in varchar2,
277 p_lei_attribute7 in varchar2,
278 p_lei_attribute8 in varchar2,
279 p_lei_attribute9 in varchar2,
280 p_lei_attribute10 in varchar2,
281 p_lei_attribute11 in varchar2,
282 p_lei_attribute12 in varchar2,
283 p_lei_attribute13 in varchar2,
284 p_lei_attribute14 in varchar2,
285 p_lei_attribute15 in varchar2,
286 p_lei_attribute16 in varchar2,
287 p_lei_attribute17 in varchar2,
288 p_lei_attribute18 in varchar2,
289 p_lei_attribute19 in varchar2,
290 p_lei_attribute20 in varchar2,
291 p_lei_information_category in varchar2,
292 p_lei_information1 in varchar2,
293 p_lei_information2 in varchar2,
294 p_lei_information3 in varchar2,
295 p_lei_information4 in varchar2,
296 p_lei_information5 in varchar2,
297 p_lei_information6 in varchar2,
298 p_lei_information7 in varchar2,
299 p_lei_information8 in varchar2,
300 p_lei_information9 in varchar2,
301 p_lei_information10 in varchar2,
302 p_lei_information11 in varchar2,
303 p_lei_information12 in varchar2,
304 p_lei_information13 in varchar2,
305 p_lei_information14 in varchar2,
306 p_lei_information15 in varchar2,
307 p_lei_information16 in varchar2,
308 p_lei_information17 in varchar2,
309 p_lei_information18 in varchar2,
310 p_lei_information19 in varchar2,
311 p_lei_information20 in varchar2,
312 p_lei_information21 in varchar2,
313 p_lei_information22 in varchar2,
314 p_lei_information23 in varchar2,
315 p_lei_information24 in varchar2,
316 p_lei_information25 in varchar2,
317 p_lei_information26 in varchar2,
318 p_lei_information27 in varchar2,
319 p_lei_information28 in varchar2,
320 p_lei_information29 in varchar2,
321 p_lei_information30 in varchar2,
322 p_object_version_number in number
323 )
324 Return g_rec_type;
325 --
326 end hr_lei_shd;
[Home] [Help]