[Home] [Help]
PACKAGE: APPS.HR_AE_PERSON_ADDRESS_API
Source
1 Package hr_ae_person_address_api AUTHID CURRENT_USER as
2 /* $Header: peaddaei.pkh 120.5 2012/01/19 08:46:28 rpahune ship $ */
3 /*#
4 * This package contains Address APIs.
5 * @rep:scope public
6 * @rep:product PER
7 * @rep:displayname Address for UAE
8 */
9 --
10 --
11 -- ----------------------------------------------------------------------------
12 -- |-------------------------< create_ae_person_address >---------------------|
13 -- ----------------------------------------------------------------------------
14 --
15 -- {Start Of Comments}
16 /*#
17 * This API creates UAE Address for a particular person.
18 * As this API is effectively an alternative to the API see that API for
19 * further explanation.
20 *
21 * <p><b>Licensing</b><br>
22 * This API is licensed for use with Human Resources.
23 *
24 * <p><b>Prerequisites</b><br>
25 * See API create_person_address.
26 *
27 * <p><b>Post Success</b><br>
28 * The API creates a valid person address.
29 *
30 * <p><b>Post Failure</b><br>
31 * The API does not create the address and raises an error.
32 *
33 * @param p_validate If true, the database remains unchanged. If false,
34 * the address is created.
35 * @param p_effective_date Effective date.
36 * @param p_person_id Person for whom the address applies.
37 * @param p_primary_flag Identifies the primary address.
38 * @param p_date_from The date from which the address applies.
39 * @param p_date_to The date on which the address no longer applies.
40 * @param p_address_type Type of address.
41 * @param p_comments Comments.
42 * @param p_address_line1 Address Line1.
43 * @param p_address_line2 Address Line2.
44 * @param p_emirate Emirate.
45 * @param p_city_village City or Village.
46 * @param p_region_area Region or Area.
47 * @param p_street Street.
48 * @param p_building Building.
49 * @param p_flat_number Flat Number.
50 * @param p_po_box PO Box.
51 * @param p_country Country.
52 * @param p_addr_attribute_category Determines context of the
53 * addr_attribute Descriptive flexfield in parameters.
54 * @param p_addr_attribute1 Descriptive flexfield segment.
55 * @param p_addr_attribute2 Descriptive flexfield segment.
56 * @param p_addr_attribute3 Descriptive flexfield segment.
57 * @param p_addr_attribute4 Descriptive flexfield segment.
58 * @param p_addr_attribute5 Descriptive flexfield segment.
59 * @param p_addr_attribute6 Descriptive flexfield segment.
60 * @param p_addr_attribute7 Descriptive flexfield segment.
61 * @param p_addr_attribute8 Descriptive flexfield segment.
62 * @param p_addr_attribute9 Descriptive flexfield segment.
63 * @param p_addr_attribute10 Descriptive flexfield segment.
64 * @param p_addr_attribute11 Descriptive flexfield segment.
65 * @param p_addr_attribute12 Descriptive flexfield segment.
66 * @param p_addr_attribute13 Descriptive flexfield segment.
67 * @param p_addr_attribute14 Descriptive flexfield segment.
68 * @param p_addr_attribute15 Descriptive flexfield segment.
69 * @param p_addr_attribute16 Descriptive flexfield segment.
70 * @param p_addr_attribute17 Descriptive flexfield segment.
71 * @param p_addr_attribute18 Descriptive flexfield segment.
72 * @param p_addr_attribute19 Descriptive flexfield segment.
73 * @param p_addr_attribute20 Descriptive flexfield segment.
74 * @param p_party_id Party for whom the address applies.
75 * @param p_address_id If p_validate is false, uniquely identifies the address
76 * created.If p_validate is true, set to null.
77 * @param p_object_version_number If p_validate is false, set to
78 * the version number of this address. If p_validate is true, set to null.
79 * @rep:displayname Create Person Address for UAE
80 * @rep:category BUSINESS_ENTITY PER_PERSON_ADDRESS
81 * @rep:lifecycle active
82 * @rep:scope public
83 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
84 */
85 --
86 -- {End Of Comments}
87 --
88
89
90 PROCEDURE create_ae_person_address
91 (
92 p_validate in boolean default false
93 ,p_effective_date in date
94 ,p_person_id in number
95 ,p_primary_flag in varchar2
96 ,p_date_from in date
97 ,p_date_to in date default null
98 ,p_address_type in varchar2 default null
99 ,p_comments in PER_ADDRESSES.COMMENTS%TYPE default null
100 ,p_address_line1 in varchar2
101 ,p_address_line2 in varchar2 default null
102 ,p_emirate in varchar2
103 ,p_city_village in varchar2 default null
104 ,p_region_area in varchar2 default null
105 ,p_street in varchar2 default null
106 ,p_building in varchar2 default null
107 ,p_flat_number in varchar2 default null
108 ,p_po_box in varchar2 default null
109 ,p_country in varchar2 default null
110 ,p_addr_attribute_category in varchar2 default null
111 ,p_addr_attribute1 in varchar2 default null
112 ,p_addr_attribute2 in varchar2 default null
113 ,p_addr_attribute3 in varchar2 default null
114 ,p_addr_attribute4 in varchar2 default null
115 ,p_addr_attribute5 in varchar2 default null
116 ,p_addr_attribute6 in varchar2 default null
117 ,p_addr_attribute7 in varchar2 default null
118 ,p_addr_attribute8 in varchar2 default null
119 ,p_addr_attribute9 in varchar2 default null
120 ,p_addr_attribute10 in varchar2 default null
121 ,p_addr_attribute11 in varchar2 default null
122 ,p_addr_attribute12 in varchar2 default null
123 ,p_addr_attribute13 in varchar2 default null
124 ,p_addr_attribute14 in varchar2 default null
125 ,p_addr_attribute15 in varchar2 default null
126 ,p_addr_attribute16 in varchar2 default null
127 ,p_addr_attribute17 in varchar2 default null
128 ,p_addr_attribute18 in varchar2 default null
129 ,p_addr_attribute19 in varchar2 default null
130 ,p_addr_attribute20 in varchar2 default null
131 ,p_party_id in number default null
132 ,p_address_id out nocopy number
133 ,p_object_version_number out nocopy number
134 );
135
136
137
138 --
139 -- ----------------------------------------------------------------------------
140 -- |-----------------------< update_ae_person_address >-----------------------|
141 -- ----------------------------------------------------------------------------
142 -- {Start Of Comments}
143 --
144 /*#
145 * This API updates the addresses of people as identified by the in
146 * parameter p_address_id and the in out parameter p_object_version_number,
147 * using the UAE style.
148 * This API calls the generic API update_person_address with the
149 * applicable parameters for a particular address style.
150 *
151 * <p><b>Licensing</b><br>
152 * This API is licensed for use with Human Resources.
153 *
154 * <p><b>Prerequisites</b><br>
155 * The address to be updated must exist and is in the correct style.
156 *
157 * The address_type attribute can only be used after QuickCodes have been
158 * defined for the 'ADDRESS_TYPE' lookup type.
159 *
160 * <p><b>Post Success</b><br>
161 * The Address will be updated.
162 *
163 * <p><b>Post Failure</b><br>
164 * The API does not update the address and raises an error.
165 *
166 * @param p_validate If true, the database remains unchanged. If false,
167 * the address is created.
168 * @param p_effective_date The effective date.
169 * @param p_address_id The primary key of the Address.
170 * @param p_object_version_number The current version of the address to be updated.
171 * @param p_primary_flag Identifies the primary address.
172 * @param p_date_from The date from which the address applies.
173 * @param p_date_to The date on which the address no longer applies.
174 * @param p_address_type Type of address.
175 * @param p_comments Comments
176 * @param p_address_line1 Address Line1.
177 * @param p_address_line2 Address Line2.
178 * @param p_emirate Emirate.
179 * @param p_city_village City or Village.
180 * @param p_region_area Region or Area.
181 * @param p_street Street.
182 * @param p_building Building.
183 * @param p_flat_number Flat Number.
184 * @param p_po_box PO Box.
185 * @param p_country Country.
186 * @param p_addr_attribute_category Determines context of the
187 * addr_attribute Descriptive flexfield in parameters.
188 * @param p_addr_attribute1 Descriptive flexfield segment.
189 * @param p_addr_attribute2 Descriptive flexfield segment.
190 * @param p_addr_attribute3 Descriptive flexfield segment.
191 * @param p_addr_attribute4 Descriptive flexfield segment.
192 * @param p_addr_attribute5 Descriptive flexfield segment.
193 * @param p_addr_attribute6 Descriptive flexfield segment.
194 * @param p_addr_attribute7 Descriptive flexfield segment.
195 * @param p_addr_attribute8 Descriptive flexfield segment.
196 * @param p_addr_attribute9 Descriptive flexfield segment.
197 * @param p_addr_attribute10 Descriptive flexfield segment.
198 * @param p_addr_attribute11 Descriptive flexfield segment.
199 * @param p_addr_attribute12 Descriptive flexfield segment.
200 * @param p_addr_attribute13 Descriptive flexfield segment.
201 * @param p_addr_attribute14 Descriptive flexfield segment.
202 * @param p_addr_attribute15 Descriptive flexfield segment.
203 * @param p_addr_attribute16 Descriptive flexfield segment.
204 * @param p_addr_attribute17 Descriptive flexfield segment.
205 * @param p_addr_attribute18 Descriptive flexfield segment.
206 * @param p_addr_attribute19 Descriptive flexfield segment.
207 * @param p_addr_attribute20 Descriptive flexfield segment.
208 * @param p_party_id Party for whom the address applies.
209 * @rep:displayname Update Address for UAE person.
210 * @rep:category BUSINESS_ENTITY PER_PERSON_ADDRESS
211 * @rep:lifecycle deprecated
212 * @rep:scope public
213 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
214 */
215 --
216 -- {End Of Comments}
217 --
218
219
220
221 PROCEDURE update_ae_person_address
222 (
223 p_validate in boolean default false
224 ,p_effective_date in date
225 ,p_address_id in number
226 ,p_object_version_number in out nocopy number
227 ,p_primary_flag in varchar2
228 ,p_date_from in date
229 ,p_date_to in date default null
230 ,p_address_type in varchar2 default null
231 ,p_comments in PER_ADDRESSES.COMMENTS%TYPE default null
232 ,p_address_line1 in varchar2
233 ,p_address_line2 in varchar2 default null
234 ,p_emirate in varchar2
235 ,p_city_village in varchar2 default null
236 ,p_region_area in varchar2 default null
237 ,p_street in varchar2 default null
238 ,p_building in varchar2 default null
239 ,p_flat_number in varchar2 default null
240 ,p_po_box in varchar2 default null
241 ,p_country in varchar2 default null
242 ,p_addr_attribute_category in varchar2 default null
243 ,p_addr_attribute1 in varchar2 default null
244 ,p_addr_attribute2 in varchar2 default null
245 ,p_addr_attribute3 in varchar2 default null
246 ,p_addr_attribute4 in varchar2 default null
247 ,p_addr_attribute5 in varchar2 default null
248 ,p_addr_attribute6 in varchar2 default null
249 ,p_addr_attribute7 in varchar2 default null
250 ,p_addr_attribute8 in varchar2 default null
251 ,p_addr_attribute9 in varchar2 default null
252 ,p_addr_attribute10 in varchar2 default null
253 ,p_addr_attribute11 in varchar2 default null
254 ,p_addr_attribute12 in varchar2 default null
255 ,p_addr_attribute13 in varchar2 default null
256 ,p_addr_attribute14 in varchar2 default null
257 ,p_addr_attribute15 in varchar2 default null
258 ,p_addr_attribute16 in varchar2 default null
259 ,p_addr_attribute17 in varchar2 default null
260 ,p_addr_attribute18 in varchar2 default null
261 ,p_addr_attribute19 in varchar2 default null
262 ,p_addr_attribute20 in varchar2 default null
263 ,p_party_id in number default null
264 );
265
266
267 END hr_ae_person_address_api;