1 Package hr_pl_person_address_api AUTHID CURRENT_USER as
2 /* $Header: peaddpli.pkh 120.6 2012/01/19 08:51:38 rpahune ship $ */
3 /*#
4 * This package contains person address APIs.
5 * @rep:scope public
6 * @rep:product PER
7 * @rep:displayname Personal Address for Poland
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-------------------------< create_pl_person_address >---------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * The following procedure creates a Polish Address for current and
17 * ex-employees,current and ex-applicants and employee contacts.
18 *
19 * This API is effectively an alternative to the API create_person_address. If
20 * p_validate is set to false, an address is created.
21 *
22 * <p><b>Licensing</b><br>
23 * This API is licensed for use with Human Resources.
24 *
25 * <p><b>Prerequisites</b><br>
26 * A valid person (p_person_id) must exist on the start date (p_date_from) of
27 * the address.
28 *
29 * <p><b>Post Success</b><br>
30 * The person address will be successfully inserted into the database.
31 *
32 * <p><b>Post Failure</b><br>
33 * The address will not be created and an error will be raised.
34 *
35 * @param p_validate If true, then validation alone will be performed and the
36 * database will remain unchanged. If false and all validation checks pass,
37 * then the database will be modified.
38 * @param p_effective_date Determines when the DateTrack operation comes into
39 * force.
40 * @param p_person_id Identifies the person for whom you create the address
41 * record.
42 * @param p_primary_flag Identifies the primary address.
43 * @param p_date_from The date from which the address applies.
44 * @param p_date_to The date on which the address no longer applies.
45 * @param p_address_type Type of address. Valid values are defined by
46 * 'ADDRESS_TYPE' lookup type.
47 * @param p_comments Person address comment text.
48 * @param p_street_type Street type of the address. Valid values are defined by
49 * 'PL_STREET_TYPE' lookup.
50 * @param p_street_name Street name of the address. If a Street Type is
51 * entered, then a value must be entered for the Street Name
52 * @param p_house_number House number of the address.
53 * @param p_flat_number Flat number of the address.
54 * @param p_post_code Postal code of the address.
55 * @param p_town Town of the address.
56 * @param p_province Province of the address. Valid values are defined by
57 * 'PL_PROVINCE' lookup type.
58 * @param p_district District of the address. Valid values are defined by
59 * 'PL_DISTRICT' lookup type.
60 * @param p_community Community of the address. Valid values are defined by
61 * 'PL_COMMUNITY' lookup type.
62 * @param p_post Post of the address.
63 * @param p_country Country of the address.
64 * @param p_post_box Post Box.
65 * @param p_addr_attribute_category This context value determines which
66 * flexfield structure to use with the Person Address descriptive flexfield
67 * segments.
68 * @param p_addr_attribute1 Descriptive flexfield segment.
69 * @param p_addr_attribute2 Descriptive flexfield segment.
70 * @param p_addr_attribute3 Descriptive flexfield segment.
71 * @param p_addr_attribute4 Descriptive flexfield segment.
72 * @param p_addr_attribute5 Descriptive flexfield segment.
73 * @param p_addr_attribute6 Descriptive flexfield segment.
74 * @param p_addr_attribute7 Descriptive flexfield segment.
75 * @param p_addr_attribute8 Descriptive flexfield segment.
76 * @param p_addr_attribute9 Descriptive flexfield segment.
77 * @param p_addr_attribute10 Descriptive flexfield segment.
78 * @param p_addr_attribute11 Descriptive flexfield segment.
79 * @param p_addr_attribute12 Descriptive flexfield segment.
80 * @param p_addr_attribute13 Descriptive flexfield segment.
81 * @param p_addr_attribute14 Descriptive flexfield segment.
82 * @param p_addr_attribute15 Descriptive flexfield segment.
83 * @param p_addr_attribute16 Descriptive flexfield segment.
84 * @param p_addr_attribute17 Descriptive flexfield segment.
85 * @param p_addr_attribute18 Descriptive flexfield segment.
86 * @param p_addr_attribute19 Descriptive flexfield segment.
87 * @param p_addr_attribute20 Descriptive flexfield segment.
88 * @param p_party_id Party for whom the address. HR/TCA merge applies.
89 * @param p_address_id If p_validate is false, then this uniquely identifies
90 * the address created. If p_validate is true, then set to null.
91 * @param p_object_version_number If p_validate is false, then set to the
92 * version number of the created Person Address. If p_validate is true, then
93 * the value will be null.
94 * @rep:displayname Create Person Address for Poland
95 * @rep:category BUSINESS_ENTITY PER_PERSON_ADDRESS
96 * @rep:lifecycle active
97 * @rep:scope public
98 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
99 */
100 --
101 -- {End Of Comments}
102 --
103 PROCEDURE create_pl_person_address
104 (
105 p_validate in boolean default false
106 ,p_effective_date in date
107 ,p_person_id in number
108 ,p_primary_flag in varchar2
109 ,p_date_from in date
110 ,p_date_to in date default null
111 ,p_address_type in varchar2 default null
112 -- ,p_comments in long default null
113 ,p_comments in PER_ADDRESSES.COMMENTS%TYPE default null -- bug 13375568
114 ,p_street_type in varchar2 default null
115 ,p_street_name in varchar2 default null
116 ,p_house_number in varchar2
117 ,p_flat_number in varchar2 default null
118 ,p_post_code in varchar2
119 ,p_town in varchar2
120 ,p_province in varchar2
121 ,p_district in varchar2 default null
122 ,p_community in varchar2
123 ,p_post in varchar2 default null
124 ,p_country in varchar2
125 ,p_post_box in varchar2 default null
126 ,p_addr_attribute_category in varchar2 default null
127 ,p_addr_attribute1 in varchar2 default null
128 ,p_addr_attribute2 in varchar2 default null
129 ,p_addr_attribute3 in varchar2 default null
130 ,p_addr_attribute4 in varchar2 default null
131 ,p_addr_attribute5 in varchar2 default null
132 ,p_addr_attribute6 in varchar2 default null
133 ,p_addr_attribute7 in varchar2 default null
134 ,p_addr_attribute8 in varchar2 default null
135 ,p_addr_attribute9 in varchar2 default null
136 ,p_addr_attribute10 in varchar2 default null
137 ,p_addr_attribute11 in varchar2 default null
138 ,p_addr_attribute12 in varchar2 default null
139 ,p_addr_attribute13 in varchar2 default null
140 ,p_addr_attribute14 in varchar2 default null
141 ,p_addr_attribute15 in varchar2 default null
142 ,p_addr_attribute16 in varchar2 default null
143 ,p_addr_attribute17 in varchar2 default null
144 ,p_addr_attribute18 in varchar2 default null
145 ,p_addr_attribute19 in varchar2 default null
146 ,p_addr_attribute20 in varchar2 default null
147 ,p_party_id in number default null
148 ,p_address_id out nocopy number
149 ,p_object_version_number out nocopy number
150 );
151 --
152 -- ----------------------------------------------------------------------------
153 -- |-------------------------< update_pl_person_address >---------------------|
154 -- ----------------------------------------------------------------------------
155 --
156 -- {Start Of Comments}
157 /*#
158 * The following procedure updates a Polish Address for current and
159 * ex-employees,current and ex-applicants and employee contacts.
160 *
161 * This API is effectively an alternative to the API update_person_address. If
162 * p_validate is set to false, the address is updated.
163 *
164 * <p><b>Licensing</b><br>
165 * This API is licensed for use with Human Resources.
166 *
167 * <p><b>Prerequisites</b><br>
168 * The address to be updated must exist on the effective date and should be in
169 * the correct style. Valid values are defined by 'ADDRESS_TYPE' lookup type.
170 *
171 * <p><b>Post Success</b><br>
172 * The address will have been updated.
173 *
174 * <p><b>Post Failure</b><br>
175 * The address will not be updated and an error will be raised.
176 *
177 * @param p_validate If true, then validation alone will be performed and the
178 * database will remain unchanged. If false and all validation checks pass,
179 * then the database will be modified.
180 * @param p_effective_date Determines when the DateTrack operation comes into
181 * force.
182 * @param p_address_id The primary key of the address.
183 * @param p_object_version_number Pass in the current version number of the
184 * person address to be updated. When the API completes if p_validate is false,
185 * will be set to the new version number of the updated person address. If
186 * p_validate is true will be set to the same value which was passed in.
187 * @param p_primary_flag Identifies the primary address.
188 * @param p_date_from The date from which the address applies.
189 * @param p_date_to The date from which the address no longer applies.
190 * @param p_address_type Type of address. Valid values are defined by
191 * 'ADDRESS_TYPE' lookup type.
192 * @param p_comments Person address comment text.
193 * @param p_street_type Street type of the address. Valid values are defined by
194 * 'PL_STREET_TYPE' lookup.
195 * @param p_street_name Street name of the address. If a Street Type is
196 * entered, then a value must be entered for the Street Name.
197 * @param p_house_number House number of the address.
198 * @param p_flat_number Flat number of the address.
199 * @param p_post_code Postal code of the address.
200 * @param p_town Town of the address.
201 * @param p_province Province of the address. Valid values are defined by
202 * 'PL_PROVINCE' lookup type.
203 * @param p_district District of the address. Valid values are defined by
204 * 'PL_DISTRICT' lookup type.
205 * @param p_community Community of the address. Valid values are defined by
206 * 'PL_COMMUNITY' lookup type.
207 * @param p_post Post of the address.
208 * @param p_country Country of the address.
209 * @param p_post_box Post Box.
210 * @param p_addr_attribute_category This context value determines which
211 * flexfield structure to use with the Person Address descriptive flexfield
212 * segments.
213 * @param p_addr_attribute1 Descriptive flexfield segment.
214 * @param p_addr_attribute2 Descriptive flexfield segment.
215 * @param p_addr_attribute3 Descriptive flexfield segment.
216 * @param p_addr_attribute4 Descriptive flexfield segment.
217 * @param p_addr_attribute5 Descriptive flexfield segment.
218 * @param p_addr_attribute6 Descriptive flexfield segment.
219 * @param p_addr_attribute7 Descriptive flexfield segment.
220 * @param p_addr_attribute8 Descriptive flexfield segment.
221 * @param p_addr_attribute9 Descriptive flexfield segment.
222 * @param p_addr_attribute10 Descriptive flexfield segment.
223 * @param p_addr_attribute11 Descriptive flexfield segment.
224 * @param p_addr_attribute12 Descriptive flexfield segment.
225 * @param p_addr_attribute13 Descriptive flexfield segment.
226 * @param p_addr_attribute14 Descriptive flexfield segment.
227 * @param p_addr_attribute15 Descriptive flexfield segment.
228 * @param p_addr_attribute16 Descriptive flexfield segment.
229 * @param p_addr_attribute17 Descriptive flexfield segment.
230 * @param p_addr_attribute18 Descriptive flexfield segment.
231 * @param p_addr_attribute19 Descriptive flexfield segment.
232 * @param p_addr_attribute20 Descriptive flexfield segment.
233 * @param p_party_id Party for whom the address. HR/TCA merge applies.
234 * @rep:displayname Update Person Address for Poland
235 * @rep:category BUSINESS_ENTITY PER_PERSON_ADDRESS
236 * @rep:lifecycle active
237 * @rep:scope public
238 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
239 */
240 --
241 -- {End Of Comments}
242 --
243 PROCEDURE update_pl_person_address
244 (
245 p_validate in boolean default false
246 ,p_effective_date in date
247 ,p_address_id in number
248 ,p_object_version_number in out nocopy number
249 ,p_primary_flag in varchar2
250 ,p_date_from in date
251 ,p_date_to in date default null
252 ,p_address_type in varchar2 default null
253 -- ,p_comments in long default null
254 ,p_comments in PER_ADDRESSES.COMMENTS%TYPE default null -- bug 13375568
255 ,p_street_type in varchar2 default null
256 ,p_street_name in varchar2 default null
257 ,p_house_number in varchar2
258 ,p_flat_number in varchar2 default null
259 ,p_post_code in varchar2
260 ,p_town in varchar2
261 ,p_province in varchar2
262 ,p_district in varchar2 default null
263 ,p_community in varchar2
264 ,p_post in varchar2 default null
265 ,p_country in varchar2
266 ,p_post_box in varchar2 default null
267 ,p_addr_attribute_category in varchar2 default null
268 ,p_addr_attribute1 in varchar2 default null
269 ,p_addr_attribute2 in varchar2 default null
270 ,p_addr_attribute3 in varchar2 default null
271 ,p_addr_attribute4 in varchar2 default null
272 ,p_addr_attribute5 in varchar2 default null
273 ,p_addr_attribute6 in varchar2 default null
274 ,p_addr_attribute7 in varchar2 default null
275 ,p_addr_attribute8 in varchar2 default null
276 ,p_addr_attribute9 in varchar2 default null
277 ,p_addr_attribute10 in varchar2 default null
278 ,p_addr_attribute11 in varchar2 default null
279 ,p_addr_attribute12 in varchar2 default null
280 ,p_addr_attribute13 in varchar2 default null
281 ,p_addr_attribute14 in varchar2 default null
282 ,p_addr_attribute15 in varchar2 default null
283 ,p_addr_attribute16 in varchar2 default null
284 ,p_addr_attribute17 in varchar2 default null
285 ,p_addr_attribute18 in varchar2 default null
286 ,p_addr_attribute19 in varchar2 default null
287 ,p_addr_attribute20 in varchar2 default null
288 ,p_party_id in number default null
289 );
290
291
292 END hr_pl_person_address_api;
[Home] [Help]