DBA Data[Home] [Help]

PACKAGE: APPS.HR_FORM_ITEMS_API

Source


1 Package hr_form_items_api as
2 /* $Header: hrfimapi.pkh 120.0 2005/05/31 00:20:34 appldev noship $ */
3 --
4 --
5 -- ----------------------------------------------------------------------------
6 -- |--------------------------< create_form_item >--------------------------|
7 -- ----------------------------------------------------------------------------
8 -- {Start Of Comments}
9 --
10 -- Description: This business process inserts a new form item in the HR Schema.
11 --
12 --
13 -- Prerequisites:
14 --
15 --
16 -- In Parameters:
17 --   Name                        Reqd Type     Description
18 --   p_language_code                N Varchar2
19 --   p_application_id               Y Number
20 --   p_form_id                      Y Number
21 --   p_full_item_name               Y Number
22 --   p_item_type                    Y Number
23 --   p_form_canvas_id               Y Number
24 --   p_user_item_name               Y Varchar2
25 --   p_description                  N Varchar2
26 --   p_form_tab_page_id             N Number
27 --   p_radio_button_name            N Varchar2
28 --   p_required_override            N Number
29 --   p_form_tab_page_id_override    N Number
30 --   p_visible_override             N Number
31 --   p_alignment                    N Number
32 --   p_bevel                        N Number
33 --   p_case_restriction             N Number
34 --   p_default_value                N Number
35 --   p_enabled                      N Number
36 --   p_format_mask                  N Varchar2
37 --   p_height                       N Number
38 --   p_information_formula_id       N Number
39 --   p_information_param_item_id1   N Number
40 --   p_information_param_item_id2   N Number
41 --   p_information_param_item_id3   N Number
42 --   p_information_param_item_id4   N Number
43 --   p_information_param_item_id5   N Number
44 --   p_information_prompt           N Varchar2
45 --   p_insert_allowed               N Number
46 --   p_label                        N Varchar2
47 --   p_prompt_text                  N Varchar2
48 --   p_prompt_alignment_offset      N Number
49 --   p_prompt_display_style         N Number
50 --   p_prompt_edge                  N Number
51 --   p_prompt_edge_alignment        N Number
52 --   p_prompt_edge_offset           N Number
53 --   p_prompt_text_alignment        N Number
54 --   p_query_allowed                N Number
55 --   p_required                     N Number
56 --   p_tooltip_text                 N Varchar2
57 --   p_update_allowed               N Number
58 --   p_validation_formula_id        N Number
59 --   p_validation_param_item_id1    N Number
60 --   p_validation_param_item_id2    N Number
61 --   p_validation_param_item_id3    N Number
62 --   p_validation_param_item_id4    N Number
63 --   p_validation_param_item_id5    N Number
64 --   p_visible                      N Number
65 --   p_width                        N Number
66 --   p_x_position                   N Number
67 --   p_y_position                   N Number
68 --   p_information_category         N Varchar2
69 --   p_information1                 N Varchar2
70 --   p_information2                 N Varchar2
71 --   p_information3                 N Varchar2
72 --   p_information4                 N Varchar2
73 --   p_information5                 N Varchar2
74 --   p_information6                 N Varchar2
75 --   p_information7                 N Varchar2
76 --   p_information8                 N Varchar2
77 --   p_information9                 N Varchar2
78 --   p_information10                N Varchar2
79 --   p_information11                N Varchar2
80 --   p_information12                N Varchar2
81 --   p_information13                N Varchar2
82 --   p_information14                N Varchar2
83 --   p_information15                N Varchar2
84 --   p_information16                N Varchar2
85 --   p_information17                N Varchar2
86 --   p_information18                N Varchar2
87 --   p_information19                N Varchar2
88 --   p_information20                N Varchar2
89 --   p_information21                N Varchar2
90 --   p_information22                N Varchar2
91 --   p_information23                N Varchar2
92 --   p_information24                N Varchar2
93 --   p_information25                N Varchar2
94 --   p_information26                N Varchar2
95 --   p_information27                N Varchar2
96 --   p_information28                N Varchar2
97 --   p_information29                N Varchar2
98 --   p_information30                N Varchar2
99 --
100 --
101 -- Post Success:
102 --
103 --
104 --   Name                           Type     Description
105 --   p_form_item_id                 Number
106 --   p_object_version_number        Number
107 --   p_override_value_warning       Boolean
108 --
109 -- Post Failure:
110 --
111 --
112 -- Access Status:
113 --   Internal.
114 --
115 -- {End Of Comments}
116 --
117 procedure create_form_item
118   (p_validate                    in boolean  default false
119   ,p_effective_date              in date
120   ,p_language_code               in varchar2 default hr_api.userenv_lang
121   ,p_application_id              in number
122   ,p_form_id                     in number
123   ,p_full_item_name              in varchar2
124   ,p_item_type                   in varchar2
125   ,p_form_canvas_id              in number
126   ,p_user_item_name              in varchar2
127   ,p_description                 in varchar2 default null
128   ,p_form_tab_page_id            in number default null
129   ,p_radio_button_name           in varchar2 default null
130   ,p_required_override           in number default null
131   ,p_form_tab_page_id_override   in number default null
132   ,p_visible_override            in number default null
133   ,p_alignment                   in number default null
134   ,p_bevel                       in number default null
135   ,p_case_restriction            in number default null
136   ,p_default_value               in varchar2 default null
137   ,p_enabled                     in number default null
138   ,p_format_mask                 in varchar2 default null
139   ,p_height                      in number default null
140   ,p_information_formula_id      in number default null
141   ,p_information_param_item_id1  in number default null
142   ,p_information_param_item_id2  in number default null
143   ,p_information_param_item_id3  in number default null
144   ,p_information_param_item_id4  in number default null
145   ,p_information_param_item_id5  in number default null
146   ,p_information_prompt          in varchar2 default null
147   ,p_insert_allowed              in number default null
148   ,p_label                       in varchar2 default null
149   ,p_prompt_text                 in varchar2 default null
150   ,p_prompt_alignment_offset     in number default null
151   ,p_prompt_display_style        in number default null
152   ,p_prompt_edge                 in number default null
153   ,p_prompt_edge_alignment       in number default null
154   ,p_prompt_edge_offset          in number default null
155   ,p_prompt_text_alignment       in number default null
156   ,p_query_allowed               in number default null
157   ,p_required                    in number default null
158   ,p_tooltip_text                in varchar2 default null
159   ,p_update_allowed              in number default null
160   ,p_validation_formula_id       in number default null
161   ,p_validation_param_item_id1   in number default null
162   ,p_validation_param_item_id2   in number default null
163   ,p_validation_param_item_id3   in number default null
164   ,p_validation_param_item_id4   in number default null
165   ,p_validation_param_item_id5   in number default null
166   ,p_visible                     in number default null
167   ,p_width                       in number default null
168   ,p_x_position                  in number default null
169   ,p_y_position                  in number default null
170   ,p_information_category        in varchar2 default null
171   ,p_information1                in varchar2 default null
172   ,p_information2                in varchar2 default null
173   ,p_information3                in varchar2 default null
174   ,p_information4                in varchar2 default null
175   ,p_information5                in varchar2 default null
176   ,p_information6                in varchar2 default null
177   ,p_information7                in varchar2 default null
178   ,p_information8                in varchar2 default null
179   ,p_information9                in varchar2 default null
180   ,p_information10               in varchar2 default null
181   ,p_information11               in varchar2 default null
182   ,p_information12               in varchar2 default null
183   ,p_information13               in varchar2 default null
184   ,p_information14               in varchar2 default null
185   ,p_information15               in varchar2 default null
186   ,p_information16               in varchar2 default null
187   ,p_information17               in varchar2 default null
188   ,p_information18               in varchar2 default null
189   ,p_information19               in varchar2 default null
190   ,p_information20               in varchar2 default null
191   ,p_information21               in varchar2 default null
192   ,p_information22               in varchar2 default null
193   ,p_information23               in varchar2 default null
194   ,p_information24               in varchar2 default null
195   ,p_information25               in varchar2 default null
196   ,p_information26               in varchar2 default null
197   ,p_information27               in varchar2 default null
198   ,p_information28               in varchar2 default null
199   ,p_information29               in varchar2 default null
200   ,p_information30               in varchar2 default null
201   ,p_next_navigation_item_id     in number default null
202   ,p_previous_navigation_item_id in number default null
203   ,p_form_item_id                   out nocopy number
204   ,p_object_version_number          out nocopy number
205   ,p_override_value_warning         out nocopy boolean
206   );
207 --
208 --
209 -- ----------------------------------------------------------------------------
210 -- |--------------------------< delete_form_item >----------------------------|
211 -- ----------------------------------------------------------------------------
212 -- {Start Of Comments}
213 --
214 -- Description: This business process deletes a form item from the HR Schema.
215 --
216 --
217 -- Prerequisites:
218 --
219 --
220 -- In Parameters:
221 --   Name                           Reqd Type     Description
222 --   p_form_item_id                 Y    Number
223 --   p_object_version_number        Y    Number
224 --
225 --
226 -- Post Success:
227 --
228 --
229 --   Name                           Type     Description
230 --
231 -- Post Failure:
232 --
233 --
234 -- Access Status:
235 --   Internal.
236 --
237 -- {End Of Comments}
238 --
239 procedure delete_form_item
240   (p_validate                      in     boolean  default false
241   ,p_form_item_id                  in     number
242   ,p_object_version_number         in     number
243   );
244 --
245 --
246 -- --------------------------------------------------------------------------
247 -- |--------------------------< update_form_item >--------------------------|
248 -- --------------------------------------------------------------------------
249 -- {Start Of Comments}
250 --
251 -- Description: This business process updates a form item in the HR Schema.
252 --
253 --
254 -- Prerequisites:
255 --
256 --
257 -- In Parameters:
258 --   Name                        Reqd Type     Description
259 --   p_language_code                N Varchar2
260 --   p_form_item_id                 N Number
261 --   p_full_item_name               Y Number
262 --   p_item_type                    Y Number
263 --   p_user_item_name               Y Varchar2
264 --   p_description                  N Varchar2
265 --   p_radio_button_name            N Varchar2
266 --   p_required_override            N Number
267 --   p_form_tab_page_id_override    N Number
268 --   p_visible_override             N Number
269 --   p_alignment                    N Number
270 --   p_bevel                        N Number
271 --   p_case_restriction             N Number
272 --   p_default_value                N Number
273 --   p_enabled                      N Number
274 --   p_format_mask                  N Varchar2
275 --   p_height                       N Number
276 --   p_information_formula_id       N Number
277 --   p_information_param_item_id1   N Number
278 --   p_information_param_item_id2   N Number
279 --   p_information_param_item_id3   N Number
280 --   p_information_param_item_id4   N Number
281 --   p_information_param_item_id5   N Number
282 --   p_information_prompt           N Varchar2
283 --   p_insert_allowed               N Number
284 --   p_label                        N Varchar2
285 --   p_prompt_text                  N Varchar2
286 --   p_prompt_alignment_offset      N Number
287 --   p_prompt_display_style         N Number
288 --   p_prompt_edge                  N Number
289 --   p_prompt_edge_alignment        N Number
290 --   p_prompt_edge_offset           N Number
291 --   p_prompt_text_alignment        N Number
292 --   p_query_allowed                N Number
293 --   p_required                     N Number
294 --   p_tooltip_text                 N Varchar2
295 --   p_update_allowed               N Number
296 --   p_validation_formula_id        N Number
297 --   p_validation_param_item_id1    N Number
298 --   p_validation_param_item_id2    N Number
299 --   p_validation_param_item_id3    N Number
300 --   p_validation_param_item_id4    N Number
301 --   p_validation_param_item_id5    N Number
302 --   p_visible                      N Number
303 --   p_width                        N Number
304 --   p_x_position                   N Number
305 --   p_y_position                   N Number
306 --   p_information_category         N Varchar2
307 --   p_information1                 N Varchar2
308 --   p_information2                 N Varchar2
309 --   p_information3                 N Varchar2
310 --   p_information4                 N Varchar2
311 --   p_information5                 N Varchar2
312 --   p_information6                 N Varchar2
313 --   p_information7                 N Varchar2
314 --   p_information8                 N Varchar2
315 --   p_information9                 N Varchar2
316 --   p_information10                N Varchar2
317 --   p_information11                N Varchar2
318 --   p_information12                N Varchar2
319 --   p_information13                N Varchar2
320 --   p_information14                N Varchar2
321 --   p_information15                N Varchar2
322 --   p_information16                N Varchar2
323 --   p_information17                N Varchar2
324 --   p_information18                N Varchar2
325 --   p_information19                N Varchar2
326 --   p_information20                N Varchar2
327 --   p_information21                N Varchar2
328 --   p_information22                N Varchar2
329 --   p_information23                N Varchar2
330 --   p_information24                N Varchar2
331 --   p_information25                N Varchar2
332 --   p_information26                N Varchar2
333 --   p_information27                N Varchar2
334 --   p_information28                N Varchar2
335 --   p_information29                N Varchar2
336 --   p_information30                N Varchar2
337 --
338 -- Post Success:
339 --
340 --   Name                           Type     Description
341 --   p_object_version_number        Number
342 --   p_override_value_warning       Boolean
343 --
344 -- Post Failure:
345 --
346 --
347 -- Access Status:
348 --   Internal.
349 --
353   (p_validate                    in     boolean  default false
350 -- {End Of Comments}
351 --
352 procedure update_form_item
354   ,p_effective_date              in     date
355   ,p_language_code               in varchar2 default hr_api.userenv_lang
356   ,p_form_item_id                in  number
357   ,p_object_version_number       in out nocopy     number
358   ,p_full_item_name              in varchar2  default hr_api.g_varchar2
359   --,p_item_type                   in varchar2 default hr_api.g_varchar2
360   ,p_user_item_name              in varchar2  default hr_api.g_varchar2
361   ,p_description                 in varchar2 default hr_api.g_varchar2
362   ,p_radio_button_name           in varchar2 default hr_api.g_varchar2
363   ,p_required_override           in number default hr_api.g_number
364   ,p_form_tab_page_id_override   in number default hr_api.g_number
365   ,p_visible_override            in number default hr_api.g_number
366   ,p_alignment                   in number default hr_api.g_number
367   ,p_bevel                       in number default hr_api.g_number
368   ,p_case_restriction            in number default hr_api.g_number
369   ,p_default_value               in varchar2 default hr_api.g_varchar2
370   ,p_enabled                     in number default hr_api.g_number
371   ,p_format_mask                 in varchar2 default hr_api.g_varchar2
372   ,p_height                      in number default hr_api.g_number
373   ,p_information_formula_id      in number default hr_api.g_number
374   ,p_information_param_item_id1  in number default hr_api.g_number
375   ,p_information_param_item_id2  in number default hr_api.g_number
376   ,p_information_param_item_id3  in number default hr_api.g_number
377   ,p_information_param_item_id4  in number default hr_api.g_number
378   ,p_information_param_item_id5  in number default hr_api.g_number
379   ,p_information_prompt          in varchar2 default hr_api.g_varchar2
380   ,p_insert_allowed              in number default hr_api.g_number
381   ,p_label                       in varchar2 default hr_api.g_varchar2
382   ,p_prompt_text                 in varchar2 default hr_api.g_varchar2
383   ,p_prompt_alignment_offset     in number default hr_api.g_number
384   ,p_prompt_display_style        in number default hr_api.g_number
385   ,p_prompt_edge                 in number default hr_api.g_number
386   ,p_prompt_edge_alignment       in number default hr_api.g_number
387   ,p_prompt_edge_offset          in number default hr_api.g_number
388   ,p_prompt_text_alignment       in number default hr_api.g_number
389   ,p_query_allowed               in number default hr_api.g_number
390   ,p_required                    in number default hr_api.g_number
391   ,p_tooltip_text                in varchar2 default hr_api.g_varchar2
392   ,p_update_allowed              in number default hr_api.g_number
393   ,p_validation_formula_id       in number default hr_api.g_number
394   ,p_validation_param_item_id1   in number default hr_api.g_number
395   ,p_validation_param_item_id2   in number default hr_api.g_number
396   ,p_validation_param_item_id3   in number default hr_api.g_number
397   ,p_validation_param_item_id4   in number default hr_api.g_number
398   ,p_validation_param_item_id5   in number default hr_api.g_number
399   ,p_visible                     in number default hr_api.g_number
400   ,p_width                       in number default hr_api.g_number
401   ,p_x_position                  in number default hr_api.g_number
402   ,p_y_position                  in number default hr_api.g_number
403   ,p_information_category        in varchar2 default hr_api.g_varchar2
404   ,p_information1                in varchar2 default hr_api.g_varchar2
405   ,p_information2                in varchar2 default hr_api.g_varchar2
406   ,p_information3                in varchar2 default hr_api.g_varchar2
407   ,p_information4                in varchar2 default hr_api.g_varchar2
408   ,p_information5                in varchar2 default hr_api.g_varchar2
409   ,p_information6                in varchar2 default hr_api.g_varchar2
410   ,p_information7                in varchar2 default hr_api.g_varchar2
411   ,p_information8                in varchar2 default hr_api.g_varchar2
412   ,p_information9                in varchar2 default hr_api.g_varchar2
413   ,p_information10               in varchar2 default hr_api.g_varchar2
414   ,p_information11               in varchar2 default hr_api.g_varchar2
415   ,p_information12               in varchar2 default hr_api.g_varchar2
416   ,p_information13               in varchar2 default hr_api.g_varchar2
417   ,p_information14               in varchar2 default hr_api.g_varchar2
418   ,p_information15               in varchar2 default hr_api.g_varchar2
419   ,p_information16               in varchar2 default hr_api.g_varchar2
420   ,p_information17               in varchar2 default hr_api.g_varchar2
421   ,p_information18               in varchar2 default hr_api.g_varchar2
422   ,p_information19               in varchar2 default hr_api.g_varchar2
423   ,p_information20               in varchar2 default hr_api.g_varchar2
424   ,p_information21               in varchar2 default hr_api.g_varchar2
425   ,p_information22               in varchar2 default hr_api.g_varchar2
426   ,p_information23               in varchar2 default hr_api.g_varchar2
427   ,p_information24               in varchar2 default hr_api.g_varchar2
428   ,p_information25               in varchar2 default hr_api.g_varchar2
429   ,p_information26               in varchar2 default hr_api.g_varchar2
430   ,p_information27               in varchar2 default hr_api.g_varchar2
431   ,p_information28               in varchar2 default hr_api.g_varchar2
432   ,p_information29               in varchar2 default hr_api.g_varchar2
433   ,p_information30               in varchar2 default hr_api.g_varchar2
434   ,p_next_navigation_item_id     in number default hr_api.g_number
435   ,p_previous_navigation_item_id in number default hr_api.g_number
436   ,p_override_value_warning      out nocopy boolean
437   );
438 --
439 end hr_form_items_api;