1 PACKAGE hr_hk_personal_pay_method_api AS
2 /* $Header: hrhkwrpm.pkh 120.1 2005/10/02 02:02:50 aroussel $ */
3 /*#
4 * This package contains APIs for creation of personal payment methods for Hong
5 * Kong.
6 * @rep:scope public
7 * @rep:product per
8 * @rep:displayname Personal Payment Method for Hong Kong
9 */
10 --
11 -- ----------------------------------------------------------------------------
12 -- |----------------------< create_hk_personal_pay_method >-------------------|
13 -- ----------------------------------------------------------------------------
14 --
15 -- {Start Of Comments}
16 /*#
17 * This API creates the personal payment method of an employee for Hong Kong.
18 *
19 * The API calls the generic API create_personal_pay_method, with the
20 * parameters set as appropriate for a Hong Kong employee assignment.
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 * See the generic API create_personal_pay_method
27 *
28 * <p><b>Post Success</b><br>
29 * Successfully creates the personal payment method for the employee.
30 *
31 * <p><b>Post Failure</b><br>
32 * The API does not create the personal payment method and raises an error.
33 * @param p_validate If true, then validation alone will be performed and the
34 * database will remain unchanged. If false and all validation checks pass,
35 * then the database will be modified.
36 * @param p_effective_date Determines when the DateTrack operation takes
37 * effect.
38 * @param p_assignment_id Identifies the assignment for which you create the
39 * Personal Payment Method record.
40 * @param p_org_payment_method_id {@rep:casecolumn
41 * PAY_PERSONAL_PAYMENT_METHODS_F.ORG_PAYMENT_METHOD_ID}
42 * @param p_bank_code Bank Code - 3 Characters.
43 * @param p_branch_code Branch Code - 3 Characters..
44 * @param p_account_number Bank Account Number
45 * @param p_bank_account_name Bank Account Name
46 * @param p_amount {@rep:casecolumn PAY_PERSONAL_PAYMENT_METHODS_F.AMOUNT}
47 * @param p_percentage {@rep:casecolumn
48 * PAY_PERSONAL_PAYMENT_METHODS_F.PERCENTAGE}
49 * @param p_priority {@rep:casecolumn PAY_PERSONAL_PAYMENT_METHODS_F.PRIORITY}
50 * @param p_comments Comment text.
51 * @param p_attribute_category This context value determines which flexfield
52 * structure to use with the descriptive flexfield segments.
53 * @param p_attribute1 Descriptive flexfield segment.
54 * @param p_attribute2 Descriptive flexfield segment.
55 * @param p_attribute3 Descriptive flexfield segment.
56 * @param p_attribute4 Descriptive flexfield segment.
57 * @param p_attribute5 Descriptive flexfield segment.
58 * @param p_attribute6 Descriptive flexfield segment.
59 * @param p_attribute7 Descriptive flexfield segment.
60 * @param p_attribute8 Descriptive flexfield segment.
61 * @param p_attribute9 Descriptive flexfield segment.
62 * @param p_attribute10 Descriptive flexfield segment.
63 * @param p_attribute11 Descriptive flexfield segment.
64 * @param p_attribute12 Descriptive flexfield segment.
65 * @param p_attribute13 Descriptive flexfield segment.
66 * @param p_attribute14 Descriptive flexfield segment.
67 * @param p_attribute15 Descriptive flexfield segment.
68 * @param p_attribute16 Descriptive flexfield segment.
69 * @param p_attribute17 Descriptive flexfield segment.
70 * @param p_attribute18 Descriptive flexfield segment.
71 * @param p_attribute19 Descriptive flexfield segment.
72 * @param p_attribute20 Descriptive flexfield segment.
73 * @param p_payee_type Payee Type. Valid values are defined by the 'PAYEE_TYPE'
74 * lookup type.
75 * @param p_payee_id {@rep:casecolumn PAY_PERSONAL_PAYMENT_METHODS_F.PAYEE_ID}
76 * @param p_personal_payment_method_id If p_validate is false, this uniquely
77 * identifies the personal payment method created. If p_validate is set to
78 * true, this parameter will be null.
79 * @param p_external_account_id If p_validate is false,identifies the external
80 * account combination, if a combination exists . If p_validate is set to true,
81 * this parameter will be null.
82 * @param p_object_version_number If p_validate is false, then set to the
83 * version number of the created Personal Payment Method. If p_validate is
84 * true, then the value will be null.
85 * @param p_effective_start_date If p_validate is false, then set to the
86 * earliest effective start date for the created Personal Payment Method. If
87 * p_validate is true, then set to null.
88 * @param p_effective_end_date If p_validate is false, then set to the
89 * effective end date for the created Personal Payment Method. If p_validate is
90 * true, then set to null.
91 * @param p_comment_id If p_validate is false and comment text was provided,
92 * then will be set to the identifier of the created Personal Payment Method
93 * comment record. If p_validate is true or no comment text was provided, then
94 * will be null.
95 * @rep:displayname Create Personal Payment Method for Hong Kong
96 * @rep:category BUSINESS_ENTITY PAY_PERSONAL_PAY_METHOD
97 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
98 * @rep:scope public
99 * @rep:lifecycle active
100 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
101 */
102 --
103 -- {End Of Comments}
104 --
105 PROCEDURE create_hk_personal_pay_method
106 (p_validate IN BOOLEAN DEFAULT FALSE
107 ,p_effective_date IN DATE
108 ,p_assignment_id IN NUMBER
109 ,p_org_payment_method_id IN NUMBER
110 ,p_bank_code IN VARCHAR2
111 ,p_branch_code IN VARCHAR2
112 ,p_account_number IN VARCHAR2
113 ,p_bank_account_name IN VARCHAR2
114 ,p_amount IN NUMBER DEFAULT NULL
115 ,p_percentage IN NUMBER DEFAULT NULL
116 ,p_priority IN NUMBER
117 ,p_comments IN VARCHAR2 DEFAULT NULL
118 ,p_attribute_category IN VARCHAR2 DEFAULT NULL
119 ,p_attribute1 IN VARCHAR2 DEFAULT NULL
120 ,p_attribute2 IN VARCHAR2 DEFAULT NULL
121 ,p_attribute3 IN VARCHAR2 DEFAULT NULL
122 ,p_attribute4 IN VARCHAR2 DEFAULT NULL
123 ,p_attribute5 IN VARCHAR2 DEFAULT NULL
124 ,p_attribute6 IN VARCHAR2 DEFAULT NULL
125 ,p_attribute7 IN VARCHAR2 DEFAULT NULL
126 ,p_attribute8 IN VARCHAR2 DEFAULT NULL
127 ,p_attribute9 IN VARCHAR2 DEFAULT NULL
128 ,p_attribute10 IN VARCHAR2 DEFAULT NULL
129 ,p_attribute11 IN VARCHAR2 DEFAULT NULL
130 ,p_attribute12 IN VARCHAR2 DEFAULT NULL
131 ,p_attribute13 IN VARCHAR2 DEFAULT NULL
132 ,p_attribute14 IN VARCHAR2 DEFAULT NULL
133 ,p_attribute15 IN VARCHAR2 DEFAULT NULL
134 ,p_attribute16 IN VARCHAR2 DEFAULT NULL
135 ,p_attribute17 IN VARCHAR2 DEFAULT NULL
136 ,p_attribute18 IN VARCHAR2 DEFAULT NULL
137 ,p_attribute19 IN VARCHAR2 DEFAULT NULL
138 ,p_attribute20 IN VARCHAR2 DEFAULT NULL
139 ,p_payee_type IN VARCHAR2 DEFAULT NULL
140 ,p_payee_id IN NUMBER DEFAULT NULL
141 ,p_personal_payment_method_id OUT NOCOPY NUMBER
142 ,p_external_account_id OUT NOCOPY NUMBER
143 ,p_object_version_number OUT NOCOPY NUMBER
144 ,p_effective_start_date OUT NOCOPY DATE
145 ,p_effective_end_date OUT NOCOPY DATE
146 ,p_comment_id OUT NOCOPY NUMBER
147 );
148 --
149 -- ----------------------------------------------------------------------------
150 -- |----------------------< update_hk_personal_pay_method >-------------------|
151 -- ----------------------------------------------------------------------------
152 --
153 -- {Start Of Comments}
154 /*#
155 * This API updates the personal payment method for Hong Kong.
156 *
157 * The API calls the generic API update_personal_pay_method, with the
158 * parameters set as appropriate for a Hong Kong employee assignment.
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 personal payment method should already exist.
165 *
166 * <p><b>Post Success</b><br>
167 * Successfully updates the personal payment method.
168 *
169 * <p><b>Post Failure</b><br>
170 * The API does not update the personal payment method 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_datetrack_update_mode Indicates which DateTrack mode to use when
177 * updating the record. You must set to either UPDATE, CORRECTION,
178 * UPDATE_OVERRIDE or UPDATE_CHANGE_INSERT. Modes available for use with a
179 * particular record depend on the dates of previous record changes and the
180 * effective date of this change.
181 * @param p_personal_payment_method_id {@rep:casecolumn
182 * PAY_PERSONAL_PAYMENT_METHODS_F.ORG_PAYMENT_METHOD_ID}
183 * @param p_object_version_number Pass in the current version number of the
184 * Personal Payment Method to be updated. When the API completes if p_validate
185 * is false, will be set to the new version number of the updated Personal
186 * Payment Method. If p_validate is true will be set to the same value which
187 * was passed in.
188 * @param p_bank_code Bank Code - 3 Characters.
189 * @param p_branch_code Branch Code - 3 Characters..
190 * @param p_account_number Bank Account Number
191 * @param p_bank_account_name Bank Account Name
192 * @param p_amount {@rep:casecolumn PAY_PERSONAL_PAYMENT_METHODS_F.AMOUNT}
193 * @param p_comments Comment text.
194 * @param p_percentage {@rep:casecolumn
195 * PAY_PERSONAL_PAYMENT_METHODS_F.PERCENTAGE}
196 * @param p_priority {@rep:casecolumn PAY_PERSONAL_PAYMENT_METHODS_F.PRIORITY}
197 * @param p_attribute_category This context value determines which flexfield
198 * structure to use with the descriptive flexfield segments.
199 * @param p_attribute1 Descriptive flexfield segment.
200 * @param p_attribute2 Descriptive flexfield segment.
201 * @param p_attribute3 Descriptive flexfield segment.
202 * @param p_attribute4 Descriptive flexfield segment.
203 * @param p_attribute5 Descriptive flexfield segment.
204 * @param p_attribute6 Descriptive flexfield segment.
205 * @param p_attribute7 Descriptive flexfield segment.
206 * @param p_attribute8 Descriptive flexfield segment.
207 * @param p_attribute9 Descriptive flexfield segment.
208 * @param p_attribute10 Descriptive flexfield segment.
209 * @param p_attribute11 Descriptive flexfield segment.
210 * @param p_attribute12 Descriptive flexfield segment.
211 * @param p_attribute13 Descriptive flexfield segment.
212 * @param p_attribute14 Descriptive flexfield segment.
213 * @param p_attribute15 Descriptive flexfield segment.
214 * @param p_attribute16 Descriptive flexfield segment.
215 * @param p_attribute17 Descriptive flexfield segment.
216 * @param p_attribute18 Descriptive flexfield segment.
217 * @param p_attribute19 Descriptive flexfield segment.
218 * @param p_attribute20 Descriptive flexfield segment.
219 * @param p_payee_type Payee Type. Valid values are defined by the 'PAYEE_TYPE'
220 * lookup type.
221 * @param p_payee_id {@rep:casecolumn PAY_PERSONAL_PAYMENT_METHODS_F.PAYEE_ID}
222 * @param p_comment_id If p_validate is false and new or existing comment text
223 * exists, then will be set to the identifier of the Personal Payment Method
224 * comment record. If p_validate is true or no comment text exists, then will
225 * be null.
226 * @param p_external_account_id If p_validate is false,identifies the external
227 * account combination, if a combination exists . If p_validate is set to true,
228 * this parameter will be null.
229 * @param p_effective_start_date If p_validate is false, then set to the
230 * effective start date on the updated Personal Payment Method row which now
231 * exists as of the effective date. If p_validate is true, then set to null.
232 * @param p_effective_end_date If p_validate is false, then set to the
233 * effective end date on the updated Personal Payment Method row which now
234 * exists as of the effective date. If p_validate is true, then set to null.
235 * @rep:displayname Update Personal Payment Method for Hong Kong
236 * @rep:category BUSINESS_ENTITY PAY_PERSONAL_PAY_METHOD
237 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
238 * @rep:scope public
239 * @rep:lifecycle active
240 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
241 */
242 --
243 -- {End Of Comments}
244 --
245 PROCEDURE update_hk_personal_pay_method
246 (p_validate IN BOOLEAN DEFAULT FALSE
247 ,p_effective_date IN DATE
248 ,p_datetrack_update_mode IN VARCHAR2
249 ,p_personal_payment_method_id IN NUMBER
250 ,p_object_version_number IN OUT NOCOPY NUMBER
251 ,p_bank_code IN VARCHAR2 DEFAULT hr_api.g_varchar2
252 ,p_branch_code IN VARCHAR2 DEFAULT hr_api.g_varchar2
253 ,p_account_number IN VARCHAR2 DEFAULT hr_api.g_varchar2
254 ,p_bank_account_name IN VARCHAR2 DEFAULT hr_api.g_varchar2
255 ,p_amount IN NUMBER DEFAULT hr_api.g_number
256 ,p_comments IN VARCHAR2 DEFAULT hr_api.g_varchar2
257 ,p_percentage IN NUMBER DEFAULT hr_api.g_number
258 ,p_priority IN NUMBER DEFAULT hr_api.g_number
259 ,p_attribute_category IN VARCHAR2 DEFAULT hr_api.g_varchar2
260 ,p_attribute1 IN VARCHAR2 DEFAULT hr_api.g_varchar2
261 ,p_attribute2 IN VARCHAR2 DEFAULT hr_api.g_varchar2
262 ,p_attribute3 IN VARCHAR2 DEFAULT hr_api.g_varchar2
263 ,p_attribute4 IN VARCHAR2 DEFAULT hr_api.g_varchar2
264 ,p_attribute5 IN VARCHAR2 DEFAULT hr_api.g_varchar2
265 ,p_attribute6 IN VARCHAR2 DEFAULT hr_api.g_varchar2
266 ,p_attribute7 IN VARCHAR2 DEFAULT hr_api.g_varchar2
267 ,p_attribute8 IN VARCHAR2 DEFAULT hr_api.g_varchar2
268 ,p_attribute9 IN VARCHAR2 DEFAULT hr_api.g_varchar2
269 ,p_attribute10 IN VARCHAR2 DEFAULT hr_api.g_varchar2
270 ,p_attribute11 IN VARCHAR2 DEFAULT hr_api.g_varchar2
271 ,p_attribute12 IN VARCHAR2 DEFAULT hr_api.g_varchar2
272 ,p_attribute13 IN VARCHAR2 DEFAULT hr_api.g_varchar2
273 ,p_attribute14 IN VARCHAR2 DEFAULT hr_api.g_varchar2
274 ,p_attribute15 IN VARCHAR2 DEFAULT hr_api.g_varchar2
275 ,p_attribute16 IN VARCHAR2 DEFAULT hr_api.g_varchar2
276 ,p_attribute17 IN VARCHAR2 DEFAULT hr_api.g_varchar2
277 ,p_attribute18 IN VARCHAR2 DEFAULT hr_api.g_varchar2
278 ,p_attribute19 IN VARCHAR2 DEFAULT hr_api.g_varchar2
279 ,p_attribute20 IN VARCHAR2 DEFAULT hr_api.g_varchar2
280 ,p_payee_type IN VARCHAR2 DEFAULT hr_api.g_varchar2
281 ,p_payee_id IN NUMBER DEFAULT hr_api.g_number
282 ,p_comment_id OUT NOCOPY NUMBER
283 ,p_external_account_id OUT NOCOPY NUMBER
284 ,p_effective_start_date OUT NOCOPY DATE
285 ,p_effective_end_date OUT NOCOPY DATE
286 );
287
288 END hr_hk_personal_pay_method_api;
[Home] [Help]