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