1 Package pqh_budget_versions_api as
2 /* $Header: pqbvrapi.pkh 120.1 2005/10/02 02:26:21 aroussel $ */
3 /*#
4 * This package contains APIs to create, update or delete budget versions.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Budget Version
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |--------------------------< create_budget_version >-----------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates the budget version.
17 *
18 * Budget for a date range is created. An existing budget is divided into
19 * different versions. Each version has a date range. In order to successfully
20 * run reports, create a budget version that is valid for the budget and is
21 * within the budget end date.
22 *
23 * <p><b>Licensing</b><br>
24 * This API is licensed for use with Human Resources.
25 *
26 * <p><b>Prerequisites</b><br>
27 * A budget should already exist.
28 *
29 * <p><b>Post Success</b><br>
30 * Budget version will be inserted in the database.
31 *
32 * <p><b>Post Failure</b><br>
33 * Budget version 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_version_id If p_validate is false, then this uniquely
38 * identifies the budget version record created. If p_validate is true, then
39 * set to null.
40 * @param p_budget_id Budget identifier.
41 * @param p_version_number Budget version number.
42 * @param p_date_from Budget start date.
43 * @param p_date_to Budget end date.
44 * @param p_transfered_to_gl_flag Indicates version transfer to GL allowed or
45 * not. Valid values are defined by 'YES_NO' lookup type.
46 * @param p_gl_status GL posting status. Possible values are Post, Error or
47 * Null.
48 * @param p_xfer_to_other_apps_cd Indicates the transfer to other applications.
49 * Valid values are defined by 'YES_NO' lookup type.
50 * @param p_object_version_number If p_validate is false, then set to the
51 * version number of the created budget version. If p_validate is true, then
52 * the value will be null.
53 * @param p_budget_unit1_value {@rep:casecolumn
54 * PQH_BUDGET_VERSIONS.BUDGET_UNIT1_VALUE}
55 * @param p_budget_unit2_value {@rep:casecolumn
56 * PQH_BUDGET_VERSIONS.BUDGET_UNIT2_VALUE}
57 * @param p_budget_unit3_value {@rep:casecolumn
58 * PQH_BUDGET_VERSIONS.BUDGET_UNIT3_VALUE}
59 * @param p_budget_unit1_available {@rep:casecolumn
60 * PQH_BUDGET_VERSIONS.BUDGET_UNIT1_AVAILABLE}
61 * @param p_budget_unit2_available {@rep:casecolumn
62 * PQH_BUDGET_VERSIONS.BUDGET_UNIT2_AVAILABLE}
63 * @param p_budget_unit3_available {@rep:casecolumn
64 * PQH_BUDGET_VERSIONS.BUDGET_UNIT3_AVAILABLE}
65 * @param p_effective_date Reference date for validating lookup values are
66 * applicable during the start to end active date range. This date does not
67 * determine when the changes take effect.
68 * @rep:displayname Create Budget Version
69 * @rep:category BUSINESS_ENTITY HR_BUDGET
70 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
71 * @rep:scope public
72 * @rep:lifecycle active
73 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
74 */
75 --
76 -- {End Of Comments}
77 --
78 procedure create_budget_version
79 (
80 p_validate in boolean default false
81 ,p_budget_version_id out nocopy number
82 ,p_budget_id in number default null
83 ,p_version_number in number default null
84 ,p_date_from in date default null
85 ,p_date_to in date default null
86 ,p_transfered_to_gl_flag in varchar2 default null
87 ,p_gl_status in varchar2 default null
88 ,p_xfer_to_other_apps_cd in varchar2 default null
89 ,p_object_version_number out nocopy number
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_available in number default null
94 ,p_budget_unit2_available in number default null
95 ,p_budget_unit3_available in number default null
96 ,p_effective_date in date
97 );
98 --
99 -- ----------------------------------------------------------------------------
100 -- |--------------------------< update_budget_version >-----------------------|
101 -- ----------------------------------------------------------------------------
102 --
103 -- {Start Of Comments}
104 /*#
105 * This API updates the budget version.
106 *
107 * Budget for a date range is updated. An existing budget is divided into
108 * different versions. Each version has a date range. In order to successfully
109 * run reports, update budget version in such a way that it is valid for the
110 * budget and is within the budget end date.
111 *
112 * <p><b>Licensing</b><br>
113 * This API is licensed for use with Human Resources.
114 *
115 * <p><b>Prerequisites</b><br>
116 * The budget version and the corresponding budget should be valid.
117 *
118 * <p><b>Post Success</b><br>
119 * Budget version will be updated in the database.
120 *
121 * <p><b>Post Failure</b><br>
122 * Budget version 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_version_id Identifies the budget version to be updated.
127 * @param p_budget_id Budget identifier.
128 * @param p_version_number Budget version number.
129 * @param p_date_from Budget start date.
130 * @param p_date_to Budget end date.
131 * @param p_transfered_to_gl_flag Indicates version transfer to GL allowed or
132 * not. Valid values are defined by 'YES_NO' lookup type.
133 * @param p_gl_status GL posting status. Possible values are Post, Error or
134 * Null.
135 * @param p_xfer_to_other_apps_cd Indicates the transfer to other applications.
136 * Valid values are defined by 'YES_NO' lookup type.
137 * @param p_object_version_number Pass in the current version number of the
138 * budget version to be updated. When the API completes if p_validate is false,
139 * will be set to the new version number of the updated budget version. If
140 * p_validate is true will be set to the same value which was passed in.
141 * @param p_budget_unit1_value {@rep:casecolumn
142 * PQH_BUDGET_VERSIONS.BUDGET_UNIT1_VALUE}
143 * @param p_budget_unit2_value {@rep:casecolumn
144 * PQH_BUDGET_VERSIONS.BUDGET_UNIT2_VALUE}
145 * @param p_budget_unit3_value {@rep:casecolumn
146 * PQH_BUDGET_VERSIONS.BUDGET_UNIT3_VALUE}
147 * @param p_budget_unit1_available {@rep:casecolumn
148 * PQH_BUDGET_VERSIONS.BUDGET_UNIT1_AVAILABLE}
149 * @param p_budget_unit2_available {@rep:casecolumn
150 * PQH_BUDGET_VERSIONS.BUDGET_UNIT2_AVAILABLE}
151 * @param p_budget_unit3_available {@rep:casecolumn
152 * PQH_BUDGET_VERSIONS.BUDGET_UNIT3_AVAILABLE}
153 * @param p_effective_date Reference date for validating lookup values are
154 * applicable during the start to end active date range. This date does not
155 * determine when the changes take effect.
156 * @rep:displayname Update Budget Version
157 * @rep:category BUSINESS_ENTITY HR_BUDGET
158 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
159 * @rep:scope public
160 * @rep:lifecycle active
161 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
162 */
163 --
164 -- {End Of Comments}
165 --
166 procedure update_budget_version
167 (
168 p_validate in boolean default false
169 ,p_budget_version_id in number
170 ,p_budget_id in number default hr_api.g_number
171 ,p_version_number in number default hr_api.g_number
172 ,p_date_from in date default hr_api.g_date
173 ,p_date_to in date default hr_api.g_date
174 ,p_transfered_to_gl_flag in varchar2 default hr_api.g_varchar2
175 ,p_gl_status in varchar2 default hr_api.g_varchar2
176 ,p_xfer_to_other_apps_cd in varchar2 default hr_api.g_varchar2
177 ,p_object_version_number in out nocopy number
178 ,p_budget_unit1_value in number default hr_api.g_number
179 ,p_budget_unit2_value in number default hr_api.g_number
180 ,p_budget_unit3_value in number default hr_api.g_number
181 ,p_budget_unit1_available in number default hr_api.g_number
182 ,p_budget_unit2_available in number default hr_api.g_number
183 ,p_budget_unit3_available in number default hr_api.g_number
184 ,p_effective_date in date
185 );
186 --
187 -- ----------------------------------------------------------------------------
188 -- |--------------------------< delete_budget_version >-----------------------|
189 -- ----------------------------------------------------------------------------
190 --
191 -- {Start Of Comments}
192 /*#
193 * This API deletes budget details record.
194 *
195 * Budget for a date range is deleted.
196 *
197 * <p><b>Licensing</b><br>
198 * This API is licensed for use with Human Resources.
199 *
200 * <p><b>Prerequisites</b><br>
201 * The budget version to be deleted should already exist.
202 *
203 * <p><b>Post Success</b><br>
204 * Budget version will be deleted from the database.
205 *
206 * <p><b>Post Failure</b><br>
207 * Budget version will not be deleted and an error will be raised.
208 * @param p_validate If true, then validation alone will be performed and the
209 * database will remain unchanged. If false and all validation checks pass,
210 * then the database will be modified.
211 * @param p_budget_version_id This uniquely identifies the budget version.
212 * @param p_object_version_number Current version number of the budget version
213 * to be deleted.
214 * @param p_effective_date Reference date for validating lookup values are
215 * applicable during the start to end active date range. This date does not
216 * determine when the changes take effect.
217 * @rep:displayname Delete Budget Version
218 * @rep:category BUSINESS_ENTITY HR_BUDGET
219 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
220 * @rep:scope public
221 * @rep:lifecycle active
222 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
223 */
224 --
225 -- {End Of Comments}
226 --
227 procedure delete_budget_version
228 (
229 p_validate in boolean default false
230 ,p_budget_version_id in number
231 ,p_object_version_number in number
232 ,p_effective_date in date
233 );
234 --
235 end pqh_budget_versions_api;
[Home] [Help]