1 Package pay_action_information_api as
2 /* $Header: pyaifapi.pkh 120.1 2005/10/02 02:29:11 aroussel $ */
3 /*#
4 * This package contains action information APIs.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Action Information
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |------------------------< create_action_information >---------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates action information records.
17 *
18 * The records are created when the archive process calls this API to archive
19 * assignment actions. The actions archived usually are prepayment actions,
20 * quick pay prepayment actions, reversals or those balance adjustment actions
21 * that get prepaid. The actions could be a subset of those mentioned above for
22 * certain legislations.
23 *
24 * <p><b>Licensing</b><br>
25 * This API is licensed for use with Human Resources.
26 *
27 * <p><b>Prerequisites</b><br>
28 * Records are created only if the assignment has undergone either a
29 * prepayment, a quick payprepayment, reversal or a balance adjustment that
30 * subsequently was prepaid. Legislation specific rules might apply here.
31 *
32 * <p><b>Post Success</b><br>
33 * The API creates action information records
34 *
35 * <p><b>Post Failure</b><br>
36 * The API does not insert the action information and raises an error.
37 * @param p_validate If true, then validation alone will be performed and the
38 * database will remain unchanged. If false and all validation checks pass,
39 * then the database will be modified.
40 * @param p_action_context_id payroll_action_id or assignment_action_id
41 * depending upon context type.
42 * @param p_action_context_type context type of PA, AAC and AAP indicate
43 * Payroll Action, Assignment Action Creation and Assignment Action Processing
44 * respectively.
45 * @param p_action_information_category The action information category maps to
46 * a context code in Action Information DF.
47 * @param p_tax_unit_id {@rep:casecolumn PAY_ASSIGNMENT_ACTIONS.TAX_UNIT_ID}
48 * @param p_jurisdiction_code This is defined as a context in FF_CONTEXTS. The
49 * value of this context for the assignment is stored here.
50 * @param p_source_id This is defined as a context in FF_CONTEXTS. The value of
51 * this context for the assignment is stored here.
52 * @param p_source_text This is defined as a context in FF_CONTEXTS. The value
53 * of this context for the assignment is stored here.
54 * @param p_tax_group This is defined as a context in FF_CONTEXTS. The value of
55 * this context for the assignment is stored here.
56 * @param p_effective_date Effective date of the contributing action
57 * @param p_assignment_id Identifies the assignment for which you create the
58 * action information record.
59 * @param p_action_information1 This column maps to a segment on Action
60 * Information DF for a given action information category.
61 * @param p_action_information2 This column maps to a segment on Action
62 * Information DF for a given action information category.
63 * @param p_action_information3 This column maps to a segment on Action
64 * Information DF for a given action information category.
65 * @param p_action_information4 This column maps to a segment on Action
66 * Information DF for a given action information category.
67 * @param p_action_information5 This column maps to a segment on Action
68 * Information DF for a given action information category.
69 * @param p_action_information6 This column maps to a segment on Action
70 * Information DF for a given action information category.
71 * @param p_action_information7 This column maps to a segment on Action
72 * Information DF for a given action information category.
73 * @param p_action_information8 This column maps to a segment on Action
74 * Information DF for a given action information category.
75 * @param p_action_information9 This column maps to a segment on Action
76 * Information DF for a given action information category.
77 * @param p_action_information10 This column maps to a segment on Action
78 * Information DF for a given action information category.
79 * @param p_action_information11 This column maps to a segment on Action
80 * Information DF for a given action information category.
81 * @param p_action_information12 This column maps to a segment on Action
82 * Information DF for a given action information category.
83 * @param p_action_information13 This column maps to a segment on Action
84 * Information DF for a given action information category.
85 * @param p_action_information14 This column maps to a segment on Action
86 * Information DF for a given action information category.
87 * @param p_action_information15 This column maps to a segment on Action
88 * Information DF for a given action information category.
89 * @param p_action_information16 This column maps to a segment on Action
90 * Information DF for a given action information category.
91 * @param p_action_information17 This column maps to a segment on Action
92 * Information DF for a given action information category.
93 * @param p_action_information18 This column maps to a segment on Action
94 * Information DF for a given action information category.
95 * @param p_action_information19 This column maps to a segment on Action
96 * Information DF for a given action information category.
97 * @param p_action_information20 This column maps to a segment on Action
98 * Information DF for a given action information category.
99 * @param p_action_information21 This column maps to a segment on Action
100 * Information DF for a given action information category.
101 * @param p_action_information22 This column maps to a segment on Action
102 * Information DF for a given action information category.
103 * @param p_action_information23 This column maps to a segment on Action
104 * Information DF for a given action information category.
105 * @param p_action_information24 This column maps to a segment on Action
106 * Information DF for a given action information category.
107 * @param p_action_information25 This column maps to a segment on Action
108 * Information DF for a given action information category.
109 * @param p_action_information26 This column maps to a segment on Action
110 * Information DF for a given action information category.
111 * @param p_action_information27 This column maps to a segment on Action
112 * Information DF for a given action information category.
113 * @param p_action_information28 This column maps to a segment on Action
114 * Information DF for a given action information category.
115 * @param p_action_information29 This column maps to a segment on Action
116 * Information DF for a given action information category.
117 * @param p_action_information30 This column maps to a segment on Action
118 * Information DF for a given action information category.
119 * @param p_action_information_id PK of record
120 * @param p_object_version_number If p_validate is false, then set to the
121 * version number of the created action information record. If p_validate is
122 * true, then the value will be null.
123 * @rep:displayname Create Action Information
124 * @rep:category BUSINESS_ENTITY PAY_PAYMENT_ARCHIVE
125 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
126 * @rep:scope public
127 * @rep:lifecycle active
128 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
129 */
130 --
131 -- {End Of Comments}
132 --
133 procedure create_action_information
134 (
135 p_validate in boolean default false
136 ,p_action_context_id in number
137 ,p_action_context_type in varchar2
138 ,p_action_information_category in varchar2
139 ,p_tax_unit_id in number default null
140 ,p_jurisdiction_code in varchar2 default null
141 ,p_source_id in number default null
142 ,p_source_text in varchar2 default null
143 ,p_tax_group in varchar2 default null
144 ,p_effective_date in date default null
145 ,p_assignment_id in number default null
146 ,p_action_information1 in varchar2 default null
147 ,p_action_information2 in varchar2 default null
148 ,p_action_information3 in varchar2 default null
149 ,p_action_information4 in varchar2 default null
150 ,p_action_information5 in varchar2 default null
151 ,p_action_information6 in varchar2 default null
152 ,p_action_information7 in varchar2 default null
153 ,p_action_information8 in varchar2 default null
154 ,p_action_information9 in varchar2 default null
155 ,p_action_information10 in varchar2 default null
156 ,p_action_information11 in varchar2 default null
157 ,p_action_information12 in varchar2 default null
158 ,p_action_information13 in varchar2 default null
159 ,p_action_information14 in varchar2 default null
160 ,p_action_information15 in varchar2 default null
161 ,p_action_information16 in varchar2 default null
162 ,p_action_information17 in varchar2 default null
163 ,p_action_information18 in varchar2 default null
164 ,p_action_information19 in varchar2 default null
165 ,p_action_information20 in varchar2 default null
166 ,p_action_information21 in varchar2 default null
167 ,p_action_information22 in varchar2 default null
168 ,p_action_information23 in varchar2 default null
169 ,p_action_information24 in varchar2 default null
170 ,p_action_information25 in varchar2 default null
171 ,p_action_information26 in varchar2 default null
172 ,p_action_information27 in varchar2 default null
173 ,p_action_information28 in varchar2 default null
174 ,p_action_information29 in varchar2 default null
175 ,p_action_information30 in varchar2 default null
176 ,p_action_information_id out nocopy number
177 ,p_object_version_number out nocopy number
178 );
179 --
180 -- ----------------------------------------------------------------------------
181 -- |------------------------< update_action_information >---------------------|
182 -- ----------------------------------------------------------------------------
183 --
184 -- {Start Of Comments}
185 /*#
186 * This API updates action information records.
187 *
188 * API to update action information.
189 *
190 * <p><b>Licensing</b><br>
191 * This API is licensed for use with Human Resources.
192 *
193 * <p><b>Prerequisites</b><br>
194 * Record can only be updated if they exist.
195 *
196 * <p><b>Post Success</b><br>
197 * The API updates the action information records.
198 *
199 * <p><b>Post Failure</b><br>
200 * The API does not update the action information records and raises an error.
201 * @param p_validate If true, then validation alone will be performed and the
202 * database will remain unchanged. If false and all validation checks pass,
203 * then the database will be modified.
204 * @param p_action_information_id PK of record
205 * @param p_object_version_number Pass in the current version number of the
206 * action information to be updated. When the API completes if p_validate is
207 * false, will be set to the new version number of the updated
208 * action_information. If p_validate is true will be set to the same value
209 * which was passed in.
210 * @param p_action_information1 This column maps to a segment on Action
211 * Information DF for a given action information category.
212 * @param p_action_information2 This column maps to a segment on Action
213 * Information DF for a given action information category.
214 * @param p_action_information3 This column maps to a segment on Action
215 * Information DF for a given action information category.
216 * @param p_action_information4 This column maps to a segment on Action
217 * Information DF for a given action information category.
218 * @param p_action_information5 This column maps to a segment on Action
219 * Information DF for a given action information category.
220 * @param p_action_information6 This column maps to a segment on Action
221 * Information DF for a given action information category.
222 * @param p_action_information7 This column maps to a segment on Action
223 * Information DF for a given action information category.
224 * @param p_action_information8 This column maps to a segment on Action
225 * Information DF for a given action information category.
226 * @param p_action_information9 This column maps to a segment on Action
227 * Information DF for a given action information category.
228 * @param p_action_information10 This column maps to a segment on Action
229 * Information DF for a given action information category.
230 * @param p_action_information11 This column maps to a segment on Action
231 * Information DF for a given action information category.
232 * @param p_action_information12 This column maps to a segment on Action
233 * Information DF for a given action information category.
234 * @param p_action_information13 This column maps to a segment on Action
235 * Information DF for a given action information category.
236 * @param p_action_information14 This column maps to a segment on Action
237 * Information DF for a given action information category.
238 * @param p_action_information15 This column maps to a segment on Action
239 * Information DF for a given action information category.
240 * @param p_action_information16 This column maps to a segment on Action
241 * Information DF for a given action information category.
242 * @param p_action_information17 This column maps to a segment on Action
243 * Information DF for a given action information category.
244 * @param p_action_information18 This column maps to a segment on Action
245 * Information DF for a given action information category.
246 * @param p_action_information19 This column maps to a segment on Action
247 * Information DF for a given action information category.
248 * @param p_action_information20 This column maps to a segment on Action
249 * Information DF for a given action information category.
250 * @param p_action_information21 This column maps to a segment on Action
251 * Information DF for a given action information category.
252 * @param p_action_information22 This column maps to a segment on Action
253 * Information DF for a given action information category.
254 * @param p_action_information23 This column maps to a segment on Action
255 * Information DF for a given action information category.
256 * @param p_action_information24 This column maps to a segment on Action
257 * Information DF for a given action information category.
258 * @param p_action_information25 This column maps to a segment on Action
259 * Information DF for a given action information category.
260 * @param p_action_information26 This column maps to a segment on Action
261 * Information DF for a given action information category.
262 * @param p_action_information27 This column maps to a segment on Action
263 * Information DF for a given action information category.
264 * @param p_action_information28 This column maps to a segment on Action
265 * Information DF for a given action information category.
266 * @param p_action_information29 This column maps to a segment on Action
267 * Information DF for a given action information category.
268 * @param p_action_information30 This column maps to a segment on Action
269 * Information DF for a given action information category.
270 * @rep:displayname Update Action Information
271 * @rep:category BUSINESS_ENTITY PAY_PAYMENT_ARCHIVE
272 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
273 * @rep:scope public
274 * @rep:lifecycle active
275 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
276 */
277 --
278 -- {End Of Comments}
279 --
280 procedure update_action_information
281 (
282 p_validate in boolean default false
283 ,p_action_information_id in number
284 ,p_object_version_number in out nocopy number
285 ,p_action_information1 in varchar2 default hr_api.g_varchar2
286 ,p_action_information2 in varchar2 default hr_api.g_varchar2
287 ,p_action_information3 in varchar2 default hr_api.g_varchar2
288 ,p_action_information4 in varchar2 default hr_api.g_varchar2
289 ,p_action_information5 in varchar2 default hr_api.g_varchar2
290 ,p_action_information6 in varchar2 default hr_api.g_varchar2
291 ,p_action_information7 in varchar2 default hr_api.g_varchar2
292 ,p_action_information8 in varchar2 default hr_api.g_varchar2
293 ,p_action_information9 in varchar2 default hr_api.g_varchar2
294 ,p_action_information10 in varchar2 default hr_api.g_varchar2
295 ,p_action_information11 in varchar2 default hr_api.g_varchar2
296 ,p_action_information12 in varchar2 default hr_api.g_varchar2
297 ,p_action_information13 in varchar2 default hr_api.g_varchar2
298 ,p_action_information14 in varchar2 default hr_api.g_varchar2
299 ,p_action_information15 in varchar2 default hr_api.g_varchar2
300 ,p_action_information16 in varchar2 default hr_api.g_varchar2
301 ,p_action_information17 in varchar2 default hr_api.g_varchar2
302 ,p_action_information18 in varchar2 default hr_api.g_varchar2
303 ,p_action_information19 in varchar2 default hr_api.g_varchar2
304 ,p_action_information20 in varchar2 default hr_api.g_varchar2
305 ,p_action_information21 in varchar2 default hr_api.g_varchar2
306 ,p_action_information22 in varchar2 default hr_api.g_varchar2
307 ,p_action_information23 in varchar2 default hr_api.g_varchar2
308 ,p_action_information24 in varchar2 default hr_api.g_varchar2
309 ,p_action_information25 in varchar2 default hr_api.g_varchar2
310 ,p_action_information26 in varchar2 default hr_api.g_varchar2
311 ,p_action_information27 in varchar2 default hr_api.g_varchar2
312 ,p_action_information28 in varchar2 default hr_api.g_varchar2
313 ,p_action_information29 in varchar2 default hr_api.g_varchar2
314 ,p_action_information30 in varchar2 default hr_api.g_varchar2
315 );
316 --
317 -- ----------------------------------------------------------------------------
318 -- |------------------------< delete_action_information >---------------------|
319 -- ----------------------------------------------------------------------------
320 --
321 -- {Start Of Comments}
322 /*#
323 * This API deletes action information records.
324 *
325 * API to delete action information records.
326 *
327 * <p><b>Licensing</b><br>
328 * This API is licensed for use with Human Resources.
329 *
330 * <p><b>Prerequisites</b><br>
331 * The action information records must exist for the API to delete them.
332 *
333 * <p><b>Post Success</b><br>
334 * The API deletes the action information records.
335 *
336 * <p><b>Post Failure</b><br>
340 * then the database will be modified.
337 * The API does not delete the action information and raises an error.
338 * @param p_validate If true, then validation alone will be performed and the
339 * database will remain unchanged. If false and all validation checks pass,
341 * @param p_action_information_id Primary key of record which uniquely
342 * identifies it.
343 * @param p_object_version_number Current version number of the action
344 * information to be deleted.
345 * @rep:displayname Delete Action Information
346 * @rep:category BUSINESS_ENTITY PAY_PAYMENT_ARCHIVE
347 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
348 * @rep:scope public
349 * @rep:lifecycle active
350 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
351 */
352 --
353 -- {End Of Comments}
354 --
355 procedure delete_action_information
356 (
357 p_validate in boolean default false
358 ,p_action_information_id in number
359 ,p_object_version_number in out nocopy number
360 );
361 --
362 end pay_action_information_api;
[Home] [Help]