1 Package irc_ipc_shd as
2 /* $Header: iripcrhi.pkh 120.0 2005/07/26 15:08:59 mbocutt noship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- | Global Record Type Specification |
6 -- ----------------------------------------------------------------------------
7 --
8 Type g_rec_type Is Record
9 (posting_content_id number(15)
10 ,display_manager_info varchar2(30)
11 ,display_recruiter_info varchar2(30)
12 ,attribute_category varchar2(30)
13 ,attribute1 varchar2(150)
14 ,attribute2 varchar2(150)
15 ,attribute3 varchar2(150)
16 ,attribute4 varchar2(150)
17 ,attribute5 varchar2(150)
18 ,attribute6 varchar2(150)
19 ,attribute7 varchar2(150)
20 ,attribute8 varchar2(150)
21 ,attribute9 varchar2(150)
22 ,attribute10 varchar2(150)
23 ,attribute11 varchar2(150)
24 ,attribute12 varchar2(150)
25 ,attribute13 varchar2(150)
26 ,attribute14 varchar2(150)
27 ,attribute15 varchar2(150)
28 ,attribute16 varchar2(150)
29 ,attribute17 varchar2(150)
30 ,attribute18 varchar2(150)
31 ,attribute19 varchar2(150)
32 ,attribute20 varchar2(150)
33 ,attribute21 varchar2(150)
34 ,attribute22 varchar2(150)
35 ,attribute23 varchar2(150)
36 ,attribute24 varchar2(150)
37 ,attribute25 varchar2(150)
38 ,attribute26 varchar2(150)
39 ,attribute27 varchar2(150)
40 ,attribute28 varchar2(150)
41 ,attribute29 varchar2(150)
42 ,attribute30 varchar2(150)
43 ,ipc_information_category varchar2(30)
44 ,ipc_information1 varchar2(150)
45 ,ipc_information2 varchar2(150)
46 ,ipc_information3 varchar2(150)
47 ,ipc_information4 varchar2(150)
48 ,ipc_information5 varchar2(150)
49 ,ipc_information6 varchar2(150)
50 ,ipc_information7 varchar2(150)
51 ,ipc_information8 varchar2(150)
52 ,ipc_information9 varchar2(150)
53 ,ipc_information10 varchar2(150)
54 ,ipc_information11 varchar2(150)
55 ,ipc_information12 varchar2(150)
56 ,ipc_information13 varchar2(150)
57 ,ipc_information14 varchar2(150)
58 ,ipc_information15 varchar2(150)
59 ,ipc_information16 varchar2(150)
60 ,ipc_information17 varchar2(150)
61 ,ipc_information18 varchar2(150)
62 ,ipc_information19 varchar2(150)
63 ,ipc_information20 varchar2(150)
64 ,ipc_information21 varchar2(150)
65 ,ipc_information22 varchar2(150)
66 ,ipc_information23 varchar2(150)
67 ,ipc_information24 varchar2(150)
68 ,ipc_information25 varchar2(150)
69 ,ipc_information26 varchar2(150)
70 ,ipc_information27 varchar2(150)
71 ,ipc_information28 varchar2(150)
72 ,ipc_information29 varchar2(150)
73 ,ipc_information30 varchar2(150)
74 ,object_version_number number(9)
75 ,date_approved date
76 ,recruiter_full_name varchar2(240)
77 ,recruiter_email varchar2(240)
78 ,recruiter_work_telephone varchar2(60)
79 ,manager_full_name varchar2(240)
80 ,manager_email varchar2(240)
81 ,manager_work_telephone varchar2(60)
82 );
83 --
84 -- ----------------------------------------------------------------------------
85 -- | Global Definitions - Internal Development Use Only |
86 -- ----------------------------------------------------------------------------
87 --
88 g_old_rec g_rec_type; -- Global record definition
89 g_tab_name constant varchar2(30) := 'IRC_POSTING_CONTENTS';
90 g_api_dml boolean; -- Global api dml status
91 --
92 -- ----------------------------------------------------------------------------
93 -- |------------------------< return_api_dml_status >-------------------------|
94 -- ----------------------------------------------------------------------------
95 -- {Start Of Comments}
96 --
97 -- Description:
98 -- This function will return the current g_api_dml private global
99 -- boolean status.
100 -- The g_api_dml status determines if at the time of the function
101 -- being executed if a dml statement (i.e. INSERT, UPDATE or DELETE)
102 -- is being issued from within an api.
103 -- If the status is TRUE then a dml statement is being issued from
104 -- within this entity api.
105 -- This function is primarily to support database triggers which
106 -- need to maintain the object_version_number for non-supported
107 -- dml statements (i.e. dml statement issued outside of the api layer).
108 --
109 -- Prerequisites:
110 -- none
111 --
112 -- In Parameters:
113 -- None.
114 --
115 -- Post Success:
116 -- Processing continues.
117 -- If the function returns a TRUE value then, dml is being executed from
118 -- within this api.
119 --
120 -- Post Failure:
121 -- None.
122 --
123 -- Access Status:
124 -- Internal Row Handler Use Only.
125 --
126 -- {End Of Comments}
127 --
128 ----------------------------------------------------------------------------
129 Function return_api_dml_status Return Boolean;
130 --
131 -- ----------------------------------------------------------------------------
132 -- |---------------------------< constraint_error >---------------------------|
133 -- ----------------------------------------------------------------------------
134 -- {Start Of Comments}
135 --
136 -- Description:
137 -- This procedure is called when a constraint has been violated (i.e.
138 -- The exception hr_api.check_integrity_violated,
139 -- hr_api.parent_integrity_violated, hr_api.child_integrity_violated or
140 -- hr_api.unique_integrity_violated has been raised).
141 -- The exceptions can only be raised as follows:
142 -- 1) A check constraint can only be violated during an INSERT or UPDATE
143 -- dml operation.
144 -- 2) A parent integrity constraint can only be violated during an
145 -- INSERT or UPDATE dml operation.
146 -- 3) A child integrity constraint can only be violated during an
147 -- DELETE dml operation.
148 -- 4) A unique integrity constraint can only be violated during INSERT or
149 -- UPDATE dml operation.
150 --
151 -- Prerequisites:
152 -- 1) Either hr_api.check_integrity_violated,
153 -- hr_api.parent_integrity_violated, hr_api.child_integrity_violated or
154 -- hr_api.unique_integrity_violated has been raised with the subsequent
155 -- stripping of the constraint name from the generated error message
156 -- text.
157 -- 2) Standalone validation test which corresponds with a constraint error.
158 --
159 -- In Parameter:
160 -- p_constraint_name is in upper format and is just the constraint name
161 -- (e.g. not prefixed by brackets, schema owner etc).
162 --
163 -- Post Success:
164 -- Development dependant.
165 --
166 -- Post Failure:
167 -- Developement dependant.
168 --
169 -- Developer Implementation Notes:
170 -- For each constraint being checked the hr system package failure message
171 -- has been generated as a template only. These system error messages should
172 -- be modified as required (i.e. change the system failure message to a user
173 -- friendly defined error message).
174 --
175 -- Access Status:
176 -- Internal Development Use Only.
177 --
178 -- {End Of Comments}
179 -- ----------------------------------------------------------------------------
180 Procedure constraint_error
181 (p_constraint_name in all_constraints.constraint_name%TYPE);
182 --
183 -- ----------------------------------------------------------------------------
184 -- |-----------------------------< api_updating >-----------------------------|
185 -- ----------------------------------------------------------------------------
186 -- {Start Of Comments}
187 --
188 -- Description:
189 -- This function is used to populate the g_old_rec record with the
190 -- current row from the database for the specified primary key
191 -- provided that the primary key exists and is valid and does not
192 -- already match the current g_old_rec. The function will always return
193 -- a TRUE value if the g_old_rec is populated with the current row.
194 -- A FALSE value will be returned if all of the primary key arguments
195 -- are null.
196 --
197 -- Prerequisites:
198 -- None.
199 --
200 -- In Parameters:
201 --
202 -- Post Success:
203 -- A value of TRUE will be returned indiciating that the g_old_rec
204 -- is current.
205 -- A value of FALSE will be returned if all of the primary key arguments
206 -- have a null value (this indicates that the row has not be inserted into
207 -- the Schema), and therefore could never have a corresponding row.
208 --
209 -- Post Failure:
210 -- A failure can only occur under two circumstances:
211 -- 1) The primary key is invalid (i.e. a row does not exist for the
212 -- specified primary key values).
213 -- 2) If an object_version_number exists but is NOT the same as the current
214 -- g_old_rec value.
215 --
216 -- Developer Implementation Notes:
217 -- None.
218 --
219 -- Access Status:
220 -- Internal Development Use Only.
221 --
222 -- {End Of Comments}
223 -- ----------------------------------------------------------------------------
224 Function api_updating
225 (p_posting_content_id in number
226 ,p_object_version_number in number
227 ) Return Boolean;
228 --
229 -- ----------------------------------------------------------------------------
230 -- |---------------------------------< lck >----------------------------------|
231 -- ----------------------------------------------------------------------------
232 -- {Start of comments}
233 --
234 -- Description:
235 -- The Lck process has two main functions to perform. Firstly, the row to be
236 -- updated or deleted must be locked. The locking of the row will only be
237 -- successful if the row is not currently locked by another user.
238 -- Secondly, during the locking of the row, the row is selected into
239 -- the g_old_rec data structure which enables the current row values from
240 -- the server to be available to the api.
241 --
242 -- Prerequisites:
243 -- When attempting to call the lock the object version number (if defined)
244 -- is mandatory.
245 --
246 -- In Parameters:
247 -- The arguments to the Lck process are the primary key(s) which uniquely
248 -- identify the row and the object version number of row.
249 --
250 -- Post Success:
251 -- On successful completion of the Lck process the row to be updated or
252 -- deleted will be locked and selected into the global data structure
253 -- g_old_rec.
254 --
255 -- Post Failure:
256 -- The Lck process can fail for three reasons:
257 -- 1) When attempting to lock the row the row could already be locked by
258 -- another user. This will raise the HR_Api.Object_Locked exception.
259 -- 2) The row which is required to be locked doesn't exist in the HR Schema.
260 -- This error is trapped and reported using the message name
261 -- 'HR_7220_INVALID_PRIMARY_KEY'.
262 -- 3) The row although existing in the HR Schema has a different object
263 -- version number than the object version number specified.
264 -- This error is trapped and reported using the message name
265 -- 'HR_7155_OBJECT_INVALID'.
266 --
267 -- Developer Implementation Notes:
268 -- For each primary key and the object version number arguments add a
269 -- call to hr_api.mandatory_arg_error procedure to ensure that these
270 -- argument values are not null.
271 --
272 -- Access Status:
273 -- Internal Development Use Only.
274 --
275 -- {End of comments}
276 -- ----------------------------------------------------------------------------
277 Procedure lck
278 (p_posting_content_id in number
279 ,p_object_version_number in number
280 );
281 --
282 -- ----------------------------------------------------------------------------
283 -- |-----------------------------< convert_args >-----------------------------|
284 -- ----------------------------------------------------------------------------
285 -- {Start Of Comments}
286 --
287 -- Description:
288 -- This function is used to turn attribute parameters into the record
289 -- structure parameter g_rec_type.
290 --
291 -- Prerequisites:
292 -- This is a private function and can only be called from the ins or upd
293 -- attribute processes.
294 --
295 -- In Parameters:
296 --
297 -- Post Success:
298 -- A returning record structure will be returned.
299 --
300 -- Post Failure:
301 -- No direct error handling is required within this function. Any possible
302 -- errors within this function will be a PL/SQL value error due to
303 -- conversion of datatypes or data lengths.
304 --
305 -- Developer Implementation Notes:
306 -- None.
307 --
308 -- Access Status:
309 -- Internal Row Handler Use Only.
310 --
311 -- {End Of Comments}
312 -- ----------------------------------------------------------------------------
313 Function convert_args
314 (p_posting_content_id in number
315 ,p_display_manager_info in varchar2
316 ,p_display_recruiter_info in varchar2
317 ,p_attribute_category in varchar2
318 ,p_attribute1 in varchar2
319 ,p_attribute2 in varchar2
320 ,p_attribute3 in varchar2
321 ,p_attribute4 in varchar2
322 ,p_attribute5 in varchar2
323 ,p_attribute6 in varchar2
324 ,p_attribute7 in varchar2
325 ,p_attribute8 in varchar2
326 ,p_attribute9 in varchar2
327 ,p_attribute10 in varchar2
328 ,p_attribute11 in varchar2
329 ,p_attribute12 in varchar2
330 ,p_attribute13 in varchar2
331 ,p_attribute14 in varchar2
332 ,p_attribute15 in varchar2
333 ,p_attribute16 in varchar2
334 ,p_attribute17 in varchar2
335 ,p_attribute18 in varchar2
336 ,p_attribute19 in varchar2
337 ,p_attribute20 in varchar2
338 ,p_attribute21 in varchar2
339 ,p_attribute22 in varchar2
340 ,p_attribute23 in varchar2
341 ,p_attribute24 in varchar2
342 ,p_attribute25 in varchar2
343 ,p_attribute26 in varchar2
344 ,p_attribute27 in varchar2
345 ,p_attribute28 in varchar2
346 ,p_attribute29 in varchar2
347 ,p_attribute30 in varchar2
348 ,p_ipc_information_category in varchar2
349 ,p_ipc_information1 in varchar2
350 ,p_ipc_information2 in varchar2
351 ,p_ipc_information3 in varchar2
352 ,p_ipc_information4 in varchar2
353 ,p_ipc_information5 in varchar2
354 ,p_ipc_information6 in varchar2
355 ,p_ipc_information7 in varchar2
356 ,p_ipc_information8 in varchar2
357 ,p_ipc_information9 in varchar2
358 ,p_ipc_information10 in varchar2
359 ,p_ipc_information11 in varchar2
360 ,p_ipc_information12 in varchar2
361 ,p_ipc_information13 in varchar2
362 ,p_ipc_information14 in varchar2
363 ,p_ipc_information15 in varchar2
364 ,p_ipc_information16 in varchar2
368 ,p_ipc_information20 in varchar2
365 ,p_ipc_information17 in varchar2
366 ,p_ipc_information18 in varchar2
367 ,p_ipc_information19 in varchar2
369 ,p_ipc_information21 in varchar2
370 ,p_ipc_information22 in varchar2
371 ,p_ipc_information23 in varchar2
372 ,p_ipc_information24 in varchar2
373 ,p_ipc_information25 in varchar2
374 ,p_ipc_information26 in varchar2
375 ,p_ipc_information27 in varchar2
376 ,p_ipc_information28 in varchar2
377 ,p_ipc_information29 in varchar2
378 ,p_ipc_information30 in varchar2
379 ,p_object_version_number in number
380 ,p_date_approved in date
381 ,p_recruiter_full_name in varchar2
382 ,p_recruiter_email in varchar2
383 ,p_recruiter_work_telephone in varchar2
384 ,p_manager_full_name in varchar2
385 ,p_manager_email in varchar2
386 ,p_manager_work_telephone in varchar2
387 )
388 Return g_rec_type;
389 --
390 end irc_ipc_shd;
[Home] [Help]