1 Package pqh_budgets_api as
2 /* $Header: pqbgtapi.pkh 120.2 2006/06/05 19:09:59 nsanghal noship $ */
3 /*#
4 * This package contains APIs to create, update and delete budgets.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Budget
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |------------------------------< create_budget >---------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates the budget.
17 *
18 * Budget information, for example, start and end dates of the budget, or
19 * budget measurement unit, or entity budgeted, is created.
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 * Period set name and budget unit should already exist.
26 *
27 * <p><b>Post Success</b><br>
28 * Budget information will be inserted in the database.
29 *
30 * <p><b>Post Failure</b><br>
31 * Budget information 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_id If p_validate is false, then this uniquely identifies the
36 * budget record created. If p_validate is true, then set to null.
37 * @param p_business_group_id Business group identifier.
38 * @param p_start_organization_id Identifier of the starting organization
39 * within organization hierarchy tree. Starting organization and those below
40 * will be budgeted.
41 * @param p_org_structure_version_id {@rep:casecolumn
42 * PQH_BUDGETS.ORG_STRUCTURE_VERSION_ID}
43 * @param p_budgeted_entity_cd Indicates the budget entity. Valid values are
44 * defined by 'PQH_BUDGET_ENTITY' lookup type.
45 * @param p_budget_style_cd Indicates the budget style. Valid values are
46 * defined by 'PQH_BUDGET_STYLE' lookup type.
47 * @param p_budget_name {@rep:casecolumn PQH_BUDGETS.BUDGET_NAME}
48 * @param p_period_set_name {@rep:casecolumn PQH_BUDGETS.PERIOD_SET_NAME}
49 * @param p_budget_start_date {@rep:casecolumn PQH_BUDGETS.BUDGET_START_DATE}
50 * @param p_budget_end_date {@rep:casecolumn PQH_BUDGETS.BUDGET_END_DATE}
51 * @param p_gl_budget_name {@rep:casecolumn PQH_BUDGETS.GL_BUDGET_NAME}
52 * @param p_psb_budget_flag Indicates if this budget was transferred from PSB.
53 * Also this identifies if only GL commitment are to be processed. Valid values
54 * are defined by 'YES_NO' lookup type.
55 * @param p_transfer_to_gl_flag Indicates whether to transfer to GL or not.
56 * Valid values are defined by 'YES_NO' lookup type.
57 * @param p_transfer_to_grants_flag Indicates whether to transfer to grants or
58 * not. Valid values are defined by 'YES_NO' lookup type.
59 * @param p_status Budget is frozen or open.
60 * @param p_object_version_number If p_validate is false, then set to the
61 * version number of the created budget. If p_validate is true, then the value
62 * will be null.
63 * @param p_budget_unit1_id Budget identifier for measurement unit 1.
64 * @param p_budget_unit2_id Budget identifier for measurement unit 2.
65 * @param p_budget_unit3_id Budget identifier for measurement unit 3.
66 * @param p_gl_set_of_books_id Identifier for the GL Ledger that will be
67 * mapped for transfer to GL.
68 * @param p_budget_unit1_aggregate Used to compare period values against budget
69 * values. Valid values are defined by 'PQH_BGT_UOM_AGGREGATE' lookup type.
70 * @param p_budget_unit2_aggregate Used to compare period values against budget
71 * values. Valid values are defined by 'PQH_BGT_UOM_AGGREGATE' lookup type.
72 * @param p_budget_unit3_aggregate Used to compare period values against budget
73 * values. Valid values are defined by 'PQH_BGT_UOM_AGGREGATE' lookup type.
74 * @param p_position_control_flag Indicates if this budget is used for position
75 * control or not. Valid values are defined by 'YES_NO' lookup type.
76 * @param p_valid_grade_reqd_flag Indicates if a valid grade is required. Valid
77 * values are defined by 'YES_NO' lookup type.
78 * @param p_currency_code Currency type identifier.
79 * @param p_effective_date Reference date for validating lookup values are
80 * applicable during the start to end active date range. This date does not
81 * determine when the changes take effect.
82 * @param p_dflt_budget_set_id New parameter, available on the latest version
83 * of this API.
84 * @rep:displayname Create Budget
85 * @rep:category BUSINESS_ENTITY HR_BUDGET
86 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
87 * @rep:scope public
88 * @rep:lifecycle active
89 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
90 */
91 --
92 -- {End Of Comments}
93 --
94 procedure create_budget
95 (
96 p_validate in boolean default false
97 ,p_budget_id out nocopy number
98 ,p_business_group_id in number default null
99 ,p_start_organization_id in number default null
100 ,p_org_structure_version_id in number default null
101 ,p_budgeted_entity_cd in varchar2 default null
102 ,p_budget_style_cd in varchar2 default null
103 ,p_budget_name in varchar2 default null
104 ,p_period_set_name in varchar2 default null
105 ,p_budget_start_date in date default null
106 ,p_budget_end_date in date default null
107 ,p_gl_budget_name in varchar2 default null
108 ,p_psb_budget_flag in varchar2 default 'N'
109 ,p_transfer_to_gl_flag in varchar2 default null
110 ,p_transfer_to_grants_flag in varchar2 default null
111 ,p_status in varchar2 default null
112 ,p_object_version_number out nocopy number
113 ,p_budget_unit1_id in number default null
114 ,p_budget_unit2_id in number default null
115 ,p_budget_unit3_id in number default null
116 ,p_gl_set_of_books_id in number default null
117 ,p_budget_unit1_aggregate in varchar2 default null
118 ,p_budget_unit2_aggregate in varchar2 default null
119 ,p_budget_unit3_aggregate in varchar2 default null
120 ,p_position_control_flag in varchar2 default null
121 ,p_valid_grade_reqd_flag in varchar2 default null
122 ,p_currency_code in varchar2 default null
123 ,p_dflt_budget_set_id in number default null
124 ,p_effective_date in date
125 );
126 --
127 -- ----------------------------------------------------------------------------
128 -- |------------------------------< update_budget >---------------------------|
129 -- ----------------------------------------------------------------------------
130 --
131 -- {Start Of Comments}
132 /*#
133 * This API updates the budget.
134 *
135 * Budget information, for example, start and end dates of the budget, or
136 * budget measurement unit, or entity budgeted, are updated.
137 *
138 * <p><b>Licensing</b><br>
139 * This API is licensed for use with Human Resources.
140 *
141 * <p><b>Prerequisites</b><br>
142 * Budget to be updated should already exist. Period set name and budget unit
143 * should already exist.
144 *
145 * <p><b>Post Success</b><br>
146 * Budget information will be updated in the database.
147 *
148 * <p><b>Post Failure</b><br>
149 * Budget information will not be updated and an error will be raised.
150 * @param p_validate If true, then validation alone will be performed and the
151 * database will remain unchanged. If false and all validation checks pass,
152 * then the database will be modified.
153 * @param p_budget_id Identifies the budget to be updated.
154 * @param p_business_group_id Business group identifier.
155 * @param p_start_organization_id Identifier of the starting organization
156 * within organization hierarchy tree. Starting organization and those below
157 * will be budgeted.
158 * @param p_org_structure_version_id {@rep:casecolumn
159 * PQH_BUDGETS.ORG_STRUCTURE_VERSION_ID}
160 * @param p_budgeted_entity_cd Indicates the budget style. Valid values are
161 * defined by 'PQH_BUDGET_ENTITY' lookup type.
162 * @param p_budget_style_cd Indicates the budget style. Valid values are
163 * defined by 'PQH_BUDGET_STYLE' lookup type.
164 * @param p_budget_name {@rep:casecolumn PQH_BUDGETS.BUDGET_NAME}
165 * @param p_period_set_name {@rep:casecolumn PQH_BUDGETS.PERIOD_SET_NAME}
166 * @param p_budget_start_date {@rep:casecolumn PQH_BUDGETS.BUDGET_START_DATE}
167 * @param p_budget_end_date {@rep:casecolumn PQH_BUDGETS.BUDGET_END_DATE}
168 * @param p_gl_budget_name {@rep:casecolumn PQH_BUDGETS.GL_BUDGET_NAME}
169 * @param p_psb_budget_flag Indicates if this budget was transferred from PSB.
170 * Also this identifies if only GL commitment are to be processed. Valid values
171 * are defined by 'YES_NO' lookup type.
172 * @param p_transfer_to_gl_flag Indicates whether to transfer to GL or not.
173 * Valid values are defined by 'YES_NO' lookup type.
174 * @param p_transfer_to_grants_flag Indicates whether to transfer to grants or
175 * not. Valid values are defined by 'YES_NO' lookup type.
176 * @param p_status Budget is frozen or open.
177 * @param p_object_version_number Pass in the current version number of the
178 * budget to be updated. When the API completes if p_validate is false, will be
179 * set to the new version number of the updated budget. If p_validate is true
180 * will be set to the same value which was passed in.
181 * @param p_budget_unit1_id Budget identifier for measurement unit 1.
182 * @param p_budget_unit2_id Budget identifier for measurement unit 2.
183 * @param p_budget_unit3_id Budget identifier for measurement unit 3.
184 * @param p_gl_set_of_books_id Identifier for the GL Ledger that will be
185 * mapped for transfer to GL.
186 * @param p_budget_unit1_aggregate Used to compare period values against budget
187 * values. Valid values are defined by 'PQH_BGT_UOM_AGGREGATE' lookup type.
188 * @param p_budget_unit2_aggregate Used to compare period values against budget
189 * values. Valid values are defined by 'PQH_BGT_UOM_AGGREGATE' lookup type.
190 * @param p_budget_unit3_aggregate Used to compare period values against budget
191 * values. Valid values are defined by 'PQH_BGT_UOM_AGGREGATE' lookup type.
192 * @param p_position_control_flag Indicates if this budget is used for position
193 * control or not. Valid values are defined by 'YES_NO' lookup type.
194 * @param p_valid_grade_reqd_flag Indicates if a valid grade is required. Valid
195 * values are defined by 'YES_NO' lookup type.
196 * @param p_currency_code Currency type identifier.
197 * @param p_effective_date Reference date for validating lookup values are
198 * applicable during the start to end active date range. This date does not
199 * determine when the changes take effect.
200 * @param p_dflt_budget_set_id New parameter, available on the latest version
201 * of this API.
202 * @rep:displayname Update Budget
203 * @rep:category BUSINESS_ENTITY HR_BUDGET
204 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
205 * @rep:scope public
206 * @rep:lifecycle active
207 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
208 */
209 --
210 -- {End Of Comments}
211 --
212 procedure update_budget
213 (
214 p_validate in boolean default false
215 ,p_budget_id in number
216 ,p_business_group_id in number default hr_api.g_number
217 ,p_start_organization_id in number default hr_api.g_number
218 ,p_org_structure_version_id in number default hr_api.g_number
219 ,p_budgeted_entity_cd in varchar2 default hr_api.g_varchar2
220 ,p_budget_style_cd in varchar2 default hr_api.g_varchar2
221 ,p_budget_name in varchar2 default hr_api.g_varchar2
222 ,p_period_set_name in varchar2 default hr_api.g_varchar2
223 ,p_budget_start_date in date default hr_api.g_date
224 ,p_budget_end_date in date default hr_api.g_date
225 ,p_gl_budget_name in varchar2 default hr_api.g_varchar2
226 ,p_psb_budget_flag in varchar2 default hr_api.g_varchar2
227 ,p_transfer_to_gl_flag in varchar2 default hr_api.g_varchar2
228 ,p_transfer_to_grants_flag in varchar2 default hr_api.g_varchar2
229 ,p_status in varchar2 default hr_api.g_varchar2
230 ,p_object_version_number in out nocopy number
231 ,p_budget_unit1_id in number default hr_api.g_number
232 ,p_budget_unit2_id in number default hr_api.g_number
233 ,p_budget_unit3_id in number default hr_api.g_number
234 ,p_gl_set_of_books_id in number default hr_api.g_number
235 ,p_budget_unit1_aggregate in varchar2 default hr_api.g_varchar2
236 ,p_budget_unit2_aggregate in varchar2 default hr_api.g_varchar2
237 ,p_budget_unit3_aggregate in varchar2 default hr_api.g_varchar2
238 ,p_position_control_flag in varchar2 default hr_api.g_varchar2
239 ,p_valid_grade_reqd_flag in varchar2 default hr_api.g_varchar2
240 ,p_currency_code in varchar2 default hr_api.g_varchar2
241 ,p_dflt_budget_set_id in number default hr_api.g_number
242 ,p_effective_date in date
243 );
244 --
245 -- ----------------------------------------------------------------------------
246 -- |------------------------------< delete_budget >---------------------------|
247 -- ----------------------------------------------------------------------------
248 --
249 -- {Start Of Comments}
250 /*#
251 * This API deletes the budget.
252 *
253 * Budget information will be deleted.
254 *
255 * <p><b>Licensing</b><br>
256 * This API is licensed for use with Human Resources.
257 *
258 * <p><b>Prerequisites</b><br>
259 * Budget to be deleted should already exist.
260 *
261 * <p><b>Post Success</b><br>
262 * Budget information will be deleted from the database.
263 *
264 * <p><b>Post Failure</b><br>
265 * Budget information will not be deleted and an error will be raised.
266 * @param p_validate If true, then validation alone will be performed and the
267 * database will remain unchanged. If false and all validation checks pass,
268 * then the database will be modified.
269 * @param p_budget_id This uniquely identifies the budget.
270 * @param p_object_version_number Current version number of the budget to be
271 * deleted.
272 * @param p_effective_date Reference date for validating lookup values are
273 * applicable during the start to end active date range. This date does not
274 * determine when the changes take effect.
275 * @rep:displayname Delete Budget
276 * @rep:category BUSINESS_ENTITY HR_BUDGET
277 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
278 * @rep:scope public
279 * @rep:lifecycle active
280 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
281 */
282 --
283 -- {End Of Comments}
284 --
285 procedure delete_budget
286 (
287 p_validate in boolean default false
288 ,p_budget_id in number
289 ,p_object_version_number in number
290 ,p_effective_date in date
291 );
292 --
293 end pqh_budgets_api;
[Home] [Help]