1 Package pqh_budget_elements_api as
2 /* $Header: pqbelapi.pkh 120.1 2005/10/02 02:25:41 aroussel $ */
3 /*#
4 * This package contains APIs to create, update and delete the elements
5 * associated with a budget set.
6 * @rep:scope public
7 * @rep:product per
8 * @rep:displayname Budget Element
9 */
10 --
11 -- ----------------------------------------------------------------------------
12 -- |--------------------------< create_budget_element >-----------------------|
13 -- ----------------------------------------------------------------------------
14 --
15 -- {Start Of Comments}
16 /*#
17 * This API creates a budget element.
18 *
19 * Elements and the distribution of elements for a budget set is inserted.
20 *
21 * <p><b>Licensing</b><br>
22 * This API is licensed for use with Human Resources.
23 *
24 * <p><b>Prerequisites</b><br>
25 * Budget set identifier should already exist.
26 *
27 * <p><b>Post Success</b><br>
28 * Element for a budget set will be successfully inserted in the database.
29 *
30 * <p><b>Post Failure</b><br>
31 * Element for a budget set will not be inserted and an error will be raised.
32 * @param p_validate If true, then validation alone will be performed and the
33 * database will remain unchanged. If false and all validation checks pass,
34 * then the database will be modified.
35 * @param p_budget_element_id If p_validate is false, then this uniquely
36 * identifies the budget element record created. If p_validate is true, then
37 * set to null.
38 * @param p_budget_set_id Budget set identifier.
39 * @param p_element_type_id Element type identifier.
40 * @param p_distribution_percentage Percentage of budget set for given element.
41 * @param p_object_version_number If p_validate is false, then set to the
42 * version number of the created budget element. If p_validate is true, then
43 * the value will be null.
44 * @rep:displayname Create Budget Element
45 * @rep:category BUSINESS_ENTITY HR_BUDGET
46 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
47 * @rep:scope public
48 * @rep:lifecycle active
49 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
50 */
51 --
52 -- {End Of Comments}
53 --
54 procedure create_budget_element
55 (
56 p_validate in boolean default false
57 ,p_budget_element_id out nocopy number
58 ,p_budget_set_id in number default null
59 ,p_element_type_id in number default null
60 ,p_distribution_percentage in number default null
61 ,p_object_version_number out nocopy number
62 );
63 --
64 -- ----------------------------------------------------------------------------
65 -- |--------------------------< update_budget_element >-----------------------|
66 -- ----------------------------------------------------------------------------
67 --
68 -- {Start Of Comments}
69 /*#
70 * This API updates a budget element.
71 *
72 * The element itself or the distribution of elements for a budget set is
73 * updated.
74 *
75 * <p><b>Licensing</b><br>
76 * This API is licensed for use with Human Resources.
77 *
78 * <p><b>Prerequisites</b><br>
79 * Budget element to be updated for a budget set should already exist.
80 *
81 * <p><b>Post Success</b><br>
82 * Element for a budget set will be updated in the database.
83 *
84 * <p><b>Post Failure</b><br>
85 * Element for a budget set will not be updated and an error will be raised.
86 * @param p_validate If true, then validation alone will be performed and the
87 * database will remain unchanged. If false and all validation checks pass,
88 * then the database will be modified.
89 * @param p_budget_element_id Identifies the budget element record updated.
90 * @param p_budget_set_id Budget set identifier.
91 * @param p_element_type_id Element type identifier.
92 * @param p_distribution_percentage Percentage of budget set for given element.
93 * @param p_object_version_number Pass in the current version number of the
94 * budget element record to be updated. When the API completes if p_validate is
95 * false, will be set to the new version number of the updated budget element.
96 * If p_validate is true will be set to the same value which was passed in.
97 * @rep:displayname Update Budget Element
98 * @rep:category BUSINESS_ENTITY HR_BUDGET
99 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
100 * @rep:scope public
101 * @rep:lifecycle active
102 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
103 */
104 --
105 -- {End Of Comments}
106 --
107 procedure update_budget_element
108 (
109 p_validate in boolean default false
110 ,p_budget_element_id in number
111 ,p_budget_set_id in number default hr_api.g_number
112 ,p_element_type_id in number default hr_api.g_number
113 ,p_distribution_percentage in number default hr_api.g_number
114 ,p_object_version_number in out nocopy number
115 );
116 --
117 -- ----------------------------------------------------------------------------
118 -- |--------------------------< delete_budget_element >-----------------------|
119 -- ----------------------------------------------------------------------------
120 --
121 -- {Start Of Comments}
122 /*#
123 * This API deletes a budget element.
124 *
125 *
126 * <p><b>Licensing</b><br>
127 * This API is licensed for use with Human Resources.
128 *
129 * <p><b>Prerequisites</b><br>
130 * Budget element to be deleted for a budget set should exist.
131 *
132 * <p><b>Post Success</b><br>
133 * Element for a budget set will be deleted in the database.
134 *
135 * <p><b>Post Failure</b><br>
136 * Element for a budget set will not be deleted and an error will be raised.
137 * @param p_validate If true, then validation alone will be performed and the
138 * database will remain unchanged. If false and all validation checks pass,
139 * then the database will be modified.
140 * @param p_budget_element_id This uniquely identifies the budget element.
141 * @param p_object_version_number Current version number of the budget element
142 * to be deleted.
143 * @rep:displayname Delete Budget Element
144 * @rep:category BUSINESS_ENTITY HR_BUDGET
145 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
146 * @rep:scope public
147 * @rep:lifecycle active
148 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
149 */
150 --
151 -- {End Of Comments}
152 --
153 procedure delete_budget_element
154 (
155 p_validate in boolean default false
156 ,p_budget_element_id in number
157 ,p_object_version_number in number
158 );
159 --
160 end pqh_budget_elements_api;
[Home] [Help]