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