1 PACKAGE hr_hk_person_address_api AS
2 /* $Header: hrhkwrpa.pkh 120.1 2005/10/02 02:02:31 aroussel $ */
3 /*#
4 * This package contains person address related APIs.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Person Address for Hong Kong
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-------------------------< create_hk_person_address >---------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a new address, for a particular person.
17 *
18 * This API calls the generic API create_person_address with the Hong Kong
19 * specific value for address style.
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 * A valid person must exist on the start date of the address. The address_type
26 * attribute can only be used after QuickCodes have been defined for the
27 * 'ADDRESS_TYPE' lookup type.
28 *
29 * <p><b>Post Success</b><br>
30 * Inserts a new address for the employee in the Hong Kong Address style.
31 *
32 * <p><b>Post Failure</b><br>
33 * The API does not create the address and raises an error.
34 * @param p_validate If true, then validation alone will be performed and the
35 * database will remain unchanged. If false and all validation checks pass,
36 * then the database will be modified.
37 * @param p_effective_date Determines when the DateTrack operation takes
38 * effect.
39 * @param p_pradd_ovlapval_override Indicates and validates if there is a
40 * primary address overlap.
41 * @param p_validate_county Validate county details in the address. Set to true
42 * by default.
43 * @param p_person_id Identifies the person for whom you create the Address
44 * record.
45 * @param p_primary_flag {@rep:casecolumn PER_ADDRESSES.PRIMARY_FLAG}
46 * @param p_date_from {@rep:casecolumn PER_ADDRESSES.DATE_FROM}
47 * @param p_date_to {@rep:casecolumn PER_ADDRESSES.DATE_TO}
48 * @param p_address_type Indicates the Type of Address. Valid values are
49 * defined by 'ADDRESS_TYPE' lookup type.
50 * @param p_comments Comment text.
51 * @param p_address_line1 {@rep:casecolumn PER_ADDRESSES.ADDRESS_LINE1}
52 * @param p_address_line2 {@rep:casecolumn PER_ADDRESSES.ADDRESS_LINE2}
53 * @param p_address_line3 {@rep:casecolumn PER_ADDRESSES.ADDRESS_LINE3}
54 * @param p_district {@rep:casecolumn PER_ADDRESSES.TOWN_OR_CITY}
55 * @param p_area Indicates the Area of the person. Valid Values are defined by
56 * 'HK_AREA_CODES' lookup type.
57 * @param p_country {@rep:casecolumn PER_ADDRESSES.COUNTRY}
58 * @param p_telephone_number_1 {@rep:casecolumn
59 * PER_ADDRESSES.TELEPHONE_NUMBER_1}
60 * @param p_telephone_number_2 {@rep:casecolumn
61 * PER_ADDRESSES.TELEPHONE_NUMBER_2}
62 * @param p_telephone_number_3 {@rep:casecolumn
63 * PER_ADDRESSES.TELEPHONE_NUMBER_3}
64 * @param p_addr_attribute_category This context value determines which
65 * flexfield structure to use with the Person Address descriptive flexfield
66 * segments.
67 * @param p_addr_attribute1 Descriptive flexfield segment.
68 * @param p_addr_attribute2 Descriptive flexfield segment.
69 * @param p_addr_attribute3 Descriptive flexfield segment.
70 * @param p_addr_attribute4 Descriptive flexfield segment.
71 * @param p_addr_attribute5 Descriptive flexfield segment.
72 * @param p_addr_attribute6 Descriptive flexfield segment.
73 * @param p_addr_attribute7 Descriptive flexfield segment.
74 * @param p_addr_attribute8 Descriptive flexfield segment.
75 * @param p_addr_attribute9 Descriptive flexfield segment.
76 * @param p_addr_attribute10 Descriptive flexfield segment.
77 * @param p_addr_attribute11 Descriptive flexfield segment.
78 * @param p_addr_attribute12 Descriptive flexfield segment.
79 * @param p_addr_attribute13 Descriptive flexfield segment.
80 * @param p_addr_attribute14 Descriptive flexfield segment.
81 * @param p_addr_attribute15 Descriptive flexfield segment.
82 * @param p_addr_attribute16 Descriptive flexfield segment.
83 * @param p_addr_attribute17 Descriptive flexfield segment.
84 * @param p_addr_attribute18 Descriptive flexfield segment.
85 * @param p_addr_attribute19 Descriptive flexfield segment.
86 * @param p_addr_attribute20 Descriptive flexfield segment.
87 * @param p_address_id If p_validate is false, uniquely identifies the address
88 * created. If p_validate is true, set to null.
89 * @param p_object_version_number If p_validate is false, then set to the
90 * version number of the created Person. If p_validate is true, then the value
91 * will be null.
92 * @rep:displayname Create Person Address for Hong Kong
93 * @rep:category BUSINESS_ENTITY PER_PERSON_ADDRESS
94 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
95 * @rep:scope public
96 * @rep:lifecycle active
97 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
98 */
99 --
100 -- {End Of Comments}
101 --
102 procedure create_hk_person_address
103 (p_validate IN BOOLEAN DEFAULT FALSE
104 ,p_effective_date IN DATE
105 ,p_pradd_ovlapval_override IN BOOLEAN DEFAULT FALSE
106 ,p_validate_county IN BOOLEAN DEFAULT TRUE
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_address_line1 IN VARCHAR2
114 ,p_address_line2 IN VARCHAR2 DEFAULT NULL
115 ,p_address_line3 IN VARCHAR2 DEFAULT NULL
116 ,p_district IN VARCHAR2 DEFAULT NULL
117 ,p_area IN VARCHAR2 DEFAULT NULL
118 ,p_country IN VARCHAR2
119 ,p_telephone_number_1 IN VARCHAR2 DEFAULT NULL
120 ,p_telephone_number_2 IN VARCHAR2 DEFAULT NULL
121 ,p_telephone_number_3 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_hk_person_address >---------------------|
149 -- ----------------------------------------------------------------------------
150 --
151 -- {Start Of Comments}
152 /*#
153 * This API updates the details of a persons address for Hong Kong.
154 *
155 * This API calls the generic API update_person_address with the Hong Kong
156 * specific value for address style.
157 *
158 * <p><b>Licensing</b><br>
159 * This API is licensed for use with Human Resources.
160 *
161 * <p><b>Prerequisites</b><br>
162 * The address to be updated must exist and must be in the correct style.The
163 * address_type attribute can only be used after QuickCodes have been defined
164 * for the 'ADDRESS_TYPE' lookup type.
165 *
166 * <p><b>Post Success</b><br>
167 * Updates the details if the address is valid.
168 *
169 * <p><b>Post Failure</b><br>
170 * The API does not update the address and raises an error.
171 * @param p_validate If true, then validation alone will be performed and the
172 * database will remain unchanged. If false and all validation checks pass,
173 * then the database will be modified.
174 * @param p_effective_date Determines when the DateTrack operation takes
175 * effect.
176 * @param p_validate_county Validate county details in the address. Set to true
177 * by default.
178 * @param p_address_id {@rep:casecolumn PER_ADDRESSES.ADDRESS_ID}
179 * @param p_object_version_number Pass in the current version number of the
180 * Person Address to be updated. When the API completes if p_validate is false,
181 * will be set to the new version number of the updated Person Address. If
182 * p_validate is true will be set to the same value which was passed in.
183 * @param p_date_from {@rep:casecolumn PER_ADDRESSES.DATE_FROM}
184 * @param p_date_to {@rep:casecolumn PER_ADDRESSES.DATE_TO}
185 * @param p_address_type Indicates the Type of Address. Valid values are
186 * defined by 'ADDRESS_TYPE' lookup type.
187 * @param p_comments Comment text.
188 * @param p_address_line1 {@rep:casecolumn PER_ADDRESSES.ADDRESS_LINE1}
189 * @param p_address_line2 {@rep:casecolumn PER_ADDRESSES.ADDRESS_LINE2}
190 * @param p_address_line3 {@rep:casecolumn PER_ADDRESSES.ADDRESS_LINE3}
191 * @param p_district {@rep:casecolumn PER_ADDRESSES.TOWN_OR_CITY}
192 * @param p_area Indicates the Area of the person. Valid Values are defined by
193 * 'HK_AREA_CODES' lookup type.
194 * @param p_country {@rep:casecolumn PER_ADDRESSES.COUNTRY}
195 * @param p_telephone_number_1 {@rep:casecolumn
196 * PER_ADDRESSES.TELEPHONE_NUMBER_1}
197 * @param p_telephone_number_2 {@rep:casecolumn
198 * PER_ADDRESSES.TELEPHONE_NUMBER_2}
199 * @param p_telephone_number_3 {@rep:casecolumn
200 * PER_ADDRESSES.TELEPHONE_NUMBER_3}
201 * @param p_addr_attribute_category This context value determines which
202 * flexfield structure to use with the Person Address descriptive flexfield
203 * segments.
204 * @param p_addr_attribute1 Descriptive flexfield segment.
205 * @param p_addr_attribute2 Descriptive flexfield segment.
206 * @param p_addr_attribute3 Descriptive flexfield segment.
207 * @param p_addr_attribute4 Descriptive flexfield segment.
208 * @param p_addr_attribute5 Descriptive flexfield segment.
209 * @param p_addr_attribute6 Descriptive flexfield segment.
210 * @param p_addr_attribute7 Descriptive flexfield segment.
211 * @param p_addr_attribute8 Descriptive flexfield segment.
212 * @param p_addr_attribute9 Descriptive flexfield segment.
213 * @param p_addr_attribute10 Descriptive flexfield segment.
214 * @param p_addr_attribute11 Descriptive flexfield segment.
215 * @param p_addr_attribute12 Descriptive flexfield segment.
216 * @param p_addr_attribute13 Descriptive flexfield segment.
217 * @param p_addr_attribute14 Descriptive flexfield segment.
218 * @param p_addr_attribute15 Descriptive flexfield segment.
219 * @param p_addr_attribute16 Descriptive flexfield segment.
220 * @param p_addr_attribute17 Descriptive flexfield segment.
221 * @param p_addr_attribute18 Descriptive flexfield segment.
222 * @param p_addr_attribute19 Descriptive flexfield segment.
223 * @param p_addr_attribute20 Descriptive flexfield segment.
224 * @rep:displayname Update Person Address for Hong Kong
225 * @rep:category BUSINESS_ENTITY PER_PERSON_ADDRESS
226 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
227 * @rep:scope public
228 * @rep:lifecycle active
229 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
230 */
231 --
232 -- {End Of Comments}
233 --
234 procedure update_hk_person_address
235 (p_validate IN BOOLEAN DEFAULT FALSE
236 ,p_effective_date IN DATE
237 ,p_validate_county IN BOOLEAN DEFAULT TRUE
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_address_line1 IN VARCHAR2 DEFAULT hr_api.g_varchar2
245 ,p_address_line2 IN VARCHAR2 DEFAULT hr_api.g_varchar2
246 ,p_address_line3 IN VARCHAR2 DEFAULT hr_api.g_varchar2
247 ,p_district IN VARCHAR2 DEFAULT hr_api.g_varchar2
248 ,p_area IN VARCHAR2 DEFAULT hr_api.g_varchar2
249 ,p_country IN VARCHAR2 DEFAULT hr_api.g_varchar2
250 ,p_telephone_number_1 IN VARCHAR2 DEFAULT hr_api.g_varchar2
251 ,p_telephone_number_2 IN VARCHAR2 DEFAULT hr_api.g_varchar2
252 ,p_telephone_number_3 IN VARCHAR2 DEFAULT hr_api.g_varchar2
253 ,p_addr_attribute_category IN VARCHAR2 DEFAULT hr_api.g_varchar2
254 ,p_addr_attribute1 IN VARCHAR2 DEFAULT hr_api.g_varchar2
255 ,p_addr_attribute2 IN VARCHAR2 DEFAULT hr_api.g_varchar2
256 ,p_addr_attribute3 IN VARCHAR2 DEFAULT hr_api.g_varchar2
257 ,p_addr_attribute4 IN VARCHAR2 DEFAULT hr_api.g_varchar2
258 ,p_addr_attribute5 IN VARCHAR2 DEFAULT hr_api.g_varchar2
259 ,p_addr_attribute6 IN VARCHAR2 DEFAULT hr_api.g_varchar2
260 ,p_addr_attribute7 IN VARCHAR2 DEFAULT hr_api.g_varchar2
261 ,p_addr_attribute8 IN VARCHAR2 DEFAULT hr_api.g_varchar2
262 ,p_addr_attribute9 IN VARCHAR2 DEFAULT hr_api.g_varchar2
263 ,p_addr_attribute10 IN VARCHAR2 DEFAULT hr_api.g_varchar2
264 ,p_addr_attribute11 IN VARCHAR2 DEFAULT hr_api.g_varchar2
265 ,p_addr_attribute12 IN VARCHAR2 DEFAULT hr_api.g_varchar2
266 ,p_addr_attribute13 IN VARCHAR2 DEFAULT hr_api.g_varchar2
267 ,p_addr_attribute14 IN VARCHAR2 DEFAULT hr_api.g_varchar2
268 ,p_addr_attribute15 IN VARCHAR2 DEFAULT hr_api.g_varchar2
269 ,p_addr_attribute16 IN VARCHAR2 DEFAULT hr_api.g_varchar2
270 ,p_addr_attribute17 IN VARCHAR2 DEFAULT hr_api.g_varchar2
271 ,p_addr_attribute18 IN VARCHAR2 DEFAULT hr_api.g_varchar2
272 ,p_addr_attribute19 IN VARCHAR2 DEFAULT hr_api.g_varchar2
273 ,p_addr_attribute20 IN VARCHAR2 DEFAULT hr_api.g_varchar2
274 );
275
276
277 END hr_hk_person_address_api;
[Home] [Help]