1 PACKAGE hr_in_person_address_api AS
2 /* $Header: peaddini.pkh 120.1 2005/10/02 02:37 aroussel $ */
3 /*#
4 * This package contains person address APIs.
5 * @rep:scope public
6 * @rep:product PER
7 * @rep:displayname Person Address for India
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-------------------------< create_in_person_address >---------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a new address for a person.
17 *
18 * This API is effectively an alternative to the API create_person_address. If
19 * p_validate is set to false, an address is created. If creating the first
20 * address for the specified person, then it must be the primary address. As
21 * one and only one primary address can exist at any given time for a person,
22 * any subsequent addresses must not be primary.
23 *
24 * <p><b>Licensing</b><br>
25 * This API is licensed for use with Human Resources.
26 *
27 * <p><b>Prerequisites</b><br>
28 * A valid person (p_person_id) must exist on the start date (p_date_from) of
29 * the address. The address_type attribute can only be used after QuickCodes
30 * have been defined for the 'ADDRESS_TYPE' lookup type.
31 *
32 * <p><b>Post Success</b><br>
33 * The person address will be successfully inserted into the database.
34 *
35 * <p><b>Post Failure</b><br>
36 * The API does not create the address and raises an error.
37 *
38 * @param p_validate If true, then validation alone will be performed and the
39 * database will remain unchanged. If false and all validation checks pass,
40 * then the database will be modified.
41 * @param p_effective_date Determines when the DateTrack operation comes into
42 * force.
43 * @param p_pradd_ovlapval_override Primary address override flag. If
44 * p_pradd_ovlapval_override is set to true and p_primary_flag is 'Y' then the
45 * address being created overrides the already existing primary address.
46 * @param p_person_id Identifies the person for whom you create the address
47 * record.
48 * @param p_primary_flag Identifies the primary address.
49 * @param p_date_from The date from which the address applies.
50 * @param p_date_to The date on which the address no longer applies.
51 * @param p_address_type Type of address. Valid values are defined by
52 * 'ADDRESS_TYPE' lookup type.
53 * @param p_country Country of the address. If Address stye is India then the
54 * value will be India else wil get the valid values from FND_TERRITORIES
55 * @param p_comments Person address comment text.
56 * @param p_flat_door_block Flat/Door/Block of the address.
57 * @param p_building_village Building/Village of the address.
58 * @param p_road_street Road/Street of the address.
59 * @param p_area_locality Area/Locality of the address.
60 * @param p_town_or_city Town/City of the address.
61 * @param p_state_ut State/UT of the address. If Address stye is India then the
62 * valid values are defined by 'IN_STATES' lookup type.
63 * @param p_pin_code Postal code of the address. If Address stye is India then
64 * the first two digits must be valid for a state. Valid values are defined by
65 * 'IN_PIN_CODES' lookup type.
66 * @param p_addr_attribute_category This context value determines which
67 * flexfield structure to use with the Person Address descriptive flexfield
68 * segments.
69 * @param p_addr_attribute1 Descriptive flexfield segment.
70 * @param p_addr_attribute2 Descriptive flexfield segment.
71 * @param p_addr_attribute3 Descriptive flexfield segment.
72 * @param p_addr_attribute4 Descriptive flexfield segment.
73 * @param p_addr_attribute5 Descriptive flexfield segment.
74 * @param p_addr_attribute6 Descriptive flexfield segment.
75 * @param p_addr_attribute7 Descriptive flexfield segment.
76 * @param p_addr_attribute8 Descriptive flexfield segment.
77 * @param p_addr_attribute9 Descriptive flexfield segment.
78 * @param p_addr_attribute10 Descriptive flexfield segment.
79 * @param p_addr_attribute11 Descriptive flexfield segment.
80 * @param p_addr_attribute12 Descriptive flexfield segment.
81 * @param p_addr_attribute13 Descriptive flexfield segment.
82 * @param p_addr_attribute14 Descriptive flexfield segment.
83 * @param p_addr_attribute15 Descriptive flexfield segment.
84 * @param p_addr_attribute16 Descriptive flexfield segment.
85 * @param p_addr_attribute17 Descriptive flexfield segment.
86 * @param p_addr_attribute18 Descriptive flexfield segment.
87 * @param p_addr_attribute19 Descriptive flexfield segment.
88 * @param p_addr_attribute20 Descriptive flexfield segment.
89 * @param p_address_id If p_validate is false, uniquely identifies the address
90 * created. If p_validate is true, 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 India
95 * @rep:category BUSINESS_ENTITY PER_PERSON_ADDRESS
96 * @rep:lifecycle active
97 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
98 * @rep:scope public
99 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
100 */
101 --
102 -- {End Of Comments}
103 --
104 PROCEDURE create_in_person_address
105 (p_validate IN BOOLEAN default false
106 ,p_effective_date IN DATE
107 ,p_pradd_ovlapval_override IN BOOLEAN default FALSE
108 ,p_person_id IN NUMBER default null
109 ,p_primary_flag IN VARCHAR2
110 ,p_date_from IN DATE
111 ,p_date_to IN DATE default null
112 ,p_address_type IN VARCHAR2 default null
113 ,p_country IN VARCHAR2 default null
114 ,p_comments IN LONG default null
115 ,p_flat_door_block IN VARCHAR2
116 ,p_building_village IN VARCHAR2 default null
117 ,p_road_street IN VARCHAR2 default null
118 ,p_area_locality IN VARCHAR2 default null
119 ,p_town_or_city IN VARCHAR2
120 ,p_state_ut IN VARCHAR2 default null
121 ,p_pin_code IN VARCHAR2 default null
122 ,p_addr_attribute_category IN VARCHAR2 default null
123 ,p_addr_attribute1 IN VARCHAR2 default null
124 ,p_addr_attribute2 IN VARCHAR2 default null
125 ,p_addr_attribute3 IN VARCHAR2 default null
126 ,p_addr_attribute4 IN VARCHAR2 default null
127 ,p_addr_attribute5 IN VARCHAR2 default null
128 ,p_addr_attribute6 IN VARCHAR2 default null
129 ,p_addr_attribute7 IN VARCHAR2 default null
130 ,p_addr_attribute8 IN VARCHAR2 default null
131 ,p_addr_attribute9 IN VARCHAR2 default null
132 ,p_addr_attribute10 IN VARCHAR2 default null
133 ,p_addr_attribute11 IN VARCHAR2 default null
134 ,p_addr_attribute12 IN VARCHAR2 default null
135 ,p_addr_attribute13 IN VARCHAR2 default null
136 ,p_addr_attribute14 IN VARCHAR2 default null
137 ,p_addr_attribute15 IN VARCHAR2 default null
138 ,p_addr_attribute16 IN VARCHAR2 default null
139 ,p_addr_attribute17 IN VARCHAR2 default null
140 ,p_addr_attribute18 IN VARCHAR2 default null
141 ,p_addr_attribute19 IN VARCHAR2 default null
142 ,p_addr_attribute20 IN VARCHAR2 default null
143 ,p_address_id OUT NOCOPY NUMBER
144 ,p_object_version_number OUT NOCOPY NUMBER
145 );
146 --
147 -- ----------------------------------------------------------------------------
148 -- |-------------------------< update_in_person_address >---------------------|
149 -- ----------------------------------------------------------------------------
150 --
151 -- {Start Of Comments}
152 /*#
153 * This API updates the address of a person.
154 *
155 * This API is effectively an alternative to the API update_person_address. If
156 * p_validate is set to false, the address is updated. Address is updated as
157 * identified by the in parameter p_address_id and the in out parameter
158 * p_object_version_number.
159 *
160 * <p><b>Licensing</b><br>
161 * This API is licensed for use with Human Resources.
162 *
163 * <p><b>Prerequisites</b><br>
164 * The address as identified by the in parameter p_address_id and the in out
165 * parameter p_object_version_number must already exist. The address_type
166 * attribute can only be used after QuickCodes have been defined for the
167 * 'ADDRESS_TYPE' lookup type.
168 *
169 * <p><b>Post Success</b><br>
170 * Updates the address for the person.
171 *
172 * <p><b>Post Failure</b><br>
173 * The API does not update the address and raises an error.
174 *
175 * @param p_validate If true, then validation alone will be performed and the
176 * database will remain unchanged. If false and all validation checks pass,
177 * then the database will be modified.
178 * @param p_effective_date Determines when the DateTrack operation comes into
179 * force.
180 * @param p_address_id The primary key of the address.
181 * @param p_object_version_number Pass in the current version number of the
182 * person address to be updated. When the API completes if p_validate is false,
183 * will be set to the new version number of the updated person address. If
184 * p_validate is true will be set to the same value which was passed in.
185 * @param p_date_from The date from which the address applies.
186 * @param p_date_to The date on which the address no longer applies.
187 * @param p_address_type Type of address. Valid values are defined by
188 * 'ADDRESS_TYPE' lookup type.
189 * @param p_comments Person address comment text.
190 * @param p_flat_door_block Flat/Door/Block of the address.
191 * @param p_building_village Building/Village of the address.
192 * @param p_road_street Road/Street of the address.
193 * @param p_area_locality Area/Locality of the address.
194 * @param p_town_or_city Town/City of the address.
195 * @param p_state_ut State/UT of the address. If Address stye is India then the
196 * valid values are defined by 'IN_STATES' lookup type.
197 * @param p_pin_code Postal code of the address. If Address stye is India then
198 * the first two digits must be valid for a state. Valid values are defined by
199 * 'IN_PIN_CODES' lookup type.
200 * @param p_country Country of the address. If Address stye is India then the
201 * value will be India else wil get the valid values from FND_TERRITORIES
202 * @param p_addr_attribute_category This context value determines which
203 * flexfield structure to use with the Person Address descriptive flexfield
204 * segments.
205 * @param p_addr_attribute1 Descriptive flexfield segment.
206 * @param p_addr_attribute2 Descriptive flexfield segment.
207 * @param p_addr_attribute3 Descriptive flexfield segment.
208 * @param p_addr_attribute4 Descriptive flexfield segment.
209 * @param p_addr_attribute5 Descriptive flexfield segment.
210 * @param p_addr_attribute6 Descriptive flexfield segment.
211 * @param p_addr_attribute7 Descriptive flexfield segment.
212 * @param p_addr_attribute8 Descriptive flexfield segment.
213 * @param p_addr_attribute9 Descriptive flexfield segment.
214 * @param p_addr_attribute10 Descriptive flexfield segment.
215 * @param p_addr_attribute11 Descriptive flexfield segment.
216 * @param p_addr_attribute12 Descriptive flexfield segment.
217 * @param p_addr_attribute13 Descriptive flexfield segment.
218 * @param p_addr_attribute14 Descriptive flexfield segment.
219 * @param p_addr_attribute15 Descriptive flexfield segment.
220 * @param p_addr_attribute16 Descriptive flexfield segment.
221 * @param p_addr_attribute17 Descriptive flexfield segment.
222 * @param p_addr_attribute18 Descriptive flexfield segment.
223 * @param p_addr_attribute19 Descriptive flexfield segment.
224 * @param p_addr_attribute20 Descriptive flexfield segment.
225 * @rep:displayname Update Person Address for India
226 * @rep:category BUSINESS_ENTITY PER_PERSON_ADDRESS
227 * @rep:lifecycle active
228 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
229 * @rep:scope public
230 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
231 */
232 --
233 -- {End Of Comments}
234 --
235 PROCEDURE update_in_person_address
236 (p_validate IN BOOLEAN DEFAULT FALSE
237 ,p_effective_date IN DATE
238 ,p_address_id IN NUMBER
239 ,p_object_version_number IN OUT NOCOPY NUMBER
240 ,p_date_from IN DATE DEFAULT hr_api.g_date
241 ,p_date_to IN DATE DEFAULT hr_api.g_date
242 ,p_address_type IN VARCHAR2 DEFAULT hr_api.g_varchar2
243 ,p_comments IN LONG DEFAULT hr_api.g_varchar2
244 ,p_flat_door_block IN VARCHAR2 DEFAULT hr_api.g_varchar2
245 ,p_building_village IN VARCHAR2 DEFAULT hr_api.g_varchar2
246 ,p_road_street IN VARCHAR2 DEFAULT hr_api.g_varchar2
247 ,p_area_locality IN VARCHAR2 DEFAULT hr_api.g_varchar2
248 ,p_town_or_city IN VARCHAR2 DEFAULT hr_api.g_varchar2
249 ,p_state_ut IN VARCHAR2 DEFAULT hr_api.g_varchar2
250 ,p_pin_code IN VARCHAR2 DEFAULT hr_api.g_varchar2
251 ,p_country IN VARCHAR2 DEFAULT hr_api.g_varchar2
252 ,p_addr_attribute_category IN VARCHAR2 DEFAULT hr_api.g_varchar2
253 ,p_addr_attribute1 IN VARCHAR2 DEFAULT hr_api.g_varchar2
254 ,p_addr_attribute2 IN VARCHAR2 DEFAULT hr_api.g_varchar2
255 ,p_addr_attribute3 IN VARCHAR2 DEFAULT hr_api.g_varchar2
256 ,p_addr_attribute4 IN VARCHAR2 DEFAULT hr_api.g_varchar2
257 ,p_addr_attribute5 IN VARCHAR2 DEFAULT hr_api.g_varchar2
258 ,p_addr_attribute6 IN VARCHAR2 DEFAULT hr_api.g_varchar2
259 ,p_addr_attribute7 IN VARCHAR2 DEFAULT hr_api.g_varchar2
260 ,p_addr_attribute8 IN VARCHAR2 DEFAULT hr_api.g_varchar2
261 ,p_addr_attribute9 IN VARCHAR2 DEFAULT hr_api.g_varchar2
262 ,p_addr_attribute10 IN VARCHAR2 DEFAULT hr_api.g_varchar2
263 ,p_addr_attribute11 IN VARCHAR2 DEFAULT hr_api.g_varchar2
264 ,p_addr_attribute12 IN VARCHAR2 DEFAULT hr_api.g_varchar2
265 ,p_addr_attribute13 IN VARCHAR2 DEFAULT hr_api.g_varchar2
266 ,p_addr_attribute14 IN VARCHAR2 DEFAULT hr_api.g_varchar2
267 ,p_addr_attribute15 IN VARCHAR2 DEFAULT hr_api.g_varchar2
268 ,p_addr_attribute16 IN VARCHAR2 DEFAULT hr_api.g_varchar2
269 ,p_addr_attribute17 IN VARCHAR2 DEFAULT hr_api.g_varchar2
270 ,p_addr_attribute18 IN VARCHAR2 DEFAULT hr_api.g_varchar2
271 ,p_addr_attribute19 IN VARCHAR2 DEFAULT hr_api.g_varchar2
272 ,p_addr_attribute20 IN VARCHAR2 DEFAULT hr_api.g_varchar2
273 );
274
275 END hr_in_person_address_api ;
276
[Home] [Help]