1 package pay_bal_adjust as
2 /* $Header: pybaladj.pkh 120.0.12010000.1 2008/07/27 22:07:57 appldev ship $ */
3 /*
4 Notes:
5 o This package defines the public interface to the batch
6 balance adjustment process.
7 o See the notes for the individual procedures and functions
8 below for calling details. However the overall
9 calling sequence is:
10
11 - init_batch
12 - (many calls of) adjust_balance
13 - process_batch
14 */
15
16 --------------------------------- init_batch ----------------------------------
17 /*
18 NAME
19 init_batch
20 DESCRIPTION
21 Initialises batch load.
22 NOTES
23 Must be called before any calls to adjust_balance procedure
24 are made.
25
26 This function returns a batch_id value that should be passed
27 to subsequent procedures as p_batch_id.
28
29 The consolidation_set_id and payroll_id are required as the entire
30 batch has to be processed with the same values.
31
32 The p_batch_mode parameter must be called with either
33 STANDARD (the default) - a commit will occur on calling process_batch.
34 NO_COMMIT - no commit will occur on calling process_batch.
35 */
36
37 function init_batch
38 (
39 p_batch_name in varchar2 default null,
40 p_effective_date in date,
41 p_consolidation_set_id in number,
42 p_payroll_id in number,
43 p_action_type in varchar2 default 'B', -- for balance adjustment.
44 p_batch_mode in varchar2 default 'STANDARD',
45 p_prepay_flag in varchar2 default 'Y'
46 ) return number;
47
48 ------------------------------- adjust_balance --------------------------------
49 /*
50 NAME
51 adjust_balance
52 DESCRIPTION
53 Performs the Balance Adjustment.
54 NOTES
55 If you want to call this procedure, please bear in mind:
56 o The procedure assumes that the assignment is assigned to a
57 Payroll.
58 o The p_batch_id parameter is that obtained from the
59 init_batch procedure.
60 o The actual balance adjustment is performed by the
61 process_batch procedure, not this one.
62 o The columns required for the costing of balance adjustments
63 are provided on the interface.
64 o This procedure does not perform commits.
65 */
66
67 procedure adjust_balance
68 (
69 p_batch_id in number,
70 p_assignment_id in number,
71 p_element_link_id in number,
72 --
73 -- Element Entry Values Table
74 --
75 p_num_entry_values IN number,
76 p_input_value_id_tbl IN hr_entry.number_table,
77 p_entry_value_tbl IN hr_entry.varchar2_table,
78
79 -- Costing information.
80 p_balance_adj_cost_flag in varchar2 default null,
81 p_cost_allocation_keyflex_id in number default null,
82 p_attribute_category in varchar2 default null,
83 p_attribute1 in varchar2 default null,
84 p_attribute2 in varchar2 default null,
85 p_attribute3 in varchar2 default null,
86 p_attribute4 in varchar2 default null,
87 p_attribute5 in varchar2 default null,
88 p_attribute6 in varchar2 default null,
89 p_attribute7 in varchar2 default null,
90 p_attribute8 in varchar2 default null,
91 p_attribute9 in varchar2 default null,
92 p_attribute10 in varchar2 default null,
93 p_attribute11 in varchar2 default null,
94 p_attribute12 in varchar2 default null,
95 p_attribute13 in varchar2 default null,
96 p_attribute14 in varchar2 default null,
97 p_attribute15 in varchar2 default null,
98 p_attribute16 in varchar2 default null,
99 p_attribute17 in varchar2 default null,
100 p_attribute18 in varchar2 default null,
101 p_attribute19 in varchar2 default null,
102 p_attribute20 in varchar2 default null,
103 p_run_type_id in number default null,
104 p_original_entry_id in number default null,
105 p_tax_unit_id in number default null,
106 p_purge_mode in boolean default false
107 );
108
109
110 procedure adjust_balance
111 (
112 p_batch_id in number,
113 p_assignment_id in number,
114 p_element_link_id in number,
115 p_input_value_id1 in number default null,
116 p_input_value_id2 in number default null,
117 p_input_value_id3 in number default null,
118 p_input_value_id4 in number default null,
119 p_input_value_id5 in number default null,
120 p_input_value_id6 in number default null,
121 p_input_value_id7 in number default null,
122 p_input_value_id8 in number default null,
123 p_input_value_id9 in number default null,
124 p_input_value_id10 in number default null,
125 p_input_value_id11 in number default null,
126 p_input_value_id12 in number default null,
127 p_input_value_id13 in number default null,
128 p_input_value_id14 in number default null,
129 p_input_value_id15 in number default null,
130 p_entry_value1 in varchar2 default null,
131 p_entry_value2 in varchar2 default null,
132 p_entry_value3 in varchar2 default null,
133 p_entry_value4 in varchar2 default null,
134 p_entry_value5 in varchar2 default null,
135 p_entry_value6 in varchar2 default null,
136 p_entry_value7 in varchar2 default null,
137 p_entry_value8 in varchar2 default null,
138 p_entry_value9 in varchar2 default null,
139 p_entry_value10 in varchar2 default null,
140 p_entry_value11 in varchar2 default null,
141 p_entry_value12 in varchar2 default null,
142 p_entry_value13 in varchar2 default null,
143 p_entry_value14 in varchar2 default null,
144 p_entry_value15 in varchar2 default null,
145
146 -- Costing information.
147 p_balance_adj_cost_flag in varchar2 default null,
148 p_cost_allocation_keyflex_id in number default null,
149 p_attribute_category in varchar2 default null,
150 p_attribute1 in varchar2 default null,
151 p_attribute2 in varchar2 default null,
152 p_attribute3 in varchar2 default null,
153 p_attribute4 in varchar2 default null,
154 p_attribute5 in varchar2 default null,
155 p_attribute6 in varchar2 default null,
156 p_attribute7 in varchar2 default null,
157 p_attribute8 in varchar2 default null,
158 p_attribute9 in varchar2 default null,
159 p_attribute10 in varchar2 default null,
160 p_attribute11 in varchar2 default null,
161 p_attribute12 in varchar2 default null,
162 p_attribute13 in varchar2 default null,
163 p_attribute14 in varchar2 default null,
164 p_attribute15 in varchar2 default null,
165 p_attribute16 in varchar2 default null,
166 p_attribute17 in varchar2 default null,
167 p_attribute18 in varchar2 default null,
168 p_attribute19 in varchar2 default null,
169 p_attribute20 in varchar2 default null,
170 p_run_type_id in number default null,
171 p_original_entry_id in number default null,
172 p_tax_unit_id in number default null,
173 p_purge_mode in boolean default false
174 );
175
176 -------------------------------- process_batch --------------------------------
177 /*
178 NAME
179 process_batch
180 DESCRIPTION
181 Processes the batch as set up in earlier calls.
182 NOTES
183 This procedure processes the batch of balance adjustments.
184 The batch_id is as obtained from the batch initialisation call
185 and passed to the adjustment procedure itself.
186
187 NOTE: this procedure a commits if init_batch was called with
188 STANDARD mode (i.e. the default).
189 */
190
191 procedure process_batch
192 (
193 p_batch_id in number
194 );
195
196 procedure rerun_batch
197 (
198 p_batch_id in number,
199 p_busgrpid in number,
200 p_effdate in date,
201 p_legcode in varchar2,
202 p_assignment_action_id in number
203
204 );
205
206 procedure process_bal_adj
207 (
208 p_ele_type in number,
209 p_busgrpid in number,
210 p_effdate in date,
211 p_legcode in varchar2,
212 p_assignment_action_id in number,
213 p_assignment_id in number,
214 p_balcostflg in varchar2,
215 p_costkflx_id in number
216
217 );
218
219
220
221 end pay_bal_adjust;