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