1 Package pqh_bdgt_cmmtmnt_elmnts_api as
2 /* $Header: pqbceapi.pkh 120.1 2005/10/02 02:25:33 aroussel $ */
3 /*#
4 * This package contains APIs to create, update and delete the elements for
5 * Budget Commitments.
6 * @rep:scope public
7 * @rep:product per
8 * @rep:displayname Budget Commitment Element
9 */
10 --
11 -- ----------------------------------------------------------------------------
12 -- |------------------------< create_bdgt_cmmtmnt_elmnt >---------------------|
13 -- ----------------------------------------------------------------------------
14 --
15 -- {Start Of Comments}
16 /*#
17 * This API creates the elements for Budget Commitments.
18 *
19 * The elements created are used for computing commitments for a budget.
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 * The budget should already exist. There should be valid elements created.
26 *
27 * <p><b>Post Success</b><br>
28 * Commitment element for a budget will be successfully inserted in the
29 * database.
30 *
31 * <p><b>Post Failure</b><br>
32 * The commitment element will not be created and an error will be raised.
33 * @param p_validate If true, then validation alone will be performed and the
34 * database will remain unchanged. If false and all validation checks pass,
35 * then the database will be modified.
36 * @param p_bdgt_cmmtmnt_elmnt_id If p_validate is false, then this uniquely
37 * identifies the commitment element created. If p_validate is true, then set
38 * to null.
39 * @param p_budget_id Identifies the budget for which the element record is
40 * created.
41 * @param p_actual_commitment_type Identifies if the defined element should be
42 * used for actual or commitment computation or both.
43 * @param p_element_type_id {@rep:casecolumn
44 * PQH_BDGT_CMMTMNT_ELMNTS.ELEMENT_TYPE_ID}
45 * @param p_salary_basis_flag Indicates if salary basis is used for commitment
46 * computation. Valid values are defined by 'YES_NO'lookup type.
47 * @param p_element_input_value_id Identifies element input value.
48 * @param p_balance_type_id Balance type to be used for actuals computation.
49 * @param p_frequency_input_value_id Identifies frequency input value.
50 * @param p_formula_id Identifies formula.
51 * @param p_dflt_elmnt_frequency {@rep:casecolumn
52 * PQH_BDGT_CMMTMNT_ELMNTS.DFLT_ELMNT_FREQUENCY}
53 * @param p_overhead_percentage Tolerance to be added to commitment element
54 * amount.
55 * @param p_object_version_number If p_validate is false, then set to the
56 * version number of the created element. If p_validate is true, then the value
57 * will be null.
58 * @param p_effective_date Reference date for validating lookup values are
59 * applicable during the start to end active date range. This date does not
60 * determine when the changes take effect.
61 * @rep:displayname Create Budget Commitment Element
62 * @rep:category BUSINESS_ENTITY HR_BUDGET
63 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
64 * @rep:scope public
65 * @rep:lifecycle active
66 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
67 */
68 --
69 -- {End Of Comments}
70 --
71 procedure create_bdgt_cmmtmnt_elmnt
72 (
73 p_validate in boolean default false
74 ,p_bdgt_cmmtmnt_elmnt_id out nocopy number
75 ,p_budget_id in number default null
76 ,p_actual_commitment_type in varchar2 default null
77 ,p_element_type_id in number default null
78 ,p_salary_basis_flag in varchar2 default 'N'
79 ,p_element_input_value_id in number default null
80 ,p_balance_type_id in number default null
81 ,p_frequency_input_value_id in number default null
82 ,p_formula_id in number default null
83 ,p_dflt_elmnt_frequency in varchar2 default null
84 ,p_overhead_percentage in number default null
85 ,p_object_version_number out nocopy number
86 ,p_effective_date in date
87 );
88 --
89 -- ----------------------------------------------------------------------------
90 -- |------------------------< update_bdgt_cmmtmnt_elmnt >---------------------|
91 -- ----------------------------------------------------------------------------
92 --
93 -- {Start Of Comments}
94 /*#
95 * This API updates the elements for Budget Commitments.
96 *
97 * The element used for commitment computation of a budget can be changed to
98 * another element.
99 *
100 * <p><b>Licensing</b><br>
101 * This API is licensed for use with Human Resources.
102 *
103 * <p><b>Prerequisites</b><br>
104 * A valid budget commitment element must already exist to be able to update
105 * it.
106 *
107 * <p><b>Post Success</b><br>
108 * The commitment element details will be successfully updated.
109 *
110 * <p><b>Post Failure</b><br>
111 * The commitment element will not be updated and an error will be raised.
112 * @param p_validate If true, then validation alone will be performed and the
113 * database will remain unchanged. If false and all validation checks pass,
114 * then the database will be modified.
115 * @param p_bdgt_cmmtmnt_elmnt_id This uniquely identifies the commitment
116 * element record that needs to be updated.
117 * @param p_budget_id Identifies the budget for which the element record is
118 * created.
119 * @param p_actual_commitment_type Identifies if the defined element should be
120 * used for actual or commitment computation or both.
121 * @param p_element_type_id Identifies the element type.
122 * @param p_salary_basis_flag Indicates if salary basis is used for commitment
123 * computation. Valid values are defined by 'YES_NO' lookup type.
124 * @param p_element_input_value_id Identifies element input value.
125 * @param p_balance_type_id Balance type to be used for actuals computation.
126 * @param p_frequency_input_value_id Identifies frequency input value.
127 * @param p_formula_id Identifies formula.
128 * @param p_dflt_elmnt_frequency {@rep:casecolumn
129 * PQH_BDGT_CMMTMNT_ELMNTS.DFLT_ELMNT_FREQUENCY}
130 * @param p_overhead_percentage Tolerance to be added to commitment element
131 * amount.
132 * @param p_object_version_number Pass in the current version number of the
133 * element to be updated. When the API completes if p_validate is false, will
134 * be set to the new version number of the updated element. If p_validate is
135 * true will be set to the same value which was passed in.
136 * @param p_effective_date Reference date for validating lookup values are
137 * applicable during the start to end active date range. This date does not
138 * determine when the changes take effect.
139 * @rep:displayname Update Budget Commitment Element
140 * @rep:category BUSINESS_ENTITY HR_BUDGET
141 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
142 * @rep:scope public
143 * @rep:lifecycle active
144 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
145 */
146 --
147 -- {End Of Comments}
148 --
149 procedure update_bdgt_cmmtmnt_elmnt
150 (
151 p_validate in boolean default false
152 ,p_bdgt_cmmtmnt_elmnt_id in number
153 ,p_budget_id in number default hr_api.g_number
154 ,p_actual_commitment_type in varchar2 default hr_api.g_varchar2
155 ,p_element_type_id in number default hr_api.g_number
156 ,p_salary_basis_flag in varchar2 default hr_api.g_varchar2
157 ,p_element_input_value_id in number default hr_api.g_number
158 ,p_balance_type_id in number default hr_api.g_number
159 ,p_frequency_input_value_id in number default hr_api.g_number
160 ,p_formula_id in number default hr_api.g_number
161 ,p_dflt_elmnt_frequency in varchar2 default hr_api.g_varchar2
162 ,p_overhead_percentage in number default hr_api.g_number
163 ,p_object_version_number in out nocopy number
164 ,p_effective_date in date
165 );
166 --
167 -- ----------------------------------------------------------------------------
168 -- |------------------------< delete_bdgt_cmmtmnt_elmnt >---------------------|
169 -- ----------------------------------------------------------------------------
170 --
171 -- {Start Of Comments}
172 /*#
173 * This API deletes the element created for Budget Commitments.
174 *
175 *
176 * <p><b>Licensing</b><br>
177 * This API is licensed for use with Human Resources.
178 *
179 * <p><b>Prerequisites</b><br>
180 * A valid budget commitment element must already exist to be able to delete
181 * it.
182 *
183 * <p><b>Post Success</b><br>
184 * Budget commitment element will be successfully deleted.
185 *
186 * <p><b>Post Failure</b><br>
187 * Commitment element for a budget will not be deleted and an error will be
188 * raised.
189 * @param p_validate If true, then validation alone will be performed and the
190 * database will remain unchanged. If false and all validation checks pass,
191 * then the database will be modified.
192 * @param p_bdgt_cmmtmnt_elmnt_id This uniquely identifies the budget
193 * commitment element.
194 * @param p_object_version_number Current version number of the element to be
195 * deleted.
196 * @param p_effective_date Reference date for validating lookup values are
197 * applicable during the start to end active date range. This date does not
198 * determine when the changes take effect.
199 * @rep:displayname Delete Budget Commitment Element
200 * @rep:category BUSINESS_ENTITY HR_BUDGET
201 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
202 * @rep:scope public
203 * @rep:lifecycle active
204 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
205 */
206 --
207 -- {End Of Comments}
208 --
209 procedure delete_bdgt_cmmtmnt_elmnt
210 (
211 p_validate in boolean default false
212 ,p_bdgt_cmmtmnt_elmnt_id in number
213 ,p_object_version_number in number
214 ,p_effective_date in date
215 );
216 --
217 end pqh_bdgt_cmmtmnt_elmnts_api;
[Home] [Help]