1 Package pqh_budget_sets_api as
2 /* $Header: pqbstapi.pkh 120.1 2005/10/02 02:26:16 aroussel $ */
3 /*#
4 * This package contains APIs to create, update and delete the budget sets for
5 * a budget period.
6 * @rep:scope public
7 * @rep:product per
8 * @rep:displayname Budget Set
9 */
10 --
11 -- ----------------------------------------------------------------------------
12 -- |----------------------------< create_budget_set >-------------------------|
13 -- ----------------------------------------------------------------------------
14 --
15 -- {Start Of Comments}
16 /*#
17 * This API creates budget element sets with default distribution.
18 *
19 * Default budget set values will be pulled in for a budget period.
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 period should exist in order to create a budget set.
26 *
27 * <p><b>Post Success</b><br>
28 * Budget set will be inserted in the database.
29 *
30 * <p><b>Post Failure</b><br>
31 * Budget set will not be created 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_set_id If p_validate is false, then this uniquely identifies
36 * the budget set record created. If p_validate is true, then set to null.
37 * @param p_dflt_budget_set_id {@rep:casecolumn
38 * PQH_BUDGET_SETS.DFLT_BUDGET_SET_ID}
39 * @param p_budget_period_id Budget period identifier.
40 * @param p_budget_unit1_percent {@rep:casecolumn
41 * PQH_BUDGET_SETS.BUDGET_UNIT1_PERCENT}
42 * @param p_budget_unit2_percent {@rep:casecolumn
43 * PQH_BUDGET_SETS.BUDGET_UNIT2_PERCENT}
44 * @param p_budget_unit3_percent {@rep:casecolumn
45 * PQH_BUDGET_SETS.BUDGET_UNIT3_PERCENT}
46 * @param p_budget_unit1_value {@rep:casecolumn
47 * PQH_BUDGET_SETS.BUDGET_UNIT1_VALUE}
48 * @param p_budget_unit2_value {@rep:casecolumn
49 * PQH_BUDGET_SETS.BUDGET_UNIT2_VALUE}
50 * @param p_budget_unit3_value {@rep:casecolumn
51 * PQH_BUDGET_SETS.BUDGET_UNIT3_VALUE}
52 * @param p_budget_unit1_available {@rep:casecolumn
53 * PQH_BUDGET_SETS.BUDGET_UNIT1_AVAILABLE}
54 * @param p_budget_unit2_available {@rep:casecolumn
55 * PQH_BUDGET_SETS.BUDGET_UNIT2_AVAILABLE}
56 * @param p_budget_unit3_available {@rep:casecolumn
57 * PQH_BUDGET_SETS.BUDGET_UNIT3_AVAILABLE}
58 * @param p_object_version_number If p_validate is false, then set to the
59 * version number of the created budget set. If p_validate is true, then the
60 * value will be null.
61 * @param p_budget_unit1_value_type_cd Identifies the budget input value type.
62 * Valid values are defined by 'PQH_BUDGET_UNIT_VALUE_TYPE' lookup type.
63 * @param p_budget_unit2_value_type_cd Identifies the budget input value type.
64 * Valid values are defined by 'PQH_BUDGET_UNIT_VALUE_TYPE' lookup type.
65 * @param p_budget_unit3_value_type_cd Identifies the budget input value type.
66 * Valid values are defined by 'PQH_BUDGET_UNIT_VALUE_TYPE' lookup type.
67 * @param p_effective_date Reference date for validating lookup values are
68 * applicable during the start to end active date range. This date does not
69 * determine when the changes take effect.
70 * @rep:displayname Create Budget Set
71 * @rep:category BUSINESS_ENTITY HR_BUDGET
72 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
73 * @rep:scope public
74 * @rep:lifecycle active
75 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
76 */
77 --
78 -- {End Of Comments}
79 --
80 procedure create_budget_set
81 (
82 p_validate in boolean default false
83 ,p_budget_set_id out nocopy number
84 ,p_dflt_budget_set_id in number default null
85 ,p_budget_period_id in number default null
86 ,p_budget_unit1_percent in number default null
87 ,p_budget_unit2_percent in number default null
88 ,p_budget_unit3_percent in number default null
89 ,p_budget_unit1_value in number default null
90 ,p_budget_unit2_value in number default null
91 ,p_budget_unit3_value in number default null
92 ,p_budget_unit1_available in number default null
93 ,p_budget_unit2_available in number default null
94 ,p_budget_unit3_available in number default null
95 ,p_object_version_number out nocopy number
96 ,p_budget_unit1_value_type_cd in varchar2 default null
97 ,p_budget_unit2_value_type_cd in varchar2 default null
98 ,p_budget_unit3_value_type_cd in varchar2 default null
99 ,p_effective_date in date
100 );
101 --
102 -- ----------------------------------------------------------------------------
103 -- |----------------------------< update_budget_set >-------------------------|
104 -- ----------------------------------------------------------------------------
105 --
106 -- {Start Of Comments}
107 /*#
108 * This API updates budget sets with default distribution.
109 *
110 *
111 * <p><b>Licensing</b><br>
112 * This API is licensed for use with Human Resources.
113 *
114 * <p><b>Prerequisites</b><br>
115 * Budget set to be updated should already exist. Budget period should already
116 * exist.
117 *
118 * <p><b>Post Success</b><br>
119 * Budget set will be updated in the database.
120 *
121 * <p><b>Post Failure</b><br>
122 * Budget set will not be updated and an error will be raised.
123 * @param p_validate If true, then validation alone will be performed and the
124 * database will remain unchanged. If false and all validation checks pass,
125 * then the database will be modified.
126 * @param p_budget_set_id Identifies the budget set to be updated.
127 * @param p_dflt_budget_set_id {@rep:casecolumn
128 * PQH_BUDGET_SETS.DFLT_BUDGET_SET_ID}
129 * @param p_budget_period_id Budget period identifier.
130 * @param p_budget_unit1_percent {@rep:casecolumn
131 * PQH_BUDGET_SETS.BUDGET_UNIT1_PERCENT}
132 * @param p_budget_unit2_percent {@rep:casecolumn
133 * PQH_BUDGET_SETS.BUDGET_UNIT2_PERCENT}
134 * @param p_budget_unit3_percent {@rep:casecolumn
135 * PQH_BUDGET_SETS.BUDGET_UNIT3_PERCENT}
136 * @param p_budget_unit1_value {@rep:casecolumn
137 * PQH_BUDGET_SETS.BUDGET_UNIT1_VALUE}
138 * @param p_budget_unit2_value {@rep:casecolumn
139 * PQH_BUDGET_SETS.BUDGET_UNIT2_VALUE}
140 * @param p_budget_unit3_value {@rep:casecolumn
141 * PQH_BUDGET_SETS.BUDGET_UNIT3_VALUE}
142 * @param p_budget_unit1_available {@rep:casecolumn
143 * PQH_BUDGET_SETS.BUDGET_UNIT1_AVAILABLE}
144 * @param p_budget_unit2_available {@rep:casecolumn
145 * PQH_BUDGET_SETS.BUDGET_UNIT2_AVAILABLE}
146 * @param p_budget_unit3_available {@rep:casecolumn
147 * PQH_BUDGET_SETS.BUDGET_UNIT3_AVAILABLE}
148 * @param p_object_version_number Pass in the current version number of the
149 * budget set to be updated. When the API completes if p_validate is false,
150 * will be set to the new version number of the updated budget set. If
151 * p_validate is true will be set to the same value which was passed in.
152 * @param p_budget_unit1_value_type_cd Identifies the budget input value type.
153 * Valid values are defined by 'PQH_BUDGET_UNIT_VALUE_TYPE' lookup type.
154 * @param p_budget_unit2_value_type_cd Identifies the budget input value type.
155 * Valid values are defined by 'PQH_BUDGET_UNIT_VALUE_TYPE' lookup type.
156 * @param p_budget_unit3_value_type_cd Identifies the budget input value type.
157 * Valid values are defined by 'PQH_BUDGET_UNIT_VALUE_TYPE' lookup type.
158 * @param p_effective_date Reference date for validating lookup values are
159 * applicable during the start to end active date range. This date does not
160 * determine when the changes take effect.
161 * @rep:displayname Update Budget Set
162 * @rep:category BUSINESS_ENTITY HR_BUDGET
163 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
164 * @rep:scope public
165 * @rep:lifecycle active
166 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
167 */
168 --
169 -- {End Of Comments}
170 --
171 procedure update_budget_set
172 (
173 p_validate in boolean default false
174 ,p_budget_set_id in number
175 ,p_dflt_budget_set_id in number default hr_api.g_number
176 ,p_budget_period_id in number default hr_api.g_number
177 ,p_budget_unit1_percent in number default hr_api.g_number
178 ,p_budget_unit2_percent in number default hr_api.g_number
179 ,p_budget_unit3_percent in number default hr_api.g_number
180 ,p_budget_unit1_value in number default hr_api.g_number
181 ,p_budget_unit2_value in number default hr_api.g_number
182 ,p_budget_unit3_value in number default hr_api.g_number
183 ,p_budget_unit1_available in number default hr_api.g_number
184 ,p_budget_unit2_available in number default hr_api.g_number
185 ,p_budget_unit3_available in number default hr_api.g_number
186 ,p_object_version_number in out nocopy number
187 ,p_budget_unit1_value_type_cd in varchar2 default hr_api.g_varchar2
188 ,p_budget_unit2_value_type_cd in varchar2 default hr_api.g_varchar2
189 ,p_budget_unit3_value_type_cd in varchar2 default hr_api.g_varchar2
190 ,p_effective_date in date
191 );
192 --
193 -- ----------------------------------------------------------------------------
194 -- |----------------------------< delete_budget_set >-------------------------|
195 -- ----------------------------------------------------------------------------
196 --
197 -- {Start Of Comments}
198 /*#
199 * This API deletes a budget set.
200 *
201 *
202 * <p><b>Licensing</b><br>
203 * This API is licensed for use with Human Resources.
204 *
205 * <p><b>Prerequisites</b><br>
206 * Budget set to be deleted should already exist.
207 *
208 * <p><b>Post Success</b><br>
209 * Budget set will be deleted from the database.
210 *
211 * <p><b>Post Failure</b><br>
212 * Budget set will not be deleted and an error will be raised.
213 * @param p_validate If true, then validation alone will be performed and the
214 * database will remain unchanged. If false and all validation checks pass,
215 * then the database will be modified.
216 * @param p_budget_set_id This uniquely identifies the budget set.
217 * @param p_object_version_number Current version number of the budget set to
218 * be deleted.
219 * @param p_effective_date Reference date for validating lookup values are
220 * applicable during the start to end active date range. This date does not
221 * determine when the changes take effect.
222 * @rep:displayname Delete Budget Set
223 * @rep:category BUSINESS_ENTITY HR_BUDGET
224 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
225 * @rep:scope public
226 * @rep:lifecycle active
227 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
228 */
229 --
230 -- {End Of Comments}
231 --
232 procedure delete_budget_set
233 (
234 p_validate in boolean default false
235 ,p_budget_set_id in number
236 ,p_object_version_number in number
237 ,p_effective_date in date
238 );
239 --
240 end pqh_budget_sets_api;
[Home] [Help]