1 package pay_balance_adjustment_api AUTHID CURRENT_USER as
2 /* $Header: pybadapi.pkh 120.1 2005/10/02 02:29:26 aroussel $ */
3 /*#
4 * This package contains the Balance Adjustment API.
5 * @rep:scope public
6 * @rep:product pay
7 * @rep:displayname Balance Adjustment
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |----------------------------< create_adjustment >-------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API performs a balance adjustment.
17 *
18 * This API creates a balance adjustment payroll action, assignment action,
19 * element entry and run results.
20 *
21 * <p><b>Licensing</b><br>
22 * This API is licensed for use with Payroll.
23 *
24 * <p><b>Prerequisites</b><br>
25 * Relevant element type and link should be defined.
26 *
27 * <p><b>Post Success</b><br>
28 * Balance adjustment action and run results will have been created.
29 *
30 * <p><b>Post Failure</b><br>
31 * The assignment action of payroll action will have been set to an error
32 * status , and messages created.
33 * @param p_validate If true, then validation alone will be performed and the
34 * database will remain unchanged. If false and all validation checks pass,
35 * then the database will be modified.
36 * @param p_effective_date Determines when the DateTrack operation comes into
37 * force.
38 * @param p_assignment_id {@rep:casecolumn PER_ALL_ASSIGNMENTS_F.ASSIGNMENT_ID}
39 * @param p_consolidation_set_id consolidation set identifier for this balance
40 * adjustment
41 * @param p_element_link_id Element Link identifier for of entry to be created
42 * @param p_input_value_id1 Identifier of Input value for the element for this
43 * balance adjustment
44 * @param p_input_value_id2 Identifier of Input value for the element for this
45 * balance adjustment
46 * @param p_input_value_id3 Identifier of Input value for the element for this
47 * balance adjustment
48 * @param p_input_value_id4 Identifier of Input value for the element for this
49 * balance adjustment
50 * @param p_input_value_id5 Identifier of Input value for the element for this
51 * balance adjustment
52 * @param p_input_value_id6 Identifier of Input value for the element for this
53 * balance adjustment
54 * @param p_input_value_id7 Identifier of Input value for the element for this
55 * balance adjustment
56 * @param p_input_value_id8 Identifier of Input value for the element for this
57 * balance adjustment
58 * @param p_input_value_id9 Identifier of Input value for the element for this
59 * balance adjustment
60 * @param p_input_value_id10 Identifier of Input value for the element for this
61 * balance adjustment
62 * @param p_input_value_id11 Identifier of Input value for the element for this
63 * balance adjustment
64 * @param p_input_value_id12 Identifier of Input value for the element for this
65 * balance adjustment
66 * @param p_input_value_id13 Identifier of Input value for the element for this
67 * balance adjustment
68 * @param p_input_value_id14 Identifier of Input value for the element for this
69 * balance adjustment
70 * @param p_input_value_id15 Identifier of Input value for the element for this
71 * balance adjustment
72 * @param p_entry_value1 Value of element entry for this balance adjustment
73 * @param p_entry_value2 Value of element entry for this balance adjustment
74 * @param p_entry_value3 Value of element entry for this balance adjustment
75 * @param p_entry_value4 Value of element entry for this balance adjustment
76 * @param p_entry_value5 Value of element entry for this balance adjustment
77 * @param p_entry_value6 Value of element entry for this balance adjustment
78 * @param p_entry_value7 Value of element entry for this balance adjustment
79 * @param p_entry_value8 Value of element entry for this balance adjustment
80 * @param p_entry_value9 Value of element entry for this balance adjustment
81 * @param p_entry_value10 Value of element entry for this balance adjustment
82 * @param p_entry_value11 Value of element entry for this balance adjustment
83 * @param p_entry_value12 Value of element entry for this balance adjustment
84 * @param p_entry_value13 Value of element entry for this balance adjustment
85 * @param p_entry_value14 Value of element entry for this balance adjustment
86 * @param p_entry_value15 Value of element entry for this balance adjustment
87 * @param p_prepay_flag Flag to indicate if values should be used for
88 * prepayments
89 * @param p_balance_adj_cost_flag Indicate whether this balance adjustment
90 * should be costed.
91 * @param p_cost_allocation_keyflex_id Costing key flexfield identifier to be
92 * stamped on the element entry created.
93 * @param p_attribute_category This context value determines which flexfield
94 * structure to use with the descriptive flexfield segments.
95 * @param p_attribute1 Descriptive flexfield segment.
96 * @param p_attribute2 Descriptive flexfield segment.
97 * @param p_attribute3 Descriptive flexfield segment.
98 * @param p_attribute4 Descriptive flexfield segment.
99 * @param p_attribute5 Descriptive flexfield segment.
100 * @param p_attribute6 Descriptive flexfield segment.
101 * @param p_attribute7 Descriptive flexfield segment.
102 * @param p_attribute8 Descriptive flexfield segment.
103 * @param p_attribute9 Descriptive flexfield segment.
104 * @param p_attribute10 Descriptive flexfield segment.
105 * @param p_attribute11 Descriptive flexfield segment.
106 * @param p_attribute12 Descriptive flexfield segment.
107 * @param p_attribute13 Descriptive flexfield segment.
108 * @param p_attribute14 Descriptive flexfield segment.
109 * @param p_attribute15 Descriptive flexfield segment.
110 * @param p_attribute16 Descriptive flexfield segment.
111 * @param p_attribute17 Descriptive flexfield segment.
112 * @param p_attribute18 Descriptive flexfield segment.
113 * @param p_attribute19 Descriptive flexfield segment.
114 * @param p_attribute20 Descriptive flexfield segment.
115 * @param p_element_entry_id Element entry identifier for element entry created
116 * by balance adjustment.
117 * @param p_effective_start_date If p_validate is false, then set to the
118 * earliest effective start date for the related element entry. If p_validate
119 * is true, then set to null.
120 * @param p_effective_end_date If p_validate is false, then set to the
121 * effective end date for the created element entry . If p_validate is true,
122 * then set to null.
123 * @param p_object_version_number If p_validate is false, then set to the
124 * version number of the created element entry. If p_validate is true, then the
125 * value will be null.
126 * @param p_create_warning Value returned if element entry creation created a
127 * warning
128 * @param p_run_type_id Run type identifier to be stamped on payroll action
129 * @param p_original_entry_id New parameter, available on the latest version of
130 * this API.
131 * @rep:displayname Create Adjustment
132 * @rep:category BUSINESS_ENTITY PAY_BALANCE_ADJUSTMENT
133 * @rep:scope public
134 * @rep:lifecycle active
135 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
136 */
137 --
138 -- {End Of Comments}
139 --
140 procedure create_adjustment
141 (
142 p_validate in boolean default false,
143 p_effective_date in date,
144 p_assignment_id in number,
145 p_consolidation_set_id in number,
146 p_element_link_id in number,
147 p_input_value_id1 in number default null,
148 p_input_value_id2 in number default null,
149 p_input_value_id3 in number default null,
150 p_input_value_id4 in number default null,
151 p_input_value_id5 in number default null,
152 p_input_value_id6 in number default null,
153 p_input_value_id7 in number default null,
154 p_input_value_id8 in number default null,
155 p_input_value_id9 in number default null,
156 p_input_value_id10 in number default null,
157 p_input_value_id11 in number default null,
158 p_input_value_id12 in number default null,
159 p_input_value_id13 in number default null,
160 p_input_value_id14 in number default null,
161 p_input_value_id15 in number default null,
162 p_entry_value1 in varchar2 default null,
163 p_entry_value2 in varchar2 default null,
164 p_entry_value3 in varchar2 default null,
165 p_entry_value4 in varchar2 default null,
166 p_entry_value5 in varchar2 default null,
167 p_entry_value6 in varchar2 default null,
168 p_entry_value7 in varchar2 default null,
169 p_entry_value8 in varchar2 default null,
170 p_entry_value9 in varchar2 default null,
171 p_entry_value10 in varchar2 default null,
172 p_entry_value11 in varchar2 default null,
173 p_entry_value12 in varchar2 default null,
174 p_entry_value13 in varchar2 default null,
175 p_entry_value14 in varchar2 default null,
176 p_entry_value15 in varchar2 default null,
177 p_prepay_flag in varchar2 default null,
178
179 -- Costing information.
180 p_balance_adj_cost_flag in varchar2 default null,
181 p_cost_allocation_keyflex_id in number default null,
182 p_attribute_category in varchar2 default null,
183 p_attribute1 in varchar2 default null,
184 p_attribute2 in varchar2 default null,
185 p_attribute3 in varchar2 default null,
186 p_attribute4 in varchar2 default null,
187 p_attribute5 in varchar2 default null,
188 p_attribute6 in varchar2 default null,
189 p_attribute7 in varchar2 default null,
190 p_attribute8 in varchar2 default null,
191 p_attribute9 in varchar2 default null,
192 p_attribute10 in varchar2 default null,
193 p_attribute11 in varchar2 default null,
194 p_attribute12 in varchar2 default null,
195 p_attribute13 in varchar2 default null,
196 p_attribute14 in varchar2 default null,
197 p_attribute15 in varchar2 default null,
198 p_attribute16 in varchar2 default null,
199 p_attribute17 in varchar2 default null,
200 p_attribute18 in varchar2 default null,
201 p_attribute19 in varchar2 default null,
202 p_attribute20 in varchar2 default null,
203
204 p_run_type_id in number default null,
205 p_original_entry_id in number default null,
206
207 -- Element entry information.
208 p_element_entry_id out nocopy number,
209 p_effective_start_date out nocopy date,
210 p_effective_end_date out nocopy date,
211 p_object_version_number out nocopy number,
212 p_create_warning out nocopy boolean
213 );
214 --
215 -- ----------------------------------------------------------------------------
216 -- |----------------------------< delete_adjustment >-------------------------|
217 -- ----------------------------------------------------------------------------
218 --
219 -- {Start Of Comments}
220 /*#
221 * This API performs a balance adjustment.
222 *
223 * Removes the results created by the payroll action.
224 *
225 * <p><b>Licensing</b><br>
226 * This API is licensed for use with Payroll.
227 *
228 * <p><b>Prerequisites</b><br>
229 * Balance adjustment must be valid for deletion.
230 *
231 * <p><b>Post Success</b><br>
232 * Action will have been removed from database.
233 *
234 * <p><b>Post Failure</b><br>
235 * An error will be raised and the adjustment will not be deleted.
236 * @param p_validate If true, then validation alone will be performed and the
237 * database will remain unchanged. If false and all validation checks pass,
238 * then the database will be modified.
239 * @param p_effective_date Determines when the DateTrack operation comes into
240 * force.
241 * @param p_element_entry_id Element entry identifier associated with balance
242 * adjustment that is to be deleted
243 * @rep:displayname Delete Adjustment
244 * @rep:category BUSINESS_ENTITY PAY_BALANCE_ADJUSTMENT
245 * @rep:scope public
246 * @rep:lifecycle active
247 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
248 */
249 --
250 -- {End Of Comments}
251 --
252 procedure delete_adjustment
253 (
254 p_validate in boolean default false,
255 p_effective_date in date,
256 p_element_entry_id in number
257 );
258
259 end pay_balance_adjustment_api;
[Home] [Help]