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