1 PACKAGE hr_sg_personal_pay_method_api AUTHID CURRENT_USER AS
2 /* $Header: hrsgwrpm.pkh 120.1 2005/10/02 02:06:28 aroussel $ */
3 /*#
4 * This Package contains APIs for creation of personal payment methods for
5 * Singapore.
6 * @rep:scope public
7 * @rep:product per
8 * @rep:displayname Personal Payment Method for Singapore
9 */
10 --
11 -- ----------------------------------------------------------------------------
12 -- |----------------------< create_sg_personal_pay_method >-------------------|
13 -- ----------------------------------------------------------------------------
14 --
15 -- {Start Of Comments}
16 /*#
17 * This API creates the personal payment method of an employee for Singapore.
18 *
19 * This API creates the sg personal payment method as specified, for the
20 * employee assignment identified by the parameter p_assignment_id. The API
21 * calls the generic API create_personal_pay_method, with the parameters set as
22 * appropriate for a sg employee assignment. As this API is effectively an
23 * alternative to the API create_personal_pay_method, see that API for further
24 * 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 * See the generic API create_personal_pay_method
31 *
32 * <p><b>Post Success</b><br>
33 * Successfully creates the person, personal payment method.
34 *
35 * <p><b>Post Failure</b><br>
36 * The API does not create the personal payment method and raises an error.
37 * @param p_validate If true, then validation alone will be performed and the
38 * database will remain unchanged. If false and all validation checks pass,
39 * then the database will be modified.
40 * @param p_effective_date Determines when the DateTrack operation takes
41 * effect.
42 * @param p_assignment_id Identifies the assignment for which you create the
43 * Personal Payment Method record.
44 * @param p_org_payment_method_id {@rep:casecolumn
45 * PAY_PERSONAL_PAYMENT_METHODS_F.ORG_PAYMENT_METHOD_ID}
46 * @param p_bank_account_number 12 digit bank account number for Singapore
47 * @param p_bank_account_name Bank acc name
48 * @param p_bank_account_type Bank acc type
49 * @param p_bank_code Bank code
50 * @param p_bank_name Bank name
54 * @param p_percentage {@rep:casecolumn
51 * @param p_branch_code Branch Code
52 * @param p_branch_name Branch Name - Default Null
53 * @param p_amount {@rep:casecolumn PAY_PERSONAL_PAYMENT_METHODS_F.AMOUNT}
55 * PAY_PERSONAL_PAYMENT_METHODS_F.PERCENTAGE}
56 * @param p_priority {@rep:casecolumn PAY_PERSONAL_PAYMENT_METHODS_F.PRIORITY}
57 * @param p_comments Comment text.
58 * @param p_attribute_category This context value determines which flexfield
59 * structure to use with the descriptive flexfield segments.
60 * @param p_attribute1 Descriptive flexfield segment.
61 * @param p_attribute2 Descriptive flexfield segment.
62 * @param p_attribute3 Descriptive flexfield segment.
63 * @param p_attribute4 Descriptive flexfield segment.
64 * @param p_attribute5 Descriptive flexfield segment.
65 * @param p_attribute6 Descriptive flexfield segment.
66 * @param p_attribute7 Descriptive flexfield segment.
67 * @param p_attribute8 Descriptive flexfield segment.
68 * @param p_attribute9 Descriptive flexfield segment.
69 * @param p_attribute10 Descriptive flexfield segment.
70 * @param p_attribute11 Descriptive flexfield segment.
71 * @param p_attribute12 Descriptive flexfield segment.
72 * @param p_attribute13 Descriptive flexfield segment.
73 * @param p_attribute14 Descriptive flexfield segment.
74 * @param p_attribute15 Descriptive flexfield segment.
75 * @param p_attribute16 Descriptive flexfield segment.
76 * @param p_attribute17 Descriptive flexfield segment.
77 * @param p_attribute18 Descriptive flexfield segment.
78 * @param p_attribute19 Descriptive flexfield segment.
79 * @param p_attribute20 Descriptive flexfield segment.
80 * @param p_payee_type Payee Type. Valid values are defined by the 'PAYEE_TYPE'
81 * 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 set to the
90 * 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 set to the
93 * earliest effective start date for the created personal payment method. If
94 * p_validate is true, then set to null.
95 * @param p_effective_end_date If p_validate is false, then 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 will be set to the identifier of the created personal payment method
100 * comment record. If p_validate is true or no comment text was provided, then
101 * will be null.
102 * @rep:displayname Create Personal Payment Method for Singapore
103 * @rep:category BUSINESS_ENTITY PAY_PERSONAL_PAY_METHOD
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_sg_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_bank_account_number IN VARCHAR2
118 ,p_bank_account_name IN VARCHAR2
119 ,p_bank_account_type IN VARCHAR2
120 ,p_bank_code IN VARCHAR2
121 ,p_bank_name IN VARCHAR2
122 ,p_branch_code IN VARCHAR2
123 ,p_branch_name IN VARCHAR2 DEFAULT NULL
124 ,p_amount IN NUMBER DEFAULT NULL
125 ,p_percentage IN NUMBER DEFAULT NULL
126 ,p_priority IN NUMBER
127 ,p_comments IN VARCHAR2 DEFAULT NULL
128 ,p_attribute_category IN VARCHAR2 DEFAULT NULL
129 ,p_attribute1 IN VARCHAR2 DEFAULT NULL
130 ,p_attribute2 IN VARCHAR2 DEFAULT NULL
131 ,p_attribute3 IN VARCHAR2 DEFAULT NULL
132 ,p_attribute4 IN VARCHAR2 DEFAULT NULL
133 ,p_attribute5 IN VARCHAR2 DEFAULT NULL
134 ,p_attribute6 IN VARCHAR2 DEFAULT NULL
135 ,p_attribute7 IN VARCHAR2 DEFAULT NULL
136 ,p_attribute8 IN VARCHAR2 DEFAULT NULL
137 ,p_attribute9 IN VARCHAR2 DEFAULT NULL
138 ,p_attribute10 IN VARCHAR2 DEFAULT NULL
139 ,p_attribute11 IN VARCHAR2 DEFAULT NULL
140 ,p_attribute12 IN VARCHAR2 DEFAULT NULL
141 ,p_attribute13 IN VARCHAR2 DEFAULT NULL
142 ,p_attribute14 IN VARCHAR2 DEFAULT NULL
143 ,p_attribute15 IN VARCHAR2 DEFAULT NULL
144 ,p_attribute16 IN VARCHAR2 DEFAULT NULL
145 ,p_attribute17 IN VARCHAR2 DEFAULT NULL
146 ,p_attribute18 IN VARCHAR2 DEFAULT NULL
147 ,p_attribute19 IN VARCHAR2 DEFAULT NULL
148 ,p_attribute20 IN VARCHAR2 DEFAULT NULL
149 ,p_payee_type IN VARCHAR2 DEFAULT NULL
150 ,p_payee_id IN NUMBER DEFAULT NULL
151 ,p_personal_payment_method_id OUT NOCOPY NUMBER
152 ,p_external_account_id OUT NOCOPY NUMBER
153 ,p_object_version_number OUT NOCOPY NUMBER
154 ,p_effective_start_date OUT NOCOPY DATE
155 ,p_effective_end_date OUT NOCOPY DATE
156 ,p_comment_id OUT NOCOPY NUMBER
157 );
158 --
159 -- ----------------------------------------------------------------------------
160 -- |----------------------< update_sg_personal_pay_method >-------------------|
161 -- ----------------------------------------------------------------------------
162 --
163 -- {Start Of Comments}
164 /*#
165 * This API updates the personal payment method for Singapore.
166 *
167 * The API calls the generic API update_personal_pay_method, with the
168 * parameters set as appropriate for a Singapore employee assignment.
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 to be updated must be for a sg assignment. See
175 * API update_personal_pay_method for further details.
176 *
177 * <p><b>Post Success</b><br>
178 * Successfully updates the person, personal payment method.
179 *
180 * <p><b>Post Failure</b><br>
181 * The API does not update the personal payment method and raises an error.
182 * @param p_validate If true, then validation alone will be performed and the
183 * database will remain unchanged. If false and all validation checks pass,
184 * then the database will be modified.
185 * @param p_effective_date Determines when the DateTrack operation takes
186 * effect.
187 * @param p_datetrack_update_mode Indicates which DateTrack mode to use when
188 * updating the record. You must set to either UPDATE, CORRECTION,
189 * UPDATE_OVERRIDE or UPDATE_CHANGE_INSERT. Modes available for use with a
190 * particular record depend on the dates of previous record changes and the
191 * effective date of this change.
192 * @param p_personal_payment_method_id {@rep:casecolumn
193 * PAY_PERSONAL_PAYMENT_METHODS_F.ORG_PAYMENT_METHOD_ID}
194 * @param p_object_version_number Pass in the current version number of the
195 * personal payment method to be updated. When the API completes if p_validate
196 * is false, will be set to the new version number of the updated personal
197 * payment method. If p_validate is true will be set to the same value which
198 * was passed in.
199 * @param p_bank_account_number 12 digit Bank acc no. for Singapore
200 * @param p_bank_account_name Bank account name
201 * @param p_bank_account_type Bank account type
202 * @param p_bank_code Bank code
203 * @param p_bank_name Bank name
204 * @param p_branch_code 3 digit Branch Code
205 * @param p_branch_name Branch Name - Default Null
206 * @param p_amount {@rep:casecolumn PAY_PERSONAL_PAYMENT_METHODS_F.AMOUNT}
207 * @param p_comments Comment text.
208 * @param p_percentage {@rep:casecolumn
209 * PAY_PERSONAL_PAYMENT_METHODS_F.PERCENTAGE}
210 * @param p_priority Indicates the priority of the personal payment method.
211 * @param p_attribute_category This context value determines which flexfield
212 * structure to use with the descriptive flexfield segments.
213 * @param p_attribute1 Descriptive flexfield segment.
214 * @param p_attribute2 Descriptive flexfield segment.
215 * @param p_attribute3 Descriptive flexfield segment.
216 * @param p_attribute4 Descriptive flexfield segment.
217 * @param p_attribute5 Descriptive flexfield segment.
218 * @param p_attribute6 Descriptive flexfield segment.
219 * @param p_attribute7 Descriptive flexfield segment.
220 * @param p_attribute8 Descriptive flexfield segment.
221 * @param p_attribute9 Descriptive flexfield segment.
222 * @param p_attribute10 Descriptive flexfield segment.
223 * @param p_attribute11 Descriptive flexfield segment.
224 * @param p_attribute12 Descriptive flexfield segment.
225 * @param p_attribute13 Descriptive flexfield segment.
226 * @param p_attribute14 Descriptive flexfield segment.
227 * @param p_attribute15 Descriptive flexfield segment.
228 * @param p_attribute16 Descriptive flexfield segment.
229 * @param p_attribute17 Descriptive flexfield segment.
230 * @param p_attribute18 Descriptive flexfield segment.
231 * @param p_attribute19 Descriptive flexfield segment.
232 * @param p_attribute20 Descriptive flexfield segment.
233 * @param p_payee_type Payee Type. Valid values are defined by the 'PAYEE_TYPE'
234 * lookup type.
235 * @param p_payee_id {@rep:casecolumn PAY_PERSONAL_PAYMENT_METHODS_F.PAYEE_ID}
236 * @param p_comment_id If p_validate is false and new or existing comment text
237 * exists, then will be set to the identifier of the personal payment method
238 * comment record. If p_validate is true or no comment text exists, then will
239 * be null.
240 * @param p_external_account_id Identifies the external account combination, if
241 * a combination exists and p_validate is FALSE. If p_validate is set to true,
242 * this parameter will be NULL.
243 * @param p_effective_start_date If p_validate is false, then set to the
244 * effective start date on the updated personal payment method row which now
245 * exists as of the effective date. If p_validate is true, then set to null.
246 * @param p_effective_end_date If p_validate is false, then set to the
247 * effective end date on the updated personal payment method row which now
248 * exists as of the effective date. If p_validate is true, then set to null.
249 * @rep:displayname Update Personal Payment Method for Singapore
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_sg_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_bank_account_number IN VARCHAR2 DEFAULT hr_api.g_varchar2
266 ,p_bank_account_name IN VARCHAR2 DEFAULT hr_api.g_varchar2
267 ,p_bank_account_type IN VARCHAR2 DEFAULT hr_api.g_varchar2
268 ,p_bank_code IN VARCHAR2 DEFAULT hr_api.g_varchar2
269 ,p_bank_name IN VARCHAR2 DEFAULT hr_api.g_varchar2
270 ,p_branch_code IN VARCHAR2 DEFAULT hr_api.g_varchar2
271 ,p_branch_name IN VARCHAR2 DEFAULT hr_api.g_varchar2
272 ,p_amount IN NUMBER DEFAULT hr_api.g_number
273 ,p_comments IN VARCHAR2 DEFAULT hr_api.g_varchar2
274 ,p_percentage IN NUMBER DEFAULT hr_api.g_number
275 ,p_priority IN NUMBER DEFAULT hr_api.g_number
276 ,p_attribute_category IN VARCHAR2 DEFAULT hr_api.g_varchar2
277 ,p_attribute1 IN VARCHAR2 DEFAULT hr_api.g_varchar2
278 ,p_attribute2 IN VARCHAR2 DEFAULT hr_api.g_varchar2
279 ,p_attribute3 IN VARCHAR2 DEFAULT hr_api.g_varchar2
280 ,p_attribute4 IN VARCHAR2 DEFAULT hr_api.g_varchar2
281 ,p_attribute5 IN VARCHAR2 DEFAULT hr_api.g_varchar2
282 ,p_attribute6 IN VARCHAR2 DEFAULT hr_api.g_varchar2
283 ,p_attribute7 IN VARCHAR2 DEFAULT hr_api.g_varchar2
284 ,p_attribute8 IN VARCHAR2 DEFAULT hr_api.g_varchar2
285 ,p_attribute9 IN VARCHAR2 DEFAULT hr_api.g_varchar2
286 ,p_attribute10 IN VARCHAR2 DEFAULT hr_api.g_varchar2
287 ,p_attribute11 IN VARCHAR2 DEFAULT hr_api.g_varchar2
288 ,p_attribute12 IN VARCHAR2 DEFAULT hr_api.g_varchar2
289 ,p_attribute13 IN VARCHAR2 DEFAULT hr_api.g_varchar2
290 ,p_attribute14 IN VARCHAR2 DEFAULT hr_api.g_varchar2
291 ,p_attribute15 IN VARCHAR2 DEFAULT hr_api.g_varchar2
292 ,p_attribute16 IN VARCHAR2 DEFAULT hr_api.g_varchar2
293 ,p_attribute17 IN VARCHAR2 DEFAULT hr_api.g_varchar2
294 ,p_attribute18 IN VARCHAR2 DEFAULT hr_api.g_varchar2
295 ,p_attribute19 IN VARCHAR2 DEFAULT hr_api.g_varchar2
296 ,p_attribute20 IN VARCHAR2 DEFAULT hr_api.g_varchar2
297 ,p_payee_type IN VARCHAR2 DEFAULT hr_api.g_varchar2
298 ,p_payee_id IN NUMBER DEFAULT hr_api.g_number
299 ,p_comment_id OUT NOCOPY NUMBER
300 ,p_external_account_id OUT NOCOPY NUMBER
301 ,p_effective_start_date OUT NOCOPY DATE
302 ,p_effective_end_date OUT NOCOPY DATE
303 );
304
305 END hr_sg_personal_pay_method_api;
[Home] [Help]