1 package hr_au_super_api AUTHID CURRENT_USER as
2 /* $Header: hrauwrsu.pkh 120.1 2005/10/02 01:59:37 aroussel $ */
3 /*#
4 * This package contains superannuation contribution APIs for Australia.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Superannuation Contribution for Australia
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |------------------------< update_super_contribution >---------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API updates Super Contribution details for the Australian localization.
17 *
18 * This API updates the Super Contribution element details when the element is
19 * attached to assignment of Australian legislation.
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 business_group_id and valid assignment for the Employee of
26 * Australian Legislation must exist. The super contribution element should be
27 * linked with assignment as of the effective date of update.
28 *
29 * <p><b>Post Success</b><br>
30 * The element entries of Super Contribution element will be successfully
31 * updated.
32 *
33 * <p><b>Post Failure</b><br>
34 * The API does not update the super contribution element 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_assignment_id Identifies the assignment record to be modified.
39 * @param p_session_date Determines when the DateTrack operation takes effect.
40 * @param p_mode Indicates which DateTrack mode to use when updating the
41 * record. You must set to either UPDATE, CORRECTION, UPDATE_OVERRIDE or
42 * UPDATE_CHANGE_INSERT. Modes available for use with a particular record
43 * depend on the dates of previous record changes and the effective date of
44 * this change.
45 * @param p_business_group_id Australia Business group in which the employee is
46 * present
47 * @param p_element_entry_id {@rep:casecolumn
48 * PAY_ELEMENT_ENTRIES_F.ELEMENT_ENTRY_ID}
49 * @param p_super_fund_name Name of the superannuation fund.
50 * @param p_attribute_category This context value determines which flexfield
51 * structure to use with the descriptive flexfield segments.
52 * @param p_attribute1 Descriptive flexfield segment.
53 * @param p_attribute2 Descriptive flexfield segment.
54 * @param p_attribute3 Descriptive flexfield segment.
55 * @param p_attribute4 Descriptive flexfield segment.
56 * @param p_attribute5 Descriptive flexfield segment.
57 * @param p_attribute6 Descriptive flexfield segment.
58 * @param p_attribute7 Descriptive flexfield segment.
59 * @param p_attribute8 Descriptive flexfield segment.
60 * @param p_attribute9 Descriptive flexfield segment.
61 * @param p_attribute10 Descriptive flexfield segment.
62 * @param p_attribute11 Descriptive flexfield segment.
63 * @param p_attribute12 Descriptive flexfield segment.
64 * @param p_attribute13 Descriptive flexfield segment.
65 * @param p_attribute14 Descriptive flexfield segment.
66 * @param p_attribute15 Descriptive flexfield segment.
67 * @param p_attribute16 Descriptive flexfield segment.
68 * @param p_attribute17 Descriptive flexfield segment.
69 * @param p_attribute18 Descriptive flexfield segment.
70 * @param p_attribute19 Descriptive flexfield segment.
71 * @param p_attribute20 Descriptive flexfield segment.
72 * @param p_pay_value Pay value of the Superannuation Contribution.
73 * @param p_member_number Member number.
74 * @param p_sg_amount Super Guarantee amount.
75 * @param p_sg_percent Super Guarantee percentage.
76 * @param p_non_sg_amount Non-Super Guarantee amount.
77 * @param p_non_sg_percent Non-Super Guarantee percentage.
78 * @param p_effective_start_date If p_validate is false, then set to the
79 * effective start date on the updated super contribution row which now exists
80 * as of the effective date. If p_validate is true, then set to null.
81 * @param p_effective_end_date If p_validate is false, then set to the
82 * effective end date on the updated super contribution row which now exists as
83 * of the effective date. If p_validate is true, then set to null.
84 * @param p_update_warning If p_validate is false,set to true if warnings
85 * occurred while processing the element entry.If p_validate is true,then the
86 * value will be null.
87 * @rep:displayname Update Superannuation Contribution for Australia
88 * @rep:category BUSINESS_ENTITY HR_SUPER_CONTRIBUTION
89 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
90 * @rep:scope public
91 * @rep:lifecycle active
92 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
93 */
94 --
95 -- {End Of Comments}
96 --
97 procedure update_super_contribution
98 (p_validate in boolean
99 ,p_assignment_id in number
100 ,p_session_date in date
101 ,p_mode in varchar2
102 ,p_business_group_id in number
103 ,p_element_entry_id in number
104 ,p_super_fund_name in varchar2
105 ,p_attribute_category in varchar2 default null
106 ,p_attribute1 in varchar2 default null
107 ,p_attribute2 in varchar2 default null
108 ,p_attribute3 in varchar2 default null
109 ,p_attribute4 in varchar2 default null
110 ,p_attribute5 in varchar2 default null
111 ,p_attribute6 in varchar2 default null
112 ,p_attribute7 in varchar2 default null
113 ,p_attribute8 in varchar2 default null
114 ,p_attribute9 in varchar2 default null
115 ,p_attribute10 in varchar2 default null
116 ,p_attribute11 in varchar2 default null
117 ,p_attribute12 in varchar2 default null
118 ,p_attribute13 in varchar2 default null
119 ,p_attribute14 in varchar2 default null
120 ,p_attribute15 in varchar2 default null
121 ,p_attribute16 in varchar2 default null
122 ,p_attribute17 in varchar2 default null
123 ,p_attribute18 in varchar2 default null
124 ,p_attribute19 in varchar2 default null
125 ,p_attribute20 in varchar2 default null
126 ,p_pay_value in number default null
127 ,p_member_number in varchar2
128 ,p_sg_amount in number default null
129 ,p_sg_percent in number default null
130 ,p_non_sg_amount in number default null
131 ,p_non_sg_percent in number default null
132 ,p_effective_start_date out NOCOPY date
133 ,p_effective_end_date out NOCOPY date
134 ,p_update_warning out NOCOPY boolean
135 );
136 --
137 -- ----------------------------------------------------------------------------
138 -- |------------------------< create_super_contribution >---------------------|
139 -- ----------------------------------------------------------------------------
140 --
141 -- {Start Of Comments}
142 /*#
143 * This API creates Super Contribution details for Australia.
144 *
145 * This API creates the Super Contribution element details when the element is
146 * assigned to assignment of Australian legislation.
147 *
148 * <p><b>Licensing</b><br>
149 * This API is licensed for use with Human Resources.
150 *
151 * <p><b>Prerequisites</b><br>
152 * A valid business_group_id and valid assignment for the Employee of
153 * Australian Legislation must exist.
154 *
155 * <p><b>Post Success</b><br>
156 * The element entries of Super Contribution element will be successfully
157 * inserted.
158 *
159 * <p><b>Post Failure</b><br>
160 * The API does not create the super contribution element and raises an error.
161 * @param p_validate If true, then validation alone will be performed and the
162 * database will remain unchanged. If false and all validation checks pass,
163 * then the database will be modified.
164 * @param p_effective_date Determines when the DateTrack operation takes
165 * effect.
166 * @param p_business_group_id Australia Business group in which the employee is
167 * present
168 * @param p_original_entry_id {@rep:casecolumn
169 * PAY_ELEMENT_ENTRIES_F.ELEMENT_ENTRY_ID}
170 * @param p_assignment_id Identifies the assignment for which you create the
171 * super contribution record.
172 * @param p_entry_type Entry Type. Valid values are defined by the 'ENTRY_TYPE'
173 * lookup type.
174 * @param p_cost_allocation_keyflex_id {@rep:casecolumn
175 * PAY_ELEMENT_ENTRIES_F.COST_ALLOCATION_KEYFLEX_ID}
176 * @param p_updating_action_id {@rep:casecolumn
177 * PAY_ELEMENT_ENTRIES_F.UPDATING_ACTION_ID}
178 * @param p_comment_id Comment text identifier.
179 * @param p_reason Reason.Valid values are defined by the 'ELE_ENTRY_REASON'
180 * lookup type.
181 * @param p_target_entry_id {@rep:casecolumn
182 * PAY_ELEMENT_ENTRIES_F.TARGET_ENTRY_ID}
183 * @param p_subpriority Subpriority input value.
184 * @param p_date_earned Date Earned input value.
185 * @param p_super_fund_name Name of the superannuation fund.
186 * @param p_attribute_category This context value determines which flexfield
187 * structure to use with the descriptive flexfield segments.
188 * @param p_attribute1 Descriptive flexfield segment.
189 * @param p_attribute2 Descriptive flexfield segment.
190 * @param p_attribute3 Descriptive flexfield segment.
191 * @param p_attribute4 Descriptive flexfield segment.
192 * @param p_attribute5 Descriptive flexfield segment.
193 * @param p_attribute6 Descriptive flexfield segment.
194 * @param p_attribute7 Descriptive flexfield segment.
195 * @param p_attribute8 Descriptive flexfield segment.
196 * @param p_attribute9 Descriptive flexfield segment.
197 * @param p_attribute10 Descriptive flexfield segment.
198 * @param p_attribute11 Descriptive flexfield segment.
199 * @param p_attribute12 Descriptive flexfield segment.
200 * @param p_attribute13 Descriptive flexfield segment.
201 * @param p_attribute14 Descriptive flexfield segment.
202 * @param p_attribute15 Descriptive flexfield segment.
203 * @param p_attribute16 Descriptive flexfield segment.
204 * @param p_attribute17 Descriptive flexfield segment.
205 * @param p_attribute18 Descriptive flexfield segment.
206 * @param p_attribute19 Descriptive flexfield segment.
207 * @param p_attribute20 Descriptive flexfield segment.
208 * @param p_pay_value Pay value of the Super Contribution.
209 * @param p_member_number Member number.
210 * @param p_sg_amount Super Guarantee amount.
211 * @param p_sg_percent Super Guarantee percentage.
212 * @param p_non_sg_amount Non-Super Guarantee amount.
213 * @param p_non_sg_percent Non-Super Guarantee percentage.
214 * @param p_effective_start_date If p_validate is false, then set to the
215 * earliest effective start date for the created super contribution. If
216 * p_validate is true, then set to null.
217 * @param p_effective_end_date If p_validate is false, then set to the
218 * effective end date for the created super contribution. If p_validate is
219 * true, then set to null.
220 * @param p_element_entry_id If p_validate is false,then set to value of the
221 * created super contribution element entry id.If p_validate is true,then the
222 * value will be null.
223 * @param p_object_version_number If p_validate is false, then set to the
224 * version number of the created super contribution. If p_validate is true,
225 * then the value will be null.
226 * @param p_create_warning If p_validate is false,set to true if warnings
227 * occurred while processing the element entry.If p_validate is true,then the
228 * value will be null.
229 * @rep:displayname Create Superannuation Contribution for Australia
230 * @rep:category BUSINESS_ENTITY HR_SUPER_CONTRIBUTION
231 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
232 * @rep:scope public
233 * @rep:lifecycle active
234 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
235 */
236 --
237 -- {End Of Comments}
238 --
239 procedure create_super_contribution
240 (p_validate in boolean default false
241 ,p_effective_date in date
242 ,p_business_group_id in number
243 ,p_original_entry_id in number default null
244 ,p_assignment_id in number
245 ,p_entry_type in varchar2
246 ,p_cost_allocation_keyflex_id in number default null
247 ,p_updating_action_id in number default null
248 ,p_comment_id in number default null
249 ,p_reason in varchar2 default null
250 ,p_target_entry_id in number default null
251 ,p_subpriority in number default null
252 ,p_date_earned in date default null
253 ,p_super_fund_name in varchar2
254 ,p_attribute_category in varchar2 default null
255 ,p_attribute1 in varchar2 default null
256 ,p_attribute2 in varchar2 default null
257 ,p_attribute3 in varchar2 default null
258 ,p_attribute4 in varchar2 default null
259 ,p_attribute5 in varchar2 default null
260 ,p_attribute6 in varchar2 default null
261 ,p_attribute7 in varchar2 default null
262 ,p_attribute8 in varchar2 default null
263 ,p_attribute9 in varchar2 default null
264 ,p_attribute10 in varchar2 default null
265 ,p_attribute11 in varchar2 default null
266 ,p_attribute12 in varchar2 default null
267 ,p_attribute13 in varchar2 default null
268 ,p_attribute14 in varchar2 default null
269 ,p_attribute15 in varchar2 default null
270 ,p_attribute16 in varchar2 default null
271 ,p_attribute17 in varchar2 default null
272 ,p_attribute18 in varchar2 default null
273 ,p_attribute19 in varchar2 default null
274 ,p_attribute20 in varchar2 default null
275 ,p_pay_value in number default null
276 ,p_member_number in varchar2
277 ,p_sg_amount in number default null
278 ,p_sg_percent in number default null
279 ,p_non_sg_amount in number default null
280 ,p_non_sg_percent in number default null
281 ,p_effective_start_date out NOCOPY date
282 ,p_effective_end_date out NOCOPY date
283 ,p_element_entry_id out NOCOPY number
284 ,p_object_version_number out NOCOPY number
285 ,p_create_warning out NOCOPY boolean
286 );
287 --
288 end hr_au_super_api;
[Home] [Help]