DBA Data[Home] [Help]

PACKAGE: APPS.HR_TEMPLATE_ITEMS_API

Source


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