1 package pay_retro_status_load_api AUTHID CURRENT_USER as
2 /* $Header: pyrslapi.pkh 120.1.12020000.1 2012/07/18 09:36:38 apudiped noship $ */
3 /*#
4 * This package contains Retro Status Load APIs.
5 * @rep:scope public
6 * @rep:product pay
7 * @rep:displayname Retro Status Load
8 */
9 -- ----------------------------------------------------------------------------
10 -- |----------------------< create_retro_asg_and_entries >----------------------|
11 -- ----------------------------------------------------------------------------
12 -- {Start Of Comments}
13 /*#
14 * This API creates a new unprocessed retro assignment and retro entries.
15 * This is an overload version of load_retro_assignment.If an unprocessed retro assignment
16 * already exists for the assignment, the new retro assignment will supersede the existing one.
17 *
18 * <p><b>Licensing</b><br>
19 * This API is licensed for use with Payroll.
20 *
21 * <p><b>Prerequisites</b><br>
22 * Please make sure that this procedure is used where the user login
23 * information is established so that the WHO columns are populated properly.
24 * If this procedure is called from a standalone script, it is advisable to
25 * make the following call once before calling this procedure.
26 *
27 * fnd_global.apps_initialize
28 * (user_id => <User ID>
29 * ,resp_id => <Responsibility ID>
30 * ,resp_appl_id => <Responsibility Application ID>
31 * );
32 *
33 * <p><b>Post Success</b><br>
34 * The API will create the new Retro Assignment Set and Retro Entries
35 * the new assignment set id created will be passed through the parameter p_retro_assignment_id.
36 *
37 * <p><b>Post Failure</b><br>
38 * The API will not create or update a retro assignment and raises an
39 * error.
40 *
41 * @param p_business_group_id Business Group ID.
42 * @param p_assignment_number Assignment Number.
43 * @param p_full_name Full Name of the person to identify the assignment for sure.
44 * @param p_reprocess_date Reprocess Date, This parameter is required when the equivalent
45 * retro entry does not exist.
46 * @param p_approval_status Approval Status. If the localization rule allows
47 * multiple status, A (Confirmed - Awaiting Processing) or D (Deferred) is available,
48 * Otherwise the value has to be P (Included - Awaiting Processing).
49 * The below parameters 1 to 15 are used for creating
50 * a retro entry, hence if either element name or element entry ID is
51 * specified for an entry number, corresponding reprocess date must be
52 * specified as well. If element entry ID is specified, the value entered
53 * for element name will be ignored. If element name is specified without
54 * element entry ID, the procedure attempts to find the equivalent element
55 * entry, but it will fail if there are more than one entry for the element
56 * type and the assignment.
57 * @param p_entry1_element_name Element Name.
58 * @param p_entry1_element_entry_id Element Entry ID.
59 * @param p_entry1_reprocess_date Reprocess Date, This parameter is required when the equivalent
60 * retro entry does not exist.
61 * @param p_entry1_component_name Retro Component Name, Also known as Recalculation Reason.
62 * @param p_entry2_element_name Element Name.
63 * @param p_entry2_element_entry_id Element Entry ID.
64 * @param p_entry2_reprocess_date Reprocess Date. This parameter is required when the equivalent
65 * retro entry does not exist.
66 * @param p_entry2_component_name Retro Component Name. Also known as Recalculation Reason.
67 * @param p_entry3_element_name Element Name.
68 * @param p_entry3_element_entry_id Element Entry ID.
69 * @param p_entry3_reprocess_date Reprocess Date. This parameter is required when the equivalent
70 * retro entry does not exist.
71 * @param p_entry3_component_name Retro Component Name. Also known as Recalculation Reason.
72 * @param p_entry4_element_name Element Name.
73 * @param p_entry4_element_entry_id Element Entry ID.
74 * @param p_entry4_reprocess_date Reprocess Date. This parameter is required when the equivalent
75 * retro entry does not exist.
76 * @param p_entry4_component_name Retro Component Name. Also known as Recalculation Reason.
77 * @param p_entry5_element_name Element Name.
78 * @param p_entry5_element_entry_id Element Entry ID.
79 * @param p_entry5_reprocess_date Reprocess Date. This parameter is required when the equivalent
80 * retro entry does not exist.
81 * @param p_entry5_component_name Retro Component Name. Also known as Recalculation Reason.
82 * @param p_entry6_element_name Element Name.
83 * @param p_entry6_element_entry_id Element Entry ID.
84 * @param p_entry6_reprocess_date Reprocess Date. This parameter is required when the equivalent
85 * retro entry does not exist.
86 * @param p_entry6_component_name Retro Component Name. Also known as Recalculation Reason.
87 * @param p_entry7_element_name Element Name.
88 * @param p_entry7_element_entry_id Element Entry ID.
89 * @param p_entry7_reprocess_date Reprocess Date. This parameter is required when the equivalent
90 * retro entry does not exist.
91 * @param p_entry7_component_name Retro Component Name. Also known as Recalculation Reason.
92 * @param p_entry8_element_name Element Name.
93 * @param p_entry8_element_entry_id Element Entry ID.
94 * @param p_entry8_reprocess_date Reprocess Date. This parameter is required when the equivalent
95 * retro entry does not exist.
96 * @param p_entry8_component_name Retro Component Name. Also known as Recalculation Reason.
97 * @param p_entry9_element_name Element Name.
98 * @param p_entry9_element_entry_id Element Entry ID.
99 * @param p_entry9_reprocess_date Reprocess Date. This parameter is required when the equivalent
100 * retro entry does not exist.
101 * @param p_entry9_component_name Retro Component Name. Also known as Recalculation Reason.
102 * @param p_entry10_element_name Element Name.
103 * @param p_entry10_element_entry_id Element Entry ID.
104 * @param p_entry10_reprocess_date Reprocess Date. This parameter is required when the equivalent
105 * retro entry does not exist.
106 * @param p_entry10_component_name Retro Component Name. Also known as Recalculation Reason.
107 * @param p_entry11_element_name Element Name.
108 * @param p_entry11_element_entry_id Element Entry ID.
109 * @param p_entry11_reprocess_date Reprocess Date. This parameter is required when the equivalent
110 * retro entry does not exist.
111 * @param p_entry11_component_name Retro Component Name. Also known as Recalculation Reason.
112 * @param p_entry12_element_name Element Name.
113 * @param p_entry12_element_entry_id Element Entry ID.
114 * @param p_entry12_reprocess_date Reprocess Date. This parameter is required when the equivalent
115 * retro entry does not exist.
116 * @param p_entry12_component_name Retro Component Name. Also known as Recalculation Reason.
117 * @param p_entry13_element_name Element Name.
118 * @param p_entry13_element_entry_id Element Entry ID.
119 * @param p_entry13_reprocess_date Reprocess Date. This parameter is required when the equivalent
120 * retro entry does not exist.
121 * @param p_entry13_component_name Retro Component Name. Also known as Recalculation Reason.
122 * @param p_entry14_element_name Element Name.
123 * @param p_entry14_element_entry_id Element Entry ID.
124 * @param p_entry14_reprocess_date Reprocess Date. This parameter is required when the equivalent
125 * retro entry does not exist.
126 * @param p_entry14_component_name Retro Component Name. Also known as Recalculation Reason.
127 * @param p_entry15_element_name Element Name.
128 * @param p_entry15_element_entry_id Element Entry ID.
129 * @param p_entry15_reprocess_date Reprocess Date. This parameter is required when the equivalent
130 * retro entry does not exist.
131 * @param p_entry15_component_name Retro Component Name. Also known as Recalculation Reason.
132 * @param p_retro_assignment_id will provide the new Assignment Id created after executing the
133 * API
134 *
135 * @rep:displayname Create Retro Assignment and Retro Entries
136 * @rep:category BUSINESS_ENTITY PAY_ELEMENT_ENTRY
137 * @rep:category BUSINESS_ENTITY PER_EMPLOYEE_ASG
138 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
139 * @rep:scope public
140 * @rep:lifecycle active
141 * @rep:ihelp PAY/@scalapi APIs in Oracle HRMS
142 */
143 --
144 -- {End Of Comments}
145 --
146 procedure create_retro_asg_and_entries
147 (p_business_group_id in number
148 ,p_assignment_number in varchar2
149 ,p_full_name in varchar2 default null
150 ,p_reprocess_date in date
151 ,p_approval_status in varchar2 default null
152 ,p_entry1_element_name in varchar2 default null
153 ,p_entry1_element_entry_id in number default null
154 ,p_entry1_reprocess_date in date default null
155 ,p_entry1_component_name in varchar2 default null
156 ,p_entry2_element_name in varchar2 default null
157 ,p_entry2_element_entry_id in number default null
158 ,p_entry2_reprocess_date in date default null
159 ,p_entry2_component_name in varchar2 default null
160 ,p_entry3_element_name in varchar2 default null
161 ,p_entry3_element_entry_id in number default null
162 ,p_entry3_reprocess_date in date default null
163 ,p_entry3_component_name in varchar2 default null
164 ,p_entry4_element_name in varchar2 default null
165 ,p_entry4_element_entry_id in number default null
166 ,p_entry4_reprocess_date in date default null
167 ,p_entry4_component_name in varchar2 default null
168 ,p_entry5_element_name in varchar2 default null
169 ,p_entry5_element_entry_id in number default null
170 ,p_entry5_reprocess_date in date default null
171 ,p_entry5_component_name in varchar2 default null
172 ,p_entry6_element_name in varchar2 default null
173 ,p_entry6_element_entry_id in number default null
174 ,p_entry6_reprocess_date in date default null
175 ,p_entry6_component_name in varchar2 default null
176 ,p_entry7_element_name in varchar2 default null
177 ,p_entry7_element_entry_id in number default null
178 ,p_entry7_reprocess_date in date default null
179 ,p_entry7_component_name in varchar2 default null
180 ,p_entry8_element_name in varchar2 default null
181 ,p_entry8_element_entry_id in number default null
182 ,p_entry8_reprocess_date in date default null
183 ,p_entry8_component_name in varchar2 default null
184 ,p_entry9_element_name in varchar2 default null
185 ,p_entry9_element_entry_id in number default null
186 ,p_entry9_reprocess_date in date default null
187 ,p_entry9_component_name in varchar2 default null
188 ,p_entry10_element_name in varchar2 default null
189 ,p_entry10_element_entry_id in number default null
190 ,p_entry10_reprocess_date in date default null
191 ,p_entry10_component_name in varchar2 default null
192 ,p_entry11_element_name in varchar2 default null
193 ,p_entry11_element_entry_id in number default null
194 ,p_entry11_reprocess_date in date default null
195 ,p_entry11_component_name in varchar2 default null
196 ,p_entry12_element_name in varchar2 default null
197 ,p_entry12_element_entry_id in number default null
198 ,p_entry12_reprocess_date in date default null
199 ,p_entry12_component_name in varchar2 default null
200 ,p_entry13_element_name in varchar2 default null
201 ,p_entry13_element_entry_id in number default null
202 ,p_entry13_reprocess_date in date default null
203 ,p_entry13_component_name in varchar2 default null
204 ,p_entry14_element_name in varchar2 default null
205 ,p_entry14_element_entry_id in number default null
206 ,p_entry14_reprocess_date in date default null
207 ,p_entry14_component_name in varchar2 default null
208 ,p_entry15_element_name in varchar2 default null
209 ,p_entry15_element_entry_id in number default null
210 ,p_entry15_reprocess_date in date default null
211 ,p_entry15_component_name in varchar2 default null
212 ,p_retro_assignment_id out nocopy number
213 );
214 --
215 -- ----------------------------------------------------------------------------
216 -- |----------------------< update_or_delete_retro_asg >----------------------|
217 -- ----------------------------------------------------------------------------
218 -- {Start Of Comments}
219 /*#
220 * This API updates or deletes an existing unprocessed retro assignment.
221 * If the delete mode is selected and the retro assignment is superseding the
222 * previous version of retro assignment, this procedure will remove the latest
223 * changes and revert it back to the previous state of retro assignment.
224 *
225 * <p><b>Licensing</b><br>
226 * This API is licensed for use with Payroll.
227 *
228 * <p><b>Prerequisites</b><br>
229 * None.
230 *
231 * <p><b>Post Success</b><br>
232 * The API will updates or deletes an existing unprocessed retro assignment.
233 *
234 * <p><b>Post Failure</b><br>
235 * The API will not update a retro entry and raises an error.
236 *
237 * @param p_business_group_id Business Group ID.
238 * @param p_assignment_number Assignment Number.
239 * @param p_full_name Full Name of the person to identify the assignment for sure.
240 * @param p_reprocess_date Reprocess Date (for update only).
241 * @param p_approval_status Approval Status (for update only).
242 * @param p_update_or_delete_mode To Update or delete the Retro entry, If UPDATE
243 * then updated the Retro set else DELETE then Deletes the Retro Assignment.
244 *
245 * @rep:displayname Create Retro Assignment and Retro Entries
246 * @rep:category BUSINESS_ENTITY PAY_ELEMENT_ENTRY
247 * @rep:category BUSINESS_ENTITY PER_EMPLOYEE_ASG
248 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
249 * @rep:scope public
250 * @rep:lifecycle active
251 * @rep:ihelp PAY/@scalapi APIs in Oracle HRMS
252 */
253 --
254 -- {End Of Comments}
255 --
256 procedure update_or_delete_retro_asg
257 (p_business_group_id in number
258 ,p_assignment_number in varchar2
259 ,p_full_name in varchar2 default null
260 ,p_reprocess_date in date default null
261 ,p_approval_status in varchar2 default null
262 ,p_update_or_delete_mode in varchar2 default 'UPDATE'
263 );
264 --
265 --
266 -- ----------------------------------------------------------------------------
267 -- |------------------------< update_reprocess_date >-------------------------|
268 -- ----------------------------------------------------------------------------
269 -- {Start Of Comments}
270 /*#
271 * This API is used to update the reprocess date of the system created
272 * retro assignments by creating new retro assignment with the new reprocess
273 * date and superseding the system created retro assignment with the newly
274 * created retro assignment.
275 *
276 * <p><b>Licensing</b><br>
277 * This API is licensed for use with Payroll.
278 *
279 * <p><b>Prerequisites</b><br>
280 * Please make sure that this API is used where the user login
281 * information is established so that the WHO columns are populated properly.
282 * If this procedure is called from a standalone script, it is advisable to
283 * make the following call once before calling this procedure.
284 *
285 * fnd_global.apps_initialize
286 * (user_id => <User ID>
287 * ,resp_id => <Responsibility ID>
288 * ,resp_appl_id => <Responsibility Application ID>
289 * );
290 *
291 * <p><b>Post Success</b><br>
292 * The API will create the new Retro Assignment Set and Retro Entries
293 * the new assignment set created will be passed through the parameter p_retro_assignment_id.
294 *
295 * <p><b>Post Failure</b><br>
296 * The API will not create or update a retro assignment and raises an error.
297 *
298 * @param p_business_group_id Business Group ID.
299 * @param p_assignment_number Assignment Number.
300 * @param p_full_name Full Name of the person to identify the assignment for sure.
301 * @param p_reprocess_date Reprocess Date of the retro assignment. This parameter is
302 * required when no outstanding retro assignment does not exist for the assignment.
303 * @param p_new_retro_asg_id will provide the new Assignment Id created after executing the
304 * API
305 *
306 * @rep:displayname Create Retro Assignment and Retro Entries
307 * @rep:category BUSINESS_ENTITY PAY_ELEMENT_ENTRY
308 * @rep:category BUSINESS_ENTITY PER_EMPLOYEE_ASG
309 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
310 * @rep:scope public
311 * @rep:lifecycle active
312 * @rep:ihelp PAY/@scalapi APIs in Oracle HRMS
313 */
314 --
315 -- {End Of Comments}
316 --
317 procedure update_reprocess_date
318 (p_business_group_id in number
319 ,p_assignment_number in varchar2
320 ,p_full_name in varchar2 default null
321 ,p_reprocess_date in date
322 ,p_new_retro_asg_id out nocopy number
323 );
324
325 end pay_retro_status_load_api;
[Home] [Help]