DBA Data[Home] [Help]

PACKAGE: APPS.PAY_BATCH_ELEMENT_ENTRY_API

Source


1 Package PAY_BATCH_ELEMENT_ENTRY_API AUTHID CURRENT_USER as
2 /* $Header: pybthapi.pkh 120.5 2011/05/03 09:42:03 vpallapo ship $ */
3 /*#
4  * This package contains Batch Element Entry APIs.
5  * @rep:scope public
6  * @rep:product per
7  * @rep:displayname Batch Element Entry
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |---------------------------< create_batch_header >------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16  * This API creates a batch header record.
17  *
18  *
19  * <p><b>Licensing</b><br>
20  * This API is licensed for use with Human Resources.
21  *
22  * <p><b>Prerequisites</b><br>
23  * A valid business group should exists.
24  *
25  * <p><b>Post Success</b><br>
26  * The batch header will be successfully inserted into the database.
27  *
28  * <p><b>Post Failure</b><br>
29  * The API does not create the batch header and raises an error.
30  * @param p_validate If true, then validation alone will be performed and the
31  * database will remain unchanged. If false and all validation checks pass,
32  * then the database will be modified.
33  * @param p_session_date Applications effective date.
34  * @param p_batch_name Name of the batch header.
35  * @param p_batch_status Status of the batch. (BATCH_SOURCE lookup type of
36  * HR_LOOKUPS, default 'U')
37  * @param p_business_group_id Business group of record.
38  * @param p_action_if_exists Type of action performed if a batch with that name
39  * exists. (ACTION_IF_EXISTS lookup type of HR_LOOKUPS, Default value of 'R'.)
40  * @param p_batch_reference Reference for the batch.
41  * @param p_batch_source Source for the batch.
42  * @param p_comments Batch header comment text.
43  * @param p_date_effective_changes Creation type for the batch.
44  * (DATE_EFFECTIVE_CHANGES lookup type of HR_LOOKUPS, Default value of 'C'.)
45  * @param p_purge_after_transfer Purge-batch-after-transfer flag. (YES_NO
46  * lookup type of HR_LOOKUPS, default 'N')
47  * @param p_reject_if_future_changes Reject-if-future-change flag. (YES_NO
48  * lookup type of HR_LOOKUPS, default 'Y')
49  * @param p_batch_id If p_validate is false, this uniquely identifies the
50  * Batch Header created. If p_validate is set to true, this parameter will be
51  * null.
52  * @param p_object_version_number If p_validate is false, then set to the
53  * version number of the created batch header. If p_validate is true, then the
54  * value will be null.
55  * @param p_reject_if_results_exists Rejects the rollback if there are run
56  * results exist for the transferred line. (YES_NO lookup type of HR_LOOKUPS,
57  * default 'Y')
58  * @param p_purge_after_rollback Purges the batch after the rollback. (YES_NO
59  * lookup type of HR_LOOKUPS, default 'Y')
60  * @param p_batch_type Batch type for the given batch. This is based on
61  * the lookup type PAY_BEE_BATCH_TYPE.
62  * @param p_reject_entry_not_removed If this is selected and if the entry is
63  * not found or not removed then the batch line status of all batch lines
64  * for the given assignment will remain as 'Transferred'.
65  * @param p_rollback_entry_updates Allows the option to rollback entry
66  * updates other than correction and update override.
67  * @rep:displayname Create Batch Header
68  * @rep:category BUSINESS_ENTITY PAY_BATCH_ELEMENT_ENTRY
69  * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
70  * @rep:scope public
71  * @rep:lifecycle active
72  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
73 */
74 --
75 -- {End Of Comments}
76 --
77 procedure create_batch_header
78   (p_validate                      in     boolean  default false
79   ,p_session_date                  in     date
80   ,p_batch_name                    in     varchar2
81   ,p_batch_status                  in     varchar2 default 'U'
82   ,p_business_group_id             in     number
83   ,p_action_if_exists              in     varchar2 default 'R'
84   ,p_batch_reference               in     varchar2 default null
85   ,p_batch_source                  in     varchar2 default null
86   ,p_comments                      in     varchar2 default null
87   ,p_date_effective_changes        in     varchar2 default null
88   ,p_purge_after_transfer          in     varchar2 default 'N'
89   ,p_reject_if_future_changes      in     varchar2 default 'Y'
90   ,p_batch_id                         out nocopy number
91   ,p_object_version_number            out nocopy number
92   ,p_reject_if_results_exists      in     varchar2 default 'Y'
93   ,p_purge_after_rollback          in     varchar2 default 'N'
94   ,p_batch_type                    in     varchar2 default null
95   ,p_REJECT_ENTRY_NOT_REMOVED      in     varchar2 default 'N'
96   ,p_ROLLBACK_ENTRY_UPDATES        in     varchar2 default 'N'
97   );
98 --
99 -- ----------------------------------------------------------------------------
100 -- |----------------------------< create_batch_line >-------------------------|
101 -- ----------------------------------------------------------------------------
102 --
103 -- {Start Of Comments}
104 /*#
105  * This API creates a batch line record.
106  *
107  *
108  * <p><b>Licensing</b><br>
109  * This API is licensed for use with Human Resources.
110  *
111  * <p><b>Prerequisites</b><br>
112  * A Batch Header.
113  *
114  * <p><b>Post Success</b><br>
115  * The batch line will be successfully inserted into the database.
116  *
117  * <p><b>Post Failure</b><br>
118  * The API does not create the batch line and raises an error.
119  * @param p_validate If true, then validation alone will be performed and the
120  * database will remain unchanged. If false and all validation checks pass,
121  * then the database will be modified.
122  * @param p_session_date Applications effective date.
123  * @param p_batch_id Foreign Key to the Batch Header.
124  * @param p_batch_line_status Status of the batch. (BATCH_SOURCE lookup type of
125  * HR_LOOKUPS, default 'U')
126  * @param p_assignment_id {@rep:casecolumn PER_ALL_ASSIGNMENTS_F.ASSIGNMENT_ID}
127  * @param p_assignment_number Assignment Number
128  * @param p_attribute_category This context value determines which flexfield
129  * structure to use with the descriptive flexfield segments.
130  * @param p_attribute1 Descriptive flexfield segment.
131  * @param p_attribute2 Descriptive flexfield segment.
132  * @param p_attribute3 Descriptive flexfield segment.
133  * @param p_attribute4 Descriptive flexfield segment.
134  * @param p_attribute5 Descriptive flexfield segment.
135  * @param p_attribute6 Descriptive flexfield segment.
136  * @param p_attribute7 Descriptive flexfield segment.
137  * @param p_attribute8 Descriptive flexfield segment.
138  * @param p_attribute9 Descriptive flexfield segment.
139  * @param p_attribute10 Descriptive flexfield segment.
140  * @param p_attribute11 Descriptive flexfield segment.
141  * @param p_attribute12 Descriptive flexfield segment.
142  * @param p_attribute13 Descriptive flexfield segment.
143  * @param p_attribute14 Descriptive flexfield segment.
144  * @param p_attribute15 Descriptive flexfield segment.
145  * @param p_attribute16 Descriptive flexfield segment.
146  * @param p_attribute17 Descriptive flexfield segment.
147  * @param p_attribute18 Descriptive flexfield segment.
148  * @param p_attribute19 Descriptive flexfield segment.
149  * @param p_attribute20 Descriptive flexfield segment.
150  * @param p_entry_information_category Further Element Entry Info.
151  * @param p_entry_information1 Further Element Entry Info.
152  * @param p_entry_information2 Further Element Entry Info.
153  * @param p_entry_information3 Further Element Entry Info.
157  * @param p_entry_information7 Further Element Entry Info.
154  * @param p_entry_information4 Further Element Entry Info.
155  * @param p_entry_information5 Further Element Entry Info.
156  * @param p_entry_information6 Further Element Entry Info.
158  * @param p_entry_information8 Further Element Entry Info.
159  * @param p_entry_information9 Further Element Entry Info.
160  * @param p_entry_information10 Further Element Entry Info.
161  * @param p_entry_information11 Further Element Entry Info.
162  * @param p_entry_information12 Further Element Entry Info.
163  * @param p_entry_information13 Further Element Entry Info.
164  * @param p_entry_information14 Further Element Entry Info.
165  * @param p_entry_information15 Further Element Entry Info.
166  * @param p_entry_information16 Further Element Entry Info.
167  * @param p_entry_information17 Further Element Entry Info.
168  * @param p_entry_information18 Further Element Entry Info.
169  * @param p_entry_information19 Further Element Entry Info.
170  * @param p_entry_information20 Further Element Entry Info.
171  * @param p_entry_information21 Further Element Entry Info.
172  * @param p_entry_information22 Further Element Entry Info.
173  * @param p_entry_information23 Further Element Entry Info.
174  * @param p_entry_information24 Further Element Entry Info.
175  * @param p_entry_information25 Further Element Entry Info.
176  * @param p_entry_information26 Further Element Entry Info.
177  * @param p_entry_information27 Further Element Entry Info.
178  * @param p_entry_information28 Further Element Entry Info.
179  * @param p_entry_information29 Further Element Entry Info.
180  * @param p_entry_information30 Further Element Entry Info.
181  * @param p_date_earned Date Earned
182  * @param p_personal_payment_method_id Personal Payment Method
183  * @param p_subpriority Sub priority
184  * @param p_batch_sequence Sequence order of the line within the batch.
185  * @param p_concatenated_segments Concatenated Costing Segments
186  * @param p_cost_allocation_keyflex_id Identifier for the Cost Allocation
187  * Keyflex
188  * @param p_effective_date Determines when the DateTrack operation comes into
189  * force.
190  * @param p_effective_start_date This will be used as the absence start date or
191  * the effective start date for certain elements.
192  * @param p_effective_end_date This will be used as the absence end date or the
193  * effective end date for certain elements.
194  * @param p_element_name Element Name
195  * @param p_element_type_id Identifier for the Element Type
196  * @param p_entry_type Entry Type (ENTRY_TYPE lookup type of HR_LOOKUPS)
197  * @param p_reason Reason
198  * @param p_segment1 Key flexfield segment for Element Entry Info.
199  * @param p_segment2 Key flexfield segment for Element Entry Info.
200  * @param p_segment3 Key flexfield segment for Element Entry Info.
201  * @param p_segment4 Key flexfield segment for Element Entry Info.
202  * @param p_segment5 Key flexfield segment for Element Entry Info.
203  * @param p_segment6 Key flexfield segment for Element Entry Info.
204  * @param p_segment7 Key flexfield segment for Element Entry Info.
205  * @param p_segment8 Key flexfield segment for Element Entry Info.
206  * @param p_segment9 Key flexfield segment for Element Entry Info.
207  * @param p_segment10 Key flexfield segment for Element Entry Info.
208  * @param p_segment11 Key flexfield segment for Element Entry Info.
209  * @param p_segment12 Key flexfield segment for Element Entry Info.
210  * @param p_segment13 Key flexfield segment for Element Entry Info.
211  * @param p_segment14 Key flexfield segment for Element Entry Info.
212  * @param p_segment15 Key flexfield segment for Element Entry Info.
213  * @param p_segment16 Key flexfield segment for Element Entry Info.
214  * @param p_segment17 Key flexfield segment.
215  * @param p_segment18 Key flexfield segment.
216  * @param p_segment19 Key flexfield segment.
217  * @param p_segment20 Key flexfield segment.
218  * @param p_segment21 Key flexfield segment.
219  * @param p_segment22 Key flexfield segment.
220  * @param p_segment23 Key flexfield segment.
221  * @param p_segment24 Key flexfield segment.
222  * @param p_segment25 Key flexfield segment.
223  * @param p_segment26 Key flexfield segment.
224  * @param p_segment27 Key flexfield segment.
225  * @param p_segment28 Key flexfield segment.
226  * @param p_segment29 Key flexfield segment.
227  * @param p_segment30 Key flexfield segment.
228  * @param p_value_1 Input Value
229  * @param p_value_2 Input Value
230  * @param p_value_3 Input Value
231  * @param p_value_4 Input Value
232  * @param p_value_5 Input Value
233  * @param p_value_6 Input Value
234  * @param p_value_7 Input Value
235  * @param p_value_8 Input Value
236  * @param p_value_9 Input Value
237  * @param p_value_10 Input Value
238  * @param p_value_11 Input Value
239  * @param p_value_12 Input Value
240  * @param p_value_13 Input Value
241  * @param p_value_14 Input Value
242  * @param p_value_15 Input Value
243  * @param p_canonical_date_format (Y/N) To indicate whether the date format of
244  * the input values is in internal or display format.
245  * @param p_iv_all_internal_format (Y/N) Internal format for all input values.
246  * If set to 'Y' then it overrides the p_canonical_date_format flag.
247  * @param p_batch_line_id If p_validate is false, this uniquely identifies the
248  * Batch Line created. If p_validate is set to true, this parameter will be
249  * null.
250  * @param p_object_version_number If p_validate is false, then set to the
251  * version number of the created batch line. If p_validate is true, then the
252  * value will be null.
253  * @rep:displayname Create Batch Line
257  * @rep:lifecycle active
254  * @rep:category BUSINESS_ENTITY PAY_BATCH_ELEMENT_ENTRY
255  * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
256  * @rep:scope public
258  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
259 */
260 --
261 -- {End Of Comments}
262 --
263 procedure create_batch_line
264   (p_validate                      in     boolean  default false
265   ,p_session_date                  in     date
266   ,p_batch_id                      in     number
267   ,p_batch_line_status             in     varchar2 default 'U'
268   ,p_assignment_id                 in     number   default null
269   ,p_assignment_number             in     varchar2 default null
270   ,p_attribute_category            in     varchar2 default null
271   ,p_attribute1                    in     varchar2 default null
272   ,p_attribute2                    in     varchar2 default null
273   ,p_attribute3                    in     varchar2 default null
274   ,p_attribute4                    in     varchar2 default null
275   ,p_attribute5                    in     varchar2 default null
276   ,p_attribute6                    in     varchar2 default null
277   ,p_attribute7                    in     varchar2 default null
278   ,p_attribute8                    in     varchar2 default null
279   ,p_attribute9                    in     varchar2 default null
280   ,p_attribute10                   in     varchar2 default null
281   ,p_attribute11                   in     varchar2 default null
282   ,p_attribute12                   in     varchar2 default null
283   ,p_attribute13                   in     varchar2 default null
284   ,p_attribute14                   in     varchar2 default null
285   ,p_attribute15                   in     varchar2 default null
286   ,p_attribute16                   in     varchar2 default null
287   ,p_attribute17                   in     varchar2 default null
288   ,p_attribute18                   in     varchar2 default null
289   ,p_attribute19                   in     varchar2 default null
290   ,p_attribute20                   in     varchar2 default null
291   ,p_entry_information_category    in     varchar2 default null
292   ,p_entry_information1            in     varchar2 default null
293   ,p_entry_information2            in     varchar2 default null
294   ,p_entry_information3            in     varchar2 default null
295   ,p_entry_information4            in     varchar2 default null
296   ,p_entry_information5            in     varchar2 default null
297   ,p_entry_information6            in     varchar2 default null
298   ,p_entry_information7            in     varchar2 default null
299   ,p_entry_information8            in     varchar2 default null
300   ,p_entry_information9            in     varchar2 default null
301   ,p_entry_information10           in     varchar2 default null
302   ,p_entry_information11           in     varchar2 default null
303   ,p_entry_information12           in     varchar2 default null
304   ,p_entry_information13           in     varchar2 default null
305   ,p_entry_information14           in     varchar2 default null
306   ,p_entry_information15           in     varchar2 default null
307   ,p_entry_information16           in     varchar2 default null
308   ,p_entry_information17           in     varchar2 default null
309   ,p_entry_information18           in     varchar2 default null
310   ,p_entry_information19           in     varchar2 default null
311   ,p_entry_information20           in     varchar2 default null
312   ,p_entry_information21           in     varchar2 default null
313   ,p_entry_information22           in     varchar2 default null
314   ,p_entry_information23           in     varchar2 default null
315   ,p_entry_information24           in     varchar2 default null
316   ,p_entry_information25           in     varchar2 default null
317   ,p_entry_information26           in     varchar2 default null
318   ,p_entry_information27           in     varchar2 default null
319   ,p_entry_information28           in     varchar2 default null
320   ,p_entry_information29           in     varchar2 default null
321   ,p_entry_information30           in     varchar2 default null
322   ,p_date_earned                   in     date     default null
323   ,p_personal_payment_method_id    in     number   default null
324   ,p_subpriority                   in     number   default null
325   ,p_batch_sequence                in     number   default null
326   ,p_concatenated_segments         in     varchar2 default null
327   ,p_cost_allocation_keyflex_id    in     number   default null
328   ,p_effective_date                in     date     default null
329   ,p_effective_start_date          in     date     default null
330   ,p_effective_end_date            in     date     default null
331   ,p_element_name                  in     varchar2 default null
332   ,p_element_type_id               in     number   default null
333   ,p_entry_type                    in     varchar2 default null
334   ,p_reason                        in     varchar2 default null
335   ,p_segment1                      in     varchar2 default null
336   ,p_segment2                      in     varchar2 default null
337   ,p_segment3                      in     varchar2 default null
338   ,p_segment4                      in     varchar2 default null
339   ,p_segment5                      in     varchar2 default null
340   ,p_segment6                      in     varchar2 default null
341   ,p_segment7                      in     varchar2 default null
342   ,p_segment8                      in     varchar2 default null
343   ,p_segment9                      in     varchar2 default null
344   ,p_segment10                     in     varchar2 default null
345   ,p_segment11                     in     varchar2 default null
346   ,p_segment12                     in     varchar2 default null
347   ,p_segment13                     in     varchar2 default null
351   ,p_segment17                     in     varchar2 default null
348   ,p_segment14                     in     varchar2 default null
349   ,p_segment15                     in     varchar2 default null
350   ,p_segment16                     in     varchar2 default null
352   ,p_segment18                     in     varchar2 default null
353   ,p_segment19                     in     varchar2 default null
354   ,p_segment20                     in     varchar2 default null
355   ,p_segment21                     in     varchar2 default null
356   ,p_segment22                     in     varchar2 default null
357   ,p_segment23                     in     varchar2 default null
358   ,p_segment24                     in     varchar2 default null
359   ,p_segment25                     in     varchar2 default null
360   ,p_segment26                     in     varchar2 default null
361   ,p_segment27                     in     varchar2 default null
362   ,p_segment28                     in     varchar2 default null
363   ,p_segment29                     in     varchar2 default null
364   ,p_segment30                     in     varchar2 default null
365   ,p_value_1                       in     varchar2 default null
366   ,p_value_2                       in     varchar2 default null
367   ,p_value_3                       in     varchar2 default null
368   ,p_value_4                       in     varchar2 default null
369   ,p_value_5                       in     varchar2 default null
370   ,p_value_6                       in     varchar2 default null
371   ,p_value_7                       in     varchar2 default null
372   ,p_value_8                       in     varchar2 default null
373   ,p_value_9                       in     varchar2 default null
374   ,p_value_10                      in     varchar2 default null
375   ,p_value_11                      in     varchar2 default null
376   ,p_value_12                      in     varchar2 default null
377   ,p_value_13                      in     varchar2 default null
378   ,p_value_14                      in     varchar2 default null
379   ,p_value_15                      in     varchar2 default null
380   ,p_canonical_date_format         in     varchar2 default 'Y'
381   ,p_iv_all_internal_format        in     varchar2 default 'N'
382   ,p_batch_line_id                    out nocopy number
383   ,p_object_version_number            out nocopy number
384   );
385 --
386 -- ----------------------------------------------------------------------------
387 -- |----------------------------< create_batch_total >------------------------|
388 -- ----------------------------------------------------------------------------
389 --
390 -- {Start Of Comments}
391 /*#
392  * This API creates a batch control total record.
393  *
394  *
395  * <p><b>Licensing</b><br>
396  * This API is licensed for use with Human Resources.
397  *
398  * <p><b>Prerequisites</b><br>
399  * A Batch Header.
400  *
401  * <p><b>Post Success</b><br>
402  * The batch control total will be successfully inserted into the database.
403  *
404  * <p><b>Post Failure</b><br>
405  * The API does not create the batch control total and raises an error.
406  * @param p_validate If true, then validation alone will be performed and the
407  * database will remain unchanged. If false and all validation checks pass,
408  * then the database will be modified.
409  * @param p_session_date Applications effective date.
410  * @param p_batch_id Foreign Key to the Batch Header.
411  * @param p_control_status Status of the batch control total. (BATCH_SOURCE
412  * lookup type of HR_LOOKUPS, default 'U')
413  * @param p_control_total Control total value.
414  * @param p_control_type Type of rows to be summed. (Lookup type of
415  * 'CONTROL_TYPE' within HR_LOOKUPS)
416  * @param p_batch_control_id If p_validate is false, this uniquely identifies
417  * the Batch Control Total created. If p_validate is set to true, this
418  * parameter will be null.
419  * @param p_object_version_number If p_validate is false, then set to the
420  * version number of the created batch control total. If p_validate is true,
421  * then the value will be null.
422  * @rep:displayname Create Batch Total
423  * @rep:category BUSINESS_ENTITY PAY_BATCH_ELEMENT_ENTRY
424  * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
425  * @rep:scope public
426  * @rep:lifecycle active
427  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
428 */
429 --
430 -- {End Of Comments}
431 --
432 procedure create_batch_total
433   (p_validate                      in     boolean  default false
434   ,p_session_date                  in     date
435   ,p_batch_id                      in     number
436   ,p_control_status                in     varchar2 default 'U'
437   ,p_control_total                 in     varchar2 default null
438   ,p_control_type                  in     varchar2 default null
439   ,p_batch_control_id                 out nocopy number
440   ,p_object_version_number            out nocopy number
441   ,p_iv_all_internal_format        in     varchar2 default 'N'
442   ,p_control_column_name           in     varchar2 default null
443   );
444 --
445 -- ----------------------------------------------------------------------------
446 -- |---------------------------< update_batch_header >------------------------|
447 -- ----------------------------------------------------------------------------
448 --
449 -- {Start Of Comments}
450 /*#
451  * This API updates the batch header information.
452  *
453  *
454  * <p><b>Licensing</b><br>
455  * This API is licensed for use with Human Resources.
456  *
457  * <p><b>Prerequisites</b><br>
458  * A valid batch header should exists.
459  *
460  * <p><b>Post Success</b><br>
461  * The batch header will be successfully updated into the database.
462  *
463  * <p><b>Post Failure</b><br>
467  * then the database will be modified.
464  * The API does not update the batch header and raises an error.
465  * @param p_validate If true, then validation alone will be performed and the
466  * database will remain unchanged. If false and all validation checks pass,
468  * @param p_session_date Applications effective date.
469  * @param p_batch_id Primary Key of the record.
470  * @param p_object_version_number Pass in the current version number of the
471  * batch header to be updated. When the API completes if p_validate is false,
472  * will be set to the new version number of the updated batch header. If
473  * p_validate is true will be set to the same value which was passed in.
474  * @param p_action_if_exists Type of action performed if a batch with that name
475  * exists. (ACTION_IF_EXISTS lookup type of HR_LOOKUPS)
476  * @param p_batch_name Name of the batch header.
477  * @param p_batch_reference Reference for the batch.
478  * @param p_batch_source Source for the batch.
479  * @param p_batch_status Status of the batch.
480  * @param p_comments Batch header comment text.
481  * @param p_date_effective_changes Creation type for the batch.
482  * (DATE_EFFECTIVE_CHANGES lookup type of HR_LOOKUPS)
483  * @param p_purge_after_transfer Purge-batch-after-transfer flag. (YES_NO
484  * lookup type of HR_LOOKUPS)
485  * @param p_reject_if_future_changes Reject-if-future-change flag. (YES_NO
486  * lookup type of HR_LOOKUPS)
487  * @param p_reject_if_results_exists Rejects the rollback if there are run
488  * results exist for the transferred line. (YES_NO lookup type of HR_LOOKUPS,
489  * default 'Y')
490  * @param p_purge_after_rollback Purges the batch after the rollback. (YES_NO
491  * lookup type of HR_LOOKUPS, default 'Y')
492  * @param p_batch_type Batch type for the given batch. This is based on
493  * the lookup type PAY_BEE_BATCH_TYPE.
494  * @param p_reject_entry_not_removed If this is selected and if the entry is
495  * not found or not removed then the batch line status of all batch lines
496  * for the given assignment will remain as 'Transferred'.
497  * @param p_rollback_entry_updates Allows the option to rollback entry
498  * updates other than correction and update override.
499  * @rep:displayname Update Batch Header
500  * @rep:category BUSINESS_ENTITY PAY_BATCH_ELEMENT_ENTRY
501  * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
502  * @rep:scope public
503  * @rep:lifecycle active
504  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
505 */
506 --
507 -- {End Of Comments}
508 --
509 procedure update_batch_header
510   (p_validate                      in     boolean  default false
511   ,p_session_date                  in     date
512   ,p_batch_id                      in     number
513   ,p_object_version_number         in out nocopy number
514   ,p_action_if_exists              in     varchar2 default hr_api.g_varchar2
515   ,p_batch_name                    in     varchar2 default hr_api.g_varchar2
516   ,p_batch_reference               in     varchar2 default hr_api.g_varchar2
517   ,p_batch_source                  in     varchar2 default hr_api.g_varchar2
518   ,p_batch_status                  in     varchar2 default hr_api.g_varchar2
519   ,p_comments                      in     varchar2 default hr_api.g_varchar2
520   ,p_date_effective_changes        in     varchar2 default hr_api.g_varchar2
521   ,p_purge_after_transfer          in     varchar2 default hr_api.g_varchar2
522   ,p_reject_if_future_changes      in     varchar2 default hr_api.g_varchar2
523   ,p_reject_if_results_exists      in     varchar2 default hr_api.g_varchar2
524   ,p_purge_after_rollback          in     varchar2 default hr_api.g_varchar2
525   ,p_batch_type                    in     varchar2 default hr_api.g_varchar2
526   ,p_REJECT_ENTRY_NOT_REMOVED      in     varchar2 default hr_api.g_varchar2
527   ,p_ROLLBACK_ENTRY_UPDATES        in     varchar2 default hr_api.g_varchar2
528   );
529 --
530 -- ----------------------------------------------------------------------------
531 -- |----------------------------< update_batch_line >-------------------------|
532 -- ----------------------------------------------------------------------------
533 --
534 -- {Start Of Comments}
535 /*#
536  * This API updates the batch line information.
537  *
538  *
539  * <p><b>Licensing</b><br>
540  * This API is licensed for use with Human Resources.
541  *
542  * <p><b>Prerequisites</b><br>
543  * A Batch Header.
544  *
545  * <p><b>Post Success</b><br>
546  * The batch line will be successfully updated into the database.
547  *
548  * <p><b>Post Failure</b><br>
549  * The API does not update the batch line and raises an error.
550  * @param p_validate If true, then validation alone will be performed and the
551  * database will remain unchanged. If false and all validation checks pass,
552  * then the database will be modified.
553  * @param p_session_date Applications effective date.
554  * @param p_batch_line_id Primary Key of the record.
555  * @param p_batch_line_status Line's status. (BATCH_STATUS lookup value)
556  * @param p_object_version_number Pass in the current version number of the
557  * batch line to be updated. When the API completes if p_validate is false,
558  * will be set to the new version number of the updated batch line. If
559  * p_validate is true will be set to the same value which was passed in.
560  * @param p_assignment_id {@rep:casecolumn PER_ALL_ASSIGNMENTS_F.ASSIGNMENT_ID}
561  * @param p_assignment_number Assignment Number
562  * @param p_attribute_category This context value determines which flexfield
563  * structure to use with the descriptive flexfield segments.
564  * @param p_attribute1 Descriptive flexfield segment.
565  * @param p_attribute2 Descriptive flexfield segment.
566  * @param p_attribute3 Descriptive flexfield segment.
567  * @param p_attribute4 Descriptive flexfield segment.
568  * @param p_attribute5 Descriptive flexfield segment.
572  * @param p_attribute9 Descriptive flexfield segment.
569  * @param p_attribute6 Descriptive flexfield segment.
570  * @param p_attribute7 Descriptive flexfield segment.
571  * @param p_attribute8 Descriptive flexfield segment.
573  * @param p_attribute10 Descriptive flexfield segment.
574  * @param p_attribute11 Descriptive flexfield segment.
575  * @param p_attribute12 Descriptive flexfield segment.
576  * @param p_attribute13 Descriptive flexfield segment.
577  * @param p_attribute14 Descriptive flexfield segment.
578  * @param p_attribute15 Descriptive flexfield segment.
579  * @param p_attribute16 Descriptive flexfield segment.
580  * @param p_attribute17 Descriptive flexfield segment.
581  * @param p_attribute18 Descriptive flexfield segment.
582  * @param p_attribute19 Descriptive flexfield segment.
583  * @param p_attribute20 Descriptive flexfield segment.
584  * @param p_entry_information_category Further Element Entry Info.
585  * @param p_entry_information1 Further Element Entry Info.
586  * @param p_entry_information2 Further Element Entry Info.
587  * @param p_entry_information3 Further Element Entry Info.
588  * @param p_entry_information4 Further Element Entry Info.
589  * @param p_entry_information5 Further Element Entry Info.
590  * @param p_entry_information6 Further Element Entry Info.
591  * @param p_entry_information7 Further Element Entry Info.
592  * @param p_entry_information8 Further Element Entry Info.
593  * @param p_entry_information9 Further Element Entry Info.
594  * @param p_entry_information10 Further Element Entry Info.
595  * @param p_entry_information11 Further Element Entry Info.
596  * @param p_entry_information12 Further Element Entry Info.
597  * @param p_entry_information13 Further Element Entry Info.
598  * @param p_entry_information14 Further Element Entry Info.
599  * @param p_entry_information15 Further Element Entry Info.
600  * @param p_entry_information16 Further Element Entry Info.
601  * @param p_entry_information17 Further Element Entry Info.
602  * @param p_entry_information18 Further Element Entry Info.
603  * @param p_entry_information19 Further Element Entry Info.
604  * @param p_entry_information20 Further Element Entry Info.
605  * @param p_entry_information21 Further Element Entry Info.
606  * @param p_entry_information22 Further Element Entry Info.
607  * @param p_entry_information23 Further Element Entry Info.
608  * @param p_entry_information24 Further Element Entry Info.
609  * @param p_entry_information25 Further Element Entry Info.
610  * @param p_entry_information26 Further Element Entry Info.
611  * @param p_entry_information27 Further Element Entry Info.
612  * @param p_entry_information28 Further Element Entry Info.
613  * @param p_entry_information29 Further Element Entry Info.
614  * @param p_entry_information30 Further Element Entry Info.
615  * @param p_date_earned Date Earned
616  * @param p_personal_payment_method_id Personal Payment Method
617  * @param p_subpriority Sub priority
618  * @param p_batch_sequence Sequence order of the line within the batch.
619  * @param p_concatenated_segments Concatenated Costing Segments
620  * @param p_cost_allocation_keyflex_id Identifier for the Cost Allocation
621  * Keyflex
622  * @param p_effective_date Determines when the DateTrack operation comes into
623  * force.
624  * @param p_effective_start_date This will be used as the absence start date or
625  * the effective start date for certain elements.
626  * @param p_effective_end_date This will be used as the absence end date or the
627  * effective end date for certain elements.
628  * @param p_element_name Element Name
629  * @param p_element_type_id Identifier for the Element Type
630  * @param p_entry_type Entry Type (ENTRY_TYPE lookup type of HR_LOOKUPS)
631  * @param p_reason Reason
632  * @param p_segment1 Key flexfield segment.
633  * @param p_segment2 Key flexfield segment.
634  * @param p_segment3 Key flexfield segment.
635  * @param p_segment4 Key flexfield segment.
636  * @param p_segment5 Key flexfield segment.
637  * @param p_segment6 Key flexfield segment.
638  * @param p_segment7 Key flexfield segment.
639  * @param p_segment8 Key flexfield segment.
640  * @param p_segment9 Key flexfield segment.
641  * @param p_segment10 Key flexfield segment.
642  * @param p_segment11 Key flexfield segment.
643  * @param p_segment12 Key flexfield segment.
644  * @param p_segment13 Key flexfield segment.
645  * @param p_segment14 Key flexfield segment.
646  * @param p_segment15 Key flexfield segment.
647  * @param p_segment16 Key flexfield segment.
648  * @param p_segment17 Key flexfield segment.
649  * @param p_segment18 Key flexfield segment.
650  * @param p_segment19 Key flexfield segment.
651  * @param p_segment20 Key flexfield segment.
652  * @param p_segment21 Key flexfield segment.
653  * @param p_segment22 Key flexfield segment.
654  * @param p_segment23 Key flexfield segment.
655  * @param p_segment24 Key flexfield segment.
656  * @param p_segment25 Key flexfield segment.
657  * @param p_segment26 Key flexfield segment.
658  * @param p_segment27 Key flexfield segment.
659  * @param p_segment28 Key flexfield segment.
660  * @param p_segment29 Key flexfield segment.
661  * @param p_segment30 Key flexfield segment.
662  * @param p_value_1 Input Value
663  * @param p_value_2 Input Value
664  * @param p_value_3 Input Value
665  * @param p_value_4 Input Value
666  * @param p_value_5 Input Value
667  * @param p_value_6 Input Value
668  * @param p_value_7 Input Value
669  * @param p_value_8 Input Value
670  * @param p_value_9 Input Value
671  * @param p_value_10 Input Value
672  * @param p_value_11 Input Value
673  * @param p_value_12 Input Value
674  * @param p_value_13 Input Value
675  * @param p_value_14 Input Value
676  * @param p_value_15 Input Value
677  * @param p_canonical_date_format (Y/N) To indicate whether the date format of
681  * @rep:displayname Update Batch Line
678  * the input values is in internal or display format.
679  * @param p_iv_all_internal_format (Y/N) Internal format for all input values.
680  * If set to 'Y' then it overrides the p_canonical_date_format flag.
682  * @rep:category BUSINESS_ENTITY PAY_BATCH_ELEMENT_ENTRY
683  * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
684  * @rep:scope public
685  * @rep:lifecycle active
686  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
687 */
688 --
689 -- {End Of Comments}
690 --
691 procedure update_batch_line
692   (p_validate                      in     boolean  default false
693   ,p_session_date                  in     date
694   ,p_batch_line_id                 in     number
695   ,p_batch_line_status             in     varchar2 default hr_api.g_varchar2
696   ,p_object_version_number         in out nocopy number
697   ,p_assignment_id                 in     number   default hr_api.g_number
698   ,p_assignment_number             in     varchar2 default hr_api.g_varchar2
699   ,p_attribute_category            in     varchar2 default hr_api.g_varchar2
700   ,p_attribute1                    in     varchar2 default hr_api.g_varchar2
701   ,p_attribute2                    in     varchar2 default hr_api.g_varchar2
702   ,p_attribute3                    in     varchar2 default hr_api.g_varchar2
703   ,p_attribute4                    in     varchar2 default hr_api.g_varchar2
704   ,p_attribute5                    in     varchar2 default hr_api.g_varchar2
705   ,p_attribute6                    in     varchar2 default hr_api.g_varchar2
706   ,p_attribute7                    in     varchar2 default hr_api.g_varchar2
707   ,p_attribute8                    in     varchar2 default hr_api.g_varchar2
708   ,p_attribute9                    in     varchar2 default hr_api.g_varchar2
709   ,p_attribute10                   in     varchar2 default hr_api.g_varchar2
710   ,p_attribute11                   in     varchar2 default hr_api.g_varchar2
711   ,p_attribute12                   in     varchar2 default hr_api.g_varchar2
712   ,p_attribute13                   in     varchar2 default hr_api.g_varchar2
713   ,p_attribute14                   in     varchar2 default hr_api.g_varchar2
714   ,p_attribute15                   in     varchar2 default hr_api.g_varchar2
715   ,p_attribute16                   in     varchar2 default hr_api.g_varchar2
716   ,p_attribute17                   in     varchar2 default hr_api.g_varchar2
717   ,p_attribute18                   in     varchar2 default hr_api.g_varchar2
718   ,p_attribute19                   in     varchar2 default hr_api.g_varchar2
719   ,p_attribute20                   in     varchar2 default hr_api.g_varchar2
720   ,p_entry_information_category    in     varchar2  default hr_api.g_varchar2
721   ,p_entry_information1            in     varchar2  default hr_api.g_varchar2
722   ,p_entry_information2            in     varchar2  default hr_api.g_varchar2
723   ,p_entry_information3            in     varchar2  default hr_api.g_varchar2
724   ,p_entry_information4            in     varchar2  default hr_api.g_varchar2
725   ,p_entry_information5            in     varchar2  default hr_api.g_varchar2
726   ,p_entry_information6            in     varchar2  default hr_api.g_varchar2
727   ,p_entry_information7            in     varchar2  default hr_api.g_varchar2
728   ,p_entry_information8            in     varchar2  default hr_api.g_varchar2
729   ,p_entry_information9            in     varchar2  default hr_api.g_varchar2
730   ,p_entry_information10           in     varchar2  default hr_api.g_varchar2
731   ,p_entry_information11           in     varchar2  default hr_api.g_varchar2
732   ,p_entry_information12           in     varchar2  default hr_api.g_varchar2
733   ,p_entry_information13           in     varchar2  default hr_api.g_varchar2
734   ,p_entry_information14           in     varchar2  default hr_api.g_varchar2
735   ,p_entry_information15           in     varchar2  default hr_api.g_varchar2
736   ,p_entry_information16           in     varchar2  default hr_api.g_varchar2
737   ,p_entry_information17           in     varchar2  default hr_api.g_varchar2
738   ,p_entry_information18           in     varchar2  default hr_api.g_varchar2
739   ,p_entry_information19           in     varchar2  default hr_api.g_varchar2
740   ,p_entry_information20           in     varchar2  default hr_api.g_varchar2
741   ,p_entry_information21           in     varchar2  default hr_api.g_varchar2
742   ,p_entry_information22           in     varchar2  default hr_api.g_varchar2
743   ,p_entry_information23           in     varchar2  default hr_api.g_varchar2
744   ,p_entry_information24           in     varchar2  default hr_api.g_varchar2
745   ,p_entry_information25           in     varchar2  default hr_api.g_varchar2
746   ,p_entry_information26           in     varchar2  default hr_api.g_varchar2
747   ,p_entry_information27           in     varchar2  default hr_api.g_varchar2
748   ,p_entry_information28           in     varchar2  default hr_api.g_varchar2
749   ,p_entry_information29           in     varchar2  default hr_api.g_varchar2
750   ,p_entry_information30           in     varchar2  default hr_api.g_varchar2
751   ,p_date_earned                   in     date      default hr_api.g_date
752   ,p_personal_payment_method_id    in     number    default hr_api.g_number
753   ,p_subpriority                   in     number    default hr_api.g_number
754   ,p_batch_sequence                in     number   default hr_api.g_number
755   ,p_concatenated_segments         in     varchar2 default hr_api.g_varchar2
756   ,p_cost_allocation_keyflex_id    in     number   default hr_api.g_number
757   ,p_effective_date                in     date     default hr_api.g_date
758   ,p_effective_start_date          in     date     default hr_api.g_date
759   ,p_effective_end_date            in     date     default hr_api.g_date
760   ,p_element_name                  in     varchar2 default hr_api.g_varchar2
761   ,p_element_type_id               in     number   default hr_api.g_number
762   ,p_entry_type                    in     varchar2 default hr_api.g_varchar2
766   ,p_segment3                      in     varchar2 default hr_api.g_varchar2
763   ,p_reason                        in     varchar2 default hr_api.g_varchar2
764   ,p_segment1                      in     varchar2 default hr_api.g_varchar2
765   ,p_segment2                      in     varchar2 default hr_api.g_varchar2
767   ,p_segment4                      in     varchar2 default hr_api.g_varchar2
768   ,p_segment5                      in     varchar2 default hr_api.g_varchar2
769   ,p_segment6                      in     varchar2 default hr_api.g_varchar2
770   ,p_segment7                      in     varchar2 default hr_api.g_varchar2
771   ,p_segment8                      in     varchar2 default hr_api.g_varchar2
772   ,p_segment9                      in     varchar2 default hr_api.g_varchar2
773   ,p_segment10                     in     varchar2 default hr_api.g_varchar2
774   ,p_segment11                     in     varchar2 default hr_api.g_varchar2
775   ,p_segment12                     in     varchar2 default hr_api.g_varchar2
776   ,p_segment13                     in     varchar2 default hr_api.g_varchar2
777   ,p_segment14                     in     varchar2 default hr_api.g_varchar2
778   ,p_segment15                     in     varchar2 default hr_api.g_varchar2
779   ,p_segment16                     in     varchar2 default hr_api.g_varchar2
780   ,p_segment17                     in     varchar2 default hr_api.g_varchar2
781   ,p_segment18                     in     varchar2 default hr_api.g_varchar2
782   ,p_segment19                     in     varchar2 default hr_api.g_varchar2
783   ,p_segment20                     in     varchar2 default hr_api.g_varchar2
784   ,p_segment21                     in     varchar2 default hr_api.g_varchar2
785   ,p_segment22                     in     varchar2 default hr_api.g_varchar2
786   ,p_segment23                     in     varchar2 default hr_api.g_varchar2
787   ,p_segment24                     in     varchar2 default hr_api.g_varchar2
788   ,p_segment25                     in     varchar2 default hr_api.g_varchar2
789   ,p_segment26                     in     varchar2 default hr_api.g_varchar2
790   ,p_segment27                     in     varchar2 default hr_api.g_varchar2
791   ,p_segment28                     in     varchar2 default hr_api.g_varchar2
792   ,p_segment29                     in     varchar2 default hr_api.g_varchar2
793   ,p_segment30                     in     varchar2 default hr_api.g_varchar2
794   ,p_value_1                       in     varchar2 default hr_api.g_varchar2
795   ,p_value_2                       in     varchar2 default hr_api.g_varchar2
796   ,p_value_3                       in     varchar2 default hr_api.g_varchar2
797   ,p_value_4                       in     varchar2 default hr_api.g_varchar2
798   ,p_value_5                       in     varchar2 default hr_api.g_varchar2
799   ,p_value_6                       in     varchar2 default hr_api.g_varchar2
800   ,p_value_7                       in     varchar2 default hr_api.g_varchar2
801   ,p_value_8                       in     varchar2 default hr_api.g_varchar2
802   ,p_value_9                       in     varchar2 default hr_api.g_varchar2
803   ,p_value_10                      in     varchar2 default hr_api.g_varchar2
804   ,p_value_11                      in     varchar2 default hr_api.g_varchar2
805   ,p_value_12                      in     varchar2 default hr_api.g_varchar2
806   ,p_value_13                      in     varchar2 default hr_api.g_varchar2
807   ,p_value_14                      in     varchar2 default hr_api.g_varchar2
808   ,p_value_15                      in     varchar2 default hr_api.g_varchar2
809   ,p_canonical_date_format         in     varchar2 default 'Y'
810   ,p_iv_all_internal_format        in     varchar2 default 'N'
811   );
812 --
813 -- ----------------------------------------------------------------------------
814 -- |----------------------------< update_batch_total >------------------------|
815 -- ----------------------------------------------------------------------------
816 --
817 -- {Start Of Comments}
818 /*#
819  * This API updates the batch control total information.
820  *
821  *
822  * <p><b>Licensing</b><br>
823  * This API is licensed for use with Human Resources.
824  *
825  * <p><b>Prerequisites</b><br>
826  * Batch Header.
827  *
828  * <p><b>Post Success</b><br>
829  * The batch control total will be successfully updated into the database.
830  *
831  * <p><b>Post Failure</b><br>
832  * The API does not update the batch control total and raises an error.
833  * @param p_validate If true, then validation alone will be performed and the
834  * database will remain unchanged. If false and all validation checks pass,
835  * then the database will be modified.
836  * @param p_session_date Applications effective date.
837  * @param p_batch_control_id Primary Key of the record.
838  * @param p_object_version_number Pass in the current version number of the
839  * batch control total to be updated. When the API completes if p_validate is
840  * false, will be set to the new version number of the updated batch control
841  * total. If p_validate is true will be set to the same value which was passed
842  * in.
843  * @param p_control_status Status of the batch control total.(BATCH_STATUS
844  * lookup type of HR_LOOKUPS)
845  * @param p_control_total Control total value.
846  * @param p_control_type Type of rows to be summed. (Lookup type of
847  * 'CONTROL_TYPE' within HR_LOOKUPS)
848  * @rep:displayname Update Batch Total
849  * @rep:category BUSINESS_ENTITY PAY_BATCH_ELEMENT_ENTRY
850  * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
851  * @rep:scope public
852  * @rep:lifecycle active
853  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
854 */
855 --
856 -- {End Of Comments}
857 --
858 procedure update_batch_total
859   (p_validate                      in     boolean  default false
860   ,p_session_date                  in     date
861   ,p_batch_control_id              in     number
865   ,p_control_type                  in     varchar2 default hr_api.g_varchar2
862   ,p_object_version_number         in out nocopy number
863   ,p_control_status                in     varchar2 default hr_api.g_varchar2
864   ,p_control_total                 in     varchar2 default hr_api.g_varchar2
866   );
867 --
868 -- ----------------------------------------------------------------------------
869 -- |---------------------------< delete_batch_header >------------------------|
870 -- ----------------------------------------------------------------------------
871 --
872 -- {Start Of Comments}
873 /*#
874  * This API deletes the batch header.
875  *
876  *
877  * <p><b>Licensing</b><br>
878  * This API is licensed for use with Human Resources.
879  *
880  * <p><b>Prerequisites</b><br>
881  * The batch should exists.
882  *
883  * <p><b>Post Success</b><br>
884  * The batch header will be successfully deleted from the database.
885  *
886  * <p><b>Post Failure</b><br>
887  * The API does not delete the batch header and raises an error.
888  * @param p_validate If true, then validation alone will be performed and the
889  * database will remain unchanged. If false and all validation checks pass,
890  * then the database will be modified.
891  * @param p_batch_id Primary Key of the record.
892  * @param p_object_version_number Pass in the current version number of the
893  * batch header to be deleted. When the API completes if p_validate is false,
894  * will be set to the new version number of the deleted batch header. If
895  * p_validate is true will be set to the same value which was passed in.
896  * @rep:displayname Delete Batch Header
897  * @rep:category BUSINESS_ENTITY PAY_BATCH_ELEMENT_ENTRY
898  * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
899  * @rep:scope public
900  * @rep:lifecycle active
901  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
902 */
903 --
904 -- {End Of Comments}
905 --
906 procedure delete_batch_header
907   (p_validate                      in     boolean  default false
908   ,p_batch_id                      in     number
909   ,p_object_version_number         in     number
910   );
911 --
912 -- ----------------------------------------------------------------------------
913 -- |----------------------------< delete_batch_line >-------------------------|
914 -- ----------------------------------------------------------------------------
915 --
916 -- {Start Of Comments}
917 /*#
918  * This API deletes the batch line.
919  *
920  *
921  * <p><b>Licensing</b><br>
922  * This API is licensed for use with Human Resources.
923  *
924  * <p><b>Prerequisites</b><br>
925  * A Batch Header.
926  *
927  * <p><b>Post Success</b><br>
928  * The batch line will be successfully deleted from the database.
929  *
930  * <p><b>Post Failure</b><br>
931  * The API does not delete the batch line and raises an error.
932  * @param p_validate If true, then validation alone will be performed and the
933  * database will remain unchanged. If false and all validation checks pass,
934  * then the database will be modified.
935  * @param p_batch_line_id Primary Key of the record.
936  * @param p_object_version_number Pass in the current version number of the
937  * batch line to be deleted. When the API completes if p_validate is false,
938  * will be set to the new version number of the deleted batch line. If
939  * p_validate is true will be set to the same value which was passed in.
940  * @rep:displayname Delete Batch Line
941  * @rep:category BUSINESS_ENTITY PAY_BATCH_ELEMENT_ENTRY
942  * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
943  * @rep:scope public
944  * @rep:lifecycle active
945  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
946 */
947 --
948 -- {End Of Comments}
949 --
950 procedure delete_batch_line
951   (p_validate                      in     boolean  default false
952   ,p_batch_line_id                 in     number
953   ,p_object_version_number         in     number
954   );
955 --
956 -- ----------------------------------------------------------------------------
957 -- |----------------------------< delete_batch_total >------------------------|
958 -- ----------------------------------------------------------------------------
959 --
960 -- {Start Of Comments}
961 /*#
962  * This API deletes the batch control total.
963  *
964  *
965  * <p><b>Licensing</b><br>
966  * This API is licensed for use with Human Resources.
967  *
968  * <p><b>Prerequisites</b><br>
969  * Batch Header.
970  *
971  * <p><b>Post Success</b><br>
972  * The batch control total will be successfully deleted from the database.
973  *
974  * <p><b>Post Failure</b><br>
975  * The API does not delete the batch control total and raises an error.
976  * @param p_validate If true, then validation alone will be performed and the
977  * database will remain unchanged. If false and all validation checks pass,
978  * then the database will be modified.
979  * @param p_batch_control_id Primary Key of the record.
980  * @param p_object_version_number Pass in the current version number of the
981  * batch control total to be deleted. When the API completes if p_validate is
982  * false, will be set to the new version number of the deleted batch control
983  * total. If p_validate is true will be set to the same value which was passed
984  * in.
985  * @rep:displayname Delete Batch Total
986  * @rep:category BUSINESS_ENTITY PAY_BATCH_ELEMENT_ENTRY
987  * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
988  * @rep:scope public
989  * @rep:lifecycle active
990  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
991 */
992 --
993 -- {End Of Comments}
994 --
995 procedure delete_batch_total
996   (p_validate                      in     boolean  default false
997   ,p_batch_control_id              in     number
998   ,p_object_version_number         in     number
999   );
1000 --
1001 end PAY_BATCH_ELEMENT_ENTRY_API;