1 PACKAGE hr_AU_personal_pay_method_api AUTHID CURRENT_USER AS
2 /* $Header: hrauwrpm.pkh 120.1.12000000.1 2007/01/22 14:19:39 appldev ship $ */
3 /*#
4 * This package contains personal pay method API for Australia.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Personal Payment Method for Australia
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |----------------------< create_au_personal_pay_method >-------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates personal pay method details for the Australian
17 * localization.
18 *
19 * The API uses the parameter p_assignment_id for the Australian legislation to
20 * create the payment method. The API calls the generic API
21 * create_personal_pay_method, with the parameters set as appropriate for a
22 * Australian employee assignment.
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 * See API create_personal_pay_method.
29 *
30 * <p><b>Post Success</b><br>
31 * The personal payment method will be successfully inserted
32 *
33 * <p><b>Post Failure</b><br>
34 * The API does not create the personal payment method and raises an error.
35 * @param p_validate If true, then validation alone will be performed and the
36 * database will remain unchanged. If false and all validation checks pass,
37 * then the database will be modified.
38 * @param p_effective_date Determines when the DateTrack operation comes into
39 * force.
40 * @param p_assignment_id Identifies the assignment for which you create the
41 * Personal Payment Method record.
42 * @param p_org_payment_method_id {@rep:casecolumn
43 * PAY_PERSONAL_PAYMENT_METHODS_F.ORG_PAYMENT_METHOD_ID}
44 * @param p_bank_bsb_code Bank bsb number
45 * @param p_bank_account_number Bank account number
46 * @param p_bank_account_name Bank account name.
47 * @param p_amount {@rep:casecolumn PAY_PERSONAL_PAYMENT_METHODS_F.AMOUNT}
48 * @param p_percentage {@rep:casecolumn
49 * PAY_PERSONAL_PAYMENT_METHODS_F.PERCENTAGE}
50 * @param p_priority {@rep:casecolumn PAY_PERSONAL_PAYMENT_METHODS_F.PRIORITY}
51 * @param p_comments Comment text.
52 * @param p_attribute_category This context value determines which flexfield
53 * structure to use with the descriptive flexfield segments.
54 * @param p_attribute1 Descriptive flexfield segment.
55 * @param p_attribute2 Descriptive flexfield segment.
56 * @param p_attribute3 Descriptive flexfield segment.
57 * @param p_attribute4 Descriptive flexfield segment.
58 * @param p_attribute5 Descriptive flexfield segment.
59 * @param p_attribute6 Descriptive flexfield segment.
60 * @param p_attribute7 Descriptive flexfield segment.
61 * @param p_attribute8 Descriptive flexfield segment.
62 * @param p_attribute9 Descriptive flexfield segment.
63 * @param p_attribute10 Descriptive flexfield segment.
64 * @param p_attribute11 Descriptive flexfield segment.
65 * @param p_attribute12 Descriptive flexfield segment.
66 * @param p_attribute13 Descriptive flexfield segment.
67 * @param p_attribute14 Descriptive flexfield segment.
68 * @param p_attribute15 Descriptive flexfield segment.
69 * @param p_attribute16 Descriptive flexfield segment.
70 * @param p_attribute17 Descriptive flexfield segment.
71 * @param p_attribute18 Descriptive flexfield segment.
72 * @param p_attribute19 Descriptive flexfield segment.
73 * @param p_attribute20 Descriptive flexfield segment.
74 * @param p_payee_type {@rep:casecolumn
75 * PAY_PERSONAL_PAYMENT_METHODS_F.PAYEE_TYPE}
76 * @param p_payee_id {@rep:casecolumn PAY_PERSONAL_PAYMENT_METHODS_F.PAYEE_ID}
77 * @param p_personal_payment_method_id If p_validate is FALSE, this uniquely
78 * identifies the personal payment method created. If p_validate is set to
79 * true, this parameter will be null.
80 * @param p_external_account_id If p_validate is false,identifies the external
81 * account combination, if a combination exists . If p_validate is set to true,
82 * this parameter will be null.
83 * @param p_object_version_number If p_validate is false, then set to the
84 * version number of the created personal payment method. If p_validate is
85 * true, then the value will be null.
86 * @param p_effective_start_date If p_validate is false, then set to the
87 * earliest effective start date for the created personal payment method. If
88 * p_validate is true, then set to null.
89 * @param p_effective_end_date If p_validate is false, then set to the
90 * effective end date for the created personal payment method. If p_validate is
91 * true, then set to null.
92 * @param p_comment_id If p_validate is false and comment text was provided,
93 * then will be set to the identifier of the created personal payment method
94 * comment record. If p_validate is true or no comment text was provided, then
95 * will be null.
96 * @rep:displayname Create Personal Payment Method for Australia
100 * @rep:lifecycle active
97 * @rep:category BUSINESS_ENTITY PAY_PERSONAL_PAY_METHOD
98 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
99 * @rep:scope public
101 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
102 */
103 --
104 -- {End Of Comments}
105 --
106 PROCEDURE create_AU_personal_pay_method
107 (p_validate IN BOOLEAN DEFAULT FALSE
108 ,p_effective_date IN DATE
109 ,p_assignment_id IN NUMBER
110 ,p_org_payment_method_id IN NUMBER
111 ,p_bank_bsb_code IN VARCHAR2
112 ,p_bank_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_au_personal_pay_method >-------------------|
151 -- ----------------------------------------------------------------------------
152 --
153 -- {Start Of Comments}
154 /*#
155 * This API updates personal pay method details for Australia.
156 *
157 * The parameters p_personal_payment_method_id and p_object_version_number
158 * indicate which personal pay methods require updating, where the personal
159 * payment method is for an Australian assignment.
160 *
161 * <p><b>Licensing</b><br>
162 * This API is licensed for use with Human Resources.
163 *
164 * <p><b>Prerequisites</b><br>
165 * The personal payment method to be updated must be for a Australian
166 * assignment and it should exist as of effective date of update.
167 *
168 * <p><b>Post Success</b><br>
169 * The personal payment method will be successfully updated.
170 *
171 * <p><b>Post Failure</b><br>
172 * The API does not update the personal payment method and raises an error.
173 * @param p_validate If true, then validation alone will be performed and the
174 * database will remain unchanged. If false and all validation checks pass,
175 * then the database will be modified.
176 * @param p_effective_date Determines when the DateTrack operation comes into
177 * force.
178 * @param p_datetrack_update_mode Indicates which DateTrack mode to use when
179 * updating the record. You must set to either UPDATE, CORRECTION,
180 * UPDATE_OVERRIDE or UPDATE_CHANGE_INSERT. Modes available for use with a
181 * particular record depend on the dates of previous record changes and the
182 * effective date of this change.
183 * @param p_personal_payment_method_id {@rep:casecolumn
184 * PAY_PERSONAL_PAYMENT_METHODS_F.PERSONAL_PAYMENT_METHOD_ID}
185 * @param p_object_version_number Pass in the current version number of the
186 * personal payment method to be updated. When the API completes if p_validate
187 * is false, it will be set to the new version number of the updated personal
188 * payment method. If p_validate is true it will be set to the same value which
189 * was passed in.
190 * @param p_bank_bsb_code Bank bsb number
191 * @param p_bank_account_number Bank account number
192 * @param p_bank_account_name Bank account name.
193 * @param p_amount {@rep:casecolumn PAY_PERSONAL_PAYMENT_METHODS_F.AMOUNT}
194 * @param p_comments Comment text.
195 * @param p_percentage {@rep:casecolumn
196 * PAY_PERSONAL_PAYMENT_METHODS_F.PERCENTAGE}
197 * @param p_priority {@rep:casecolumn PAY_PERSONAL_PAYMENT_METHODS_F.PRIORITY}
198 * @param p_attribute_category This context value determines which flexfield
199 * structure to use with the descriptive flexfield segments.
200 * @param p_attribute1 Descriptive flexfield segment.
201 * @param p_attribute2 Descriptive flexfield segment.
202 * @param p_attribute3 Descriptive flexfield segment.
203 * @param p_attribute4 Descriptive flexfield segment.
204 * @param p_attribute5 Descriptive flexfield segment.
205 * @param p_attribute6 Descriptive flexfield segment.
206 * @param p_attribute7 Descriptive flexfield segment.
207 * @param p_attribute8 Descriptive flexfield segment.
208 * @param p_attribute9 Descriptive flexfield segment.
209 * @param p_attribute10 Descriptive flexfield segment.
210 * @param p_attribute11 Descriptive flexfield segment.
211 * @param p_attribute12 Descriptive flexfield segment.
212 * @param p_attribute13 Descriptive flexfield segment.
213 * @param p_attribute14 Descriptive flexfield segment.
214 * @param p_attribute15 Descriptive flexfield segment.
215 * @param p_attribute16 Descriptive flexfield segment.
216 * @param p_attribute17 Descriptive flexfield segment.
217 * @param p_attribute18 Descriptive flexfield segment.
218 * @param p_attribute19 Descriptive flexfield segment.
219 * @param p_attribute20 Descriptive flexfield segment.
220 * @param p_payee_type {@rep:casecolumn
221 * PAY_PERSONAL_PAYMENT_METHODS_F.PAYEE_TYPE}
222 * @param p_payee_id {@rep:casecolumn PAY_PERSONAL_PAYMENT_METHODS_F.PAYEE_ID}
223 * @param p_comment_id If p_validate is false and new or existing comment text
224 * exists, then will be set to the identifier of the personal payment method
225 * comment record. If p_validate is true or no comment text exists, then will
226 * be null.
227 * @param p_external_account_id If p_validate is false,identifies the external
228 * account combination, if a combination exists . If p_validate is set to true,
229 * this parameter will be null.
230 * @param p_effective_start_date If p_validate is false, then set to the
231 * effective start date on the updated personal payment method row which now
232 * exists as of the effective date. If p_validate is true, then set to null.
233 * @param p_effective_end_date If p_validate is false, then set to the
234 * effective end date on the updated personal payment method row which now
235 * exists as of the effective date. If p_validate is true, then set to null.
236 * @rep:displayname Update Personal Payment Method for Australia
237 * @rep:category BUSINESS_ENTITY PAY_PERSONAL_PAY_METHOD
238 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
239 * @rep:scope public
240 * @rep:lifecycle active
241 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
242 */
243 --
244 -- {End Of Comments}
245 --
246 PROCEDURE update_AU_personal_pay_method
247 (p_validate IN BOOLEAN DEFAULT FALSE
248 ,p_effective_date IN DATE
249 ,p_datetrack_update_mode IN VARCHAR2
250 ,p_personal_payment_method_id IN NUMBER
251 ,p_object_version_number IN OUT NOCOPY NUMBER
252 ,p_bank_bsb_code IN VARCHAR2 DEFAULT hr_api.g_varchar2
253 ,p_bank_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_AU_personal_pay_method_api;
[Home] [Help]