1 Package pqh_budget_details_api AUTHID CURRENT_USER as
2 /* $Header: pqbdtapi.pkh 120.1 2005/10/02 02:25:37 aroussel $ */
3 /*#
4 * This package contains APIs to create, update and delete the budget details.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Budget Detail
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |---------------------------< create_budget_detail >-----------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates budget details.
17 *
18 * Enter a value for a budgeted entity like position, job, grade or
19 * organization, or calculate the value of a line item as a percentage of the
20 * total amount allocated for the budget measurement unit. The application
21 * supports the entry of currency values of any length with variable decimal
22 * point placement.
23 *
24 * <p><b>Licensing</b><br>
25 * This API is licensed for use with Human Resources.
26 *
27 * <p><b>Prerequisites</b><br>
28 * A valid budget version should already exist. The entities (organization,
29 * position, job or grade) for which the budget values are to be entered should
30 * already exist.
31 *
32 * <p><b>Post Success</b><br>
33 * Budget detail will be successfully created in the database.
34 *
35 * <p><b>Post Failure</b><br>
36 * Budget detail will not be created and an error will be raised.
37 * @param p_validate If true, then validation alone will be performed and the
38 * database will remain unchanged. If false and all validation checks pass,
39 * then the database will be modified.
40 * @param p_budget_detail_id If p_validate is false, then this uniquely
44 * @param p_job_id Identifies budgeted job.
41 * identifies the budget detail record created. If p_validate is true, then set
42 * to null.
43 * @param p_organization_id Identifies budgeted organization.
45 * @param p_position_id Identifies budgeted position.
46 * @param p_grade_id Identifies budgeted grade.
47 * @param p_budget_version_id Identifies budget version.
48 * @param p_budget_unit1_percent Budget unit 1 percentage.
49 * @param p_budget_unit1_value_type_cd Identifies the budget input value type.
50 * Valid values are defined by 'PQH_BUDGET_UNIT_VALUE_TYPE' lookup type.
51 * @param p_budget_unit1_value Budget unit 1 value.
52 * @param p_budget_unit1_available {@rep:casecolumn
53 * PQH_BUDGET_DETAILS.BUDGET_UNIT1_AVAILABLE}
54 * @param p_budget_unit2_percent Budget unit 2 percentage.
55 * @param p_budget_unit2_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 Budget unit 2 value.
58 * @param p_budget_unit2_available {@rep:casecolumn
59 * PQH_BUDGET_DETAILS.BUDGET_UNIT2_AVAILABLE}
60 * @param p_budget_unit3_percent Budget unit 3 percentage.
61 * @param p_budget_unit3_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_unit3_value Budget unit 3 value.
64 * @param p_budget_unit3_available {@rep:casecolumn
65 * PQH_BUDGET_DETAILS.BUDGET_UNIT3_AVAILABLE}
66 * @param p_gl_status Posting to GL status. Possible values are Post, Error or
67 * Null.
68 * @param p_object_version_number If p_validate is false, then set to the
69 * version number of the created budget element. If p_validate is true, then
70 * the value will be null.
71 * @rep:displayname Create Budget Detail
72 * @rep:category BUSINESS_ENTITY HR_BUDGET
73 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
74 * @rep:scope public
75 * @rep:lifecycle active
76 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
77 */
78 --
79 -- {End Of Comments}
80 --
81 procedure create_budget_detail
82 (
83 p_validate in boolean default false
84 ,p_budget_detail_id out nocopy number
85 ,p_organization_id in number default null
86 ,p_job_id in number default null
87 ,p_position_id in number default null
88 ,p_grade_id in number default null
89 ,p_budget_version_id in number default null
90 ,p_budget_unit1_percent in number default null
91 ,p_budget_unit1_value_type_cd in varchar2 default null
92 ,p_budget_unit1_value in number default null
93 ,p_budget_unit1_available in number default null
94 ,p_budget_unit2_percent in number default null
95 ,p_budget_unit2_value_type_cd in varchar2 default null
96 ,p_budget_unit2_value in number default null
97 ,p_budget_unit2_available in number default null
98 ,p_budget_unit3_percent in number default null
99 ,p_budget_unit3_value_type_cd in varchar2 default null
100 ,p_budget_unit3_value in number default null
101 ,p_budget_unit3_available in number default null
102 ,p_gl_status in varchar2 default null
103 ,p_object_version_number out nocopy number
104 );
105 --
106 -- ----------------------------------------------------------------------------
107 -- |---------------------------< update_budget_detail >-----------------------|
108 -- ----------------------------------------------------------------------------
109 --
110 -- {Start Of Comments}
111 /*#
112 * This API updates budget details.
113 *
114 * Update a value or percentage for a entity like position, job, grade or
115 * organization, or update the entity itself.
116 *
117 * <p><b>Licensing</b><br>
118 * This API is licensed for use with Human Resources.
119 *
120 * <p><b>Prerequisites</b><br>
121 * Budget detail record to be updated should already exist. The entities
122 * (organization, position, job or grade) should be valid.
123 *
124 * <p><b>Post Success</b><br>
125 * Budget detail will be successfully updated in the database.
126 *
127 * <p><b>Post Failure</b><br>
128 * Budget detail will not be updated and an error will be raised.
129 * @param p_validate If true, then validation alone will be performed and the
130 * database will remain unchanged. If false and all validation checks pass,
131 * then the database will be modified.
132 * @param p_budget_detail_id Identifies the budget detail record updated.
133 * @param p_organization_id Identifies budgeted organization.
134 * @param p_job_id Identifies budgeted job.
135 * @param p_position_id Identifies budgeted position.
136 * @param p_grade_id Identifies budgeted grade.
137 * @param p_budget_version_id Identifies budget version.
138 * @param p_budget_unit1_percent Budget unit 1 percentage.
139 * @param p_budget_unit1_value_type_cd Identifies the budget input value type.
140 * Valid values are defined by 'PQH_BUDGET_UNIT_VALUE_TYPE' lookup type.
141 * @param p_budget_unit1_value Budget unit 1 value.
142 * @param p_budget_unit1_available {@rep:casecolumn
143 * PQH_BUDGET_DETAILS.BUDGET_UNIT1_AVAILABLE}
144 * @param p_budget_unit2_percent Budget unit 2 percentage.
145 * @param p_budget_unit2_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 Budget unit 2 value.
148 * @param p_budget_unit2_available {@rep:casecolumn
149 * PQH_BUDGET_DETAILS.BUDGET_UNIT2_AVAILABLE}
150 * @param p_budget_unit3_percent Budget unit 3 percentage.
154 * @param p_budget_unit3_available {@rep:casecolumn
151 * @param p_budget_unit3_value_type_cd Identifies the budget input value type.
152 * Valid values are defined by 'PQH_BUDGET_UNIT_VALUE_TYPE' lookup type.
153 * @param p_budget_unit3_value Budget unit 3 value.
155 * PQH_BUDGET_DETAILS.BUDGET_UNIT3_AVAILABLE}
156 * @param p_gl_status Posting to GL status. Possible values are Post, Error or
157 * Null.
158 * @param p_object_version_number Pass in the current version number of the
159 * budget detail to be updated. When the API completes if p_validate is false,
160 * will be set to the new version number of the updated budget detail. If
161 * p_validate is true will be set to the same value which was passed in.
162 * @rep:displayname Update Budget Detail
163 * @rep:category BUSINESS_ENTITY HR_BUDGET
164 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
165 * @rep:scope public
166 * @rep:lifecycle active
167 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
168 */
169 --
170 -- {End Of Comments}
171 --
172 procedure update_budget_detail
173 (
174 p_validate in boolean default false
175 ,p_budget_detail_id in number
176 ,p_organization_id in number default hr_api.g_number
177 ,p_job_id in number default hr_api.g_number
178 ,p_position_id in number default hr_api.g_number
179 ,p_grade_id in number default hr_api.g_number
180 ,p_budget_version_id in number default hr_api.g_number
181 ,p_budget_unit1_percent in number default hr_api.g_number
182 ,p_budget_unit1_value_type_cd in varchar2 default hr_api.g_varchar2
183 ,p_budget_unit1_value in number default hr_api.g_number
184 ,p_budget_unit1_available in number default hr_api.g_number
185 ,p_budget_unit2_percent in number default hr_api.g_number
186 ,p_budget_unit2_value_type_cd in varchar2 default hr_api.g_varchar2
187 ,p_budget_unit2_value in number default hr_api.g_number
188 ,p_budget_unit2_available in number default hr_api.g_number
189 ,p_budget_unit3_percent in number default hr_api.g_number
190 ,p_budget_unit3_value_type_cd in varchar2 default hr_api.g_varchar2
191 ,p_budget_unit3_value in number default hr_api.g_number
192 ,p_budget_unit3_available in number default hr_api.g_number
193 ,p_gl_status in varchar2 default hr_api.g_varchar2
194 ,p_object_version_number in out nocopy number
195 );
196 --
197 -- ----------------------------------------------------------------------------
198 -- |---------------------------< delete_budget_detail >-----------------------|
199 -- ----------------------------------------------------------------------------
200 --
201 -- {Start Of Comments}
202 /*#
203 * This procedure deletes budget details record.
204 *
205 *
206 * <p><b>Licensing</b><br>
207 * This API is licensed for use with Human Resources.
208 *
209 * <p><b>Prerequisites</b><br>
210 * Budget detail record should already exist.
211 *
212 * <p><b>Post Success</b><br>
213 * Budget detail will be successfully deleted in the database.
214 *
215 * <p><b>Post Failure</b><br>
216 * Budget detail will not be deleted and an error will be raised.
217 * @param p_validate If true, then validation alone will be performed and the
218 * database will remain unchanged. If false and all validation checks pass,
219 * then the database will be modified.
220 * @param p_budget_detail_id This uniquely identifies the budget detail.
221 * @param p_object_version_number Current version number of the budget detail
222 * to be deleted.
223 * @rep:displayname Delete Budget Detail
224 * @rep:category BUSINESS_ENTITY HR_BUDGET
225 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
226 * @rep:scope public
227 * @rep:lifecycle active
228 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
229 */
230 --
231 -- {End Of Comments}
232 --
233 procedure delete_budget_detail
234 (
235 p_validate in boolean default false
236 ,p_budget_detail_id in number
237 ,p_object_version_number in number
238 );
239 --
240 end pqh_budget_details_api;
[Home] [Help]