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