1 Package per_add_shd as
2 /* $Header: peaddrhi.pkh 120.0.12010000.1 2008/07/28 04:03:04 appldev ship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- | Global Record Type Specification |
6 -- ----------------------------------------------------------------------------
7 --
8 Type g_rec_type Is Record
9 (
10 address_id number(15),
11 business_group_id number(15),
12 person_id per_addresses.person_id%TYPE,
13 date_from date,
14 primary_flag varchar2(30),
15 derived_locale varchar2(240),
16 style varchar2(30),
17 address_line1 varchar2(240),-- UTF8: Increased from 60 to 240
18 address_line2 varchar2(240),-- UTF8: Increased from 60 to 240
19 address_line3 varchar2(240),-- UTF8: Increased from 60 to 240
20 address_type varchar2(30),
21 comments long,
22 country varchar2(60),
23 date_to date,
24 postal_code varchar2(30),
25 region_1 varchar2(120), -- UTF8: Increased from 70 to 120
26 region_2 varchar2(120), -- UTF8: Increased from 70 to 120
27 region_3 varchar2(120), -- UTF8: Increased from 70 to 120
28 telephone_number_1 varchar2(60),
29 telephone_number_2 varchar2(60),
30 telephone_number_3 varchar2(60),
31 town_or_city varchar2(30),
32 request_id number(15),
33 program_application_id number(15),
34 program_id number(15),
35 program_update_date date,
36 addr_attribute_category varchar2(30),
37 addr_attribute1 varchar2(150),
38 addr_attribute2 varchar2(150),
39 addr_attribute3 varchar2(150),
40 addr_attribute4 varchar2(150),
41 addr_attribute5 varchar2(150),
42 addr_attribute6 varchar2(150),
43 addr_attribute7 varchar2(150),
44 addr_attribute8 varchar2(150),
45 addr_attribute9 varchar2(150),
46 addr_attribute10 varchar2(150),
47 addr_attribute11 varchar2(150),
48 addr_attribute12 varchar2(150),
49 addr_attribute13 varchar2(150),
50 addr_attribute14 varchar2(150),
51 addr_attribute15 varchar2(150),
52 addr_attribute16 varchar2(150),
53 addr_attribute17 varchar2(150),
54 addr_attribute18 varchar2(150),
55 addr_attribute19 varchar2(150),
56 addr_attribute20 varchar2(150),
57 add_information13 varchar2(150),
58 add_information14 varchar2(150),
59 add_information15 varchar2(150),
60 add_information16 varchar2(150),
61 add_information17 varchar2(150),
62 add_information18 varchar2(150),
63 add_information19 varchar2(150),
64 add_information20 varchar2(150),
65 object_version_number number(9),
66 party_id per_addresses.party_id%TYPE,
67 geometry per_addresses.geometry%TYPE
68 );
69 --
70 -- ----------------------------------------------------------------------------
71 -- | Global Definitions - Internal Table Handler Use Only |
72 -- ----------------------------------------------------------------------------
73 --
74 g_old_rec g_rec_type; -- Global record definition
75 g_api_dml boolean; -- Global api dml status
76 g_tab_nam constant varchar2(30) := 'PER_ADDRESSES';
77 --
78 -- ----------------------------------------------------------------------------
79 -- |------------------------< return_api_dml_status >-------------------------|
80 -- ----------------------------------------------------------------------------
81 -- {Start Of Comments}
82 --
83 -- Description:
84 -- This function will return the current g_api_dml private global
85 -- boolean status.
86 -- The g_api_dml status determines if at the time of the function
87 -- being executed if a dml statement (i.e. INSERT, UPDATE or DELETE)
88 -- is being issued from within an api.
89 -- If the status is TRUE then a dml statement is being issued from
90 -- within this entity api.
91 -- This function is primarily to support database triggers which
92 -- need to maintain the object_version_number for non-supported
93 -- dml statements (i.e. dml statement issued outside of the api layer).
94 --
95 -- Pre Conditions:
96 -- None.
97 --
98 -- In Arguments:
99 -- None.
100 --
101 -- Post Success:
102 -- Processing continues.
103 -- If the function returns a TRUE value then, dml is being executed from
104 -- within this api.
105 --
106 -- Post Failure:
107 -- None.
108 --
109 -- Access Status:
110 -- Internal Table Handler Use Only.
111 --
112 -- {End Of Comments}
113 -- ----------------------------------------------------------------------------
114 Function return_api_dml_status Return Boolean;
115 --
116 -- ----------------------------------------------------------------------------
117 -- |---------------------------< constraint_error >---------------------------|
118 -- ----------------------------------------------------------------------------
119 -- {Start Of Comments}
120 --
121 -- Description:
122 -- This procedure is called when a constraint has been violated (i.e.
123 -- The exception hr_api.check_integrity_violated,
124 -- hr_api.parent_integrity_violated, hr_api.child_integrity_violated or
125 -- hr_api.unique_integrity_violated has been raised).
126 -- The exceptions can only be raised as follows:
127 -- 1) A check constraint can only be violated during an INSERT or UPDATE
128 -- dml operation.
129 -- 2) A parent integrity constraint can only be violated during an
130 -- INSERT or UPDATE dml operation.
131 -- 3) A child integrity constraint can only be violated during an
132 -- DELETE dml operation.
133 -- 4) A unique integrity constraint can only be violated during INSERT or
134 -- UPDATE dml operation.
135 --
136 -- Pre Conditions:
137 -- 1) Either hr_api.check_integrity_violated,
138 -- hr_api.parent_integrity_violated, hr_api.child_integrity_violated or
139 -- hr_api.unique_integrity_violated has been raised with the subsequent
140 -- stripping of the constraint name from the generated error message
141 -- text.
142 -- 2) Standalone validation test which correspond with a constraint error.
143 --
144 -- In Arguments:
145 -- p_constraint_name is in upper format and is just the constraint name
146 -- (e.g. not prefixed by brackets, schema owner etc).
147 --
148 -- Post Success:
149 -- Development dependant.
150 --
151 -- Post Failure:
152 -- Developement dependant.
153 --
154 -- Developer Implementation Notes:
155 -- For each constraint being checked the hr system package failure message
156 -- has been generated as a template only. These system error messages should
157 -- be modified as required (i.e. change the system failure message to a user
158 -- friendly defined error message).
159 --
160 -- Access Status:
161 -- Internal Development Use Only.
162 --
163 -- {End Of Comments}
164 -- ----------------------------------------------------------------------------
165 Procedure constraint_error
166 (p_constraint_name in all_constraints.constraint_name%TYPE);
167 --
168 -- ----------------------------------------------------------------------------
169 -- |-----------------------------< api_updating >-----------------------------|
170 -- ----------------------------------------------------------------------------
171 -- {Start Of Comments}
172 --
173 -- Description:
174 -- This function is used to populate the g_old_rec record with the
175 -- current row from the database for the specified primary key
176 -- provided that the primary key exists and is valid and does not
177 -- already match the current g_old_rec. The function will always return
178 -- a TRUE value if the g_old_rec is populated with the current row.
179 -- A FALSE value will be returned if all of the primary key arguments
180 -- are null.
181 --
182 -- Pre Conditions:
183 -- None.
184 --
185 -- In Arguments:
186 --
187 -- Post Success:
188 -- A value of TRUE will be returned indiciating that the g_old_rec
189 -- is current.
190 -- A value of FALSE will be returned if all of the primary key arguments
191 -- have a null value (this indicates that the row has not be inserted into
192 -- the Schema), and therefore could never have a corresponding row.
193 --
194 -- Post Failure:
195 -- A failure can only occur under two circumstances:
196 -- 1) The primary key is invalid (i.e. a row does not exist for the
197 -- specified primary key values).
198 -- 2) If an object_version_number exists but is NOT the same as the current
199 -- g_old_rec value.
200 --
201 -- Developer Implementation Notes:
202 -- None.
203 --
204 -- Access Status:
205 -- Internal Table Handler Use Only.
206 --
207 -- {End Of Comments}
208 -- ----------------------------------------------------------------------------
209 Function api_updating
210 (
211 p_address_id in number,
212 p_object_version_number in number
213 ) Return Boolean;
214 --
215 -- ----------------------------------------------------------------------------
216 -- |---------------------------------< lck >----------------------------------|
217 -- ----------------------------------------------------------------------------
218 -- {Start Of Comments}
219 --
220 -- Description:
221 -- The Lck process has two main functions to perform. Firstly, the row to be
222 -- updated or deleted must be locked. The locking of the row will only be
223 -- successful if the row is not currently locked by another user.
224 -- Secondly, during the locking of the row, the row is selected into
225 -- the g_old_rec data structure which enables the current row values from the
226 -- server to be available to the api.
227 --
228 -- Pre Conditions:
229 -- When attempting to call the lock the object version number (if defined)
230 -- is mandatory.
231 --
232 -- In Arguments:
233 -- The arguments to the Lck process are the primary key(s) which uniquely
234 -- identify the row and the object version number of row.
235 --
236 -- Post Success:
237 -- On successful completion of the Lck process the row to be updated or
238 -- deleted will be locked and selected into the global data structure
239 -- g_old_rec.
240 --
241 -- Post Failure:
242 -- The Lck process can fail for three reasons:
243 -- 1) When attempting to lock the row the row could already be locked by
244 -- another user. This will raise the HR_Api.Object_Locked exception.
245 -- 2) The row which is required to be locked doesn't exist in the HR Schema.
246 -- This error is trapped and reported using the message name
247 -- 'HR_7220_INVALID_PRIMARY_KEY'.
248 -- 3) The row although existing in the HR Schema has a different object
249 -- version number than the object version number specified.
250 -- This error is trapped and reported using the message name
251 -- 'HR_7155_OBJECT_INVALID'.
252 --
253 -- Developer Implementation Notes:
254 -- For each primary key and the object version number arguments add a
255 -- call to hr_api.mandatory_arg_error procedure to ensure that these
256 -- argument values are not null.
257 --
258 -- Access Status:
259 -- Internal Development Use Only.
260 --
261 -- {End Of Comments}
262 -- ----------------------------------------------------------------------------
263 Procedure lck
264 (
265 p_address_id in number,
266 p_object_version_number in number
267 );
268 --
269 -- ----------------------------------------------------------------------------
270 -- |-----------------------------< convert_args >-----------------------------|
271 -- ----------------------------------------------------------------------------
272 -- {Start Of Comments}
273 --
274 -- Description:
275 -- This function is used to turn attribute arguments into the record
276 -- structure g_rec_type.
277 --
278 -- Pre Conditions:
279 -- This is a private function and can only be called from the ins or upd
280 -- attribute processes.
281 --
282 -- In Arguments:
283 --
284 -- Post Success:
285 -- A returning record structure will be returned.
286 --
287 -- Post Failure:
288 -- No direct error handling is required within this function. Any possible
289 -- errors within this function will be a PL/SQL value error due to conversion
290 -- of datatypes or data lengths.
291 --
292 -- Developer Implementation Notes:
293 -- None.
294 --
295 -- Access Status:
296 -- Internal Table Handler Use Only.
297 --
298 -- {End Of Comments}
299 -- ----------------------------------------------------------------------------
300 Function convert_args
301 (
302 p_address_id in number,
303 p_business_group_id in number,
304 p_person_id in number,
305 p_date_from in date,
306 p_primary_flag in varchar2,
307 p_style in varchar2,
308 p_address_line1 in varchar2,
309 p_address_line2 in varchar2,
310 p_address_line3 in varchar2,
311 p_address_type in varchar2,
312 p_comments in long,
313 p_country in varchar2,
314 p_date_to in date,
315 p_postal_code in varchar2,
316 p_region_1 in varchar2,
317 p_region_2 in varchar2,
318 p_region_3 in varchar2,
319 p_telephone_number_1 in varchar2,
320 p_telephone_number_2 in varchar2,
321 p_telephone_number_3 in varchar2,
322 p_town_or_city in varchar2,
323 p_request_id in number,
324 p_program_application_id in number,
325 p_program_id in number,
326 p_program_update_date in date,
327 p_addr_attribute_category in varchar2,
328 p_addr_attribute1 in varchar2,
329 p_addr_attribute2 in varchar2,
330 p_addr_attribute3 in varchar2,
331 p_addr_attribute4 in varchar2,
332 p_addr_attribute5 in varchar2,
333 p_addr_attribute6 in varchar2,
334 p_addr_attribute7 in varchar2,
335 p_addr_attribute8 in varchar2,
336 p_addr_attribute9 in varchar2,
337 p_addr_attribute10 in varchar2,
338 p_addr_attribute11 in varchar2,
339 p_addr_attribute12 in varchar2,
340 p_addr_attribute13 in varchar2,
341 p_addr_attribute14 in varchar2,
342 p_addr_attribute15 in varchar2,
343 p_addr_attribute16 in varchar2,
344 p_addr_attribute17 in varchar2,
345 p_addr_attribute18 in varchar2,
346 p_addr_attribute19 in varchar2,
347 p_addr_attribute20 in varchar2,
348 p_add_information13 in varchar2,
349 p_add_information14 in varchar2,
350 p_add_information15 in varchar2,
351 p_add_information16 in varchar2,
352 p_add_information17 in varchar2,
353 p_add_information18 in varchar2,
354 p_add_information19 in varchar2,
355 p_add_information20 in varchar2,
356 p_object_version_number in number,
357 p_party_id in number default null
358 )
359 Return g_rec_type;
360 --
361 --
362 -- ---------------------------------------------------------------------------
363 -- |--------------------------< derive_locale >------------------------------|
364 -- ---------------------------------------------------------------------------
365 --
366 -- Description:
367 -- Populated the 'derived_locale' element of p_rec record structure. This
368 -- is acheived the use of legislative specific functions contained within
369 -- localization utility packages. If the localization package doesn't
370 -- exist, or does not contain the required function, a default value is
371 -- entered into the structure.
372 --
373 -- In Arguments:
374 -- p_rec
375 --
376 -- Access Status:
377 -- Internal Development Use Only.
378 --
379 procedure derive_locale(p_rec in out nocopy per_add_shd.g_rec_type);
380
381 end per_add_shd;
[Home] [Help]