1 Package ota_tmt_api AUTHID CURRENT_USER as
2 /* $Header: ottmtapi.pkh 120.1 2005/10/02 02:08:25 aroussel $ */
3 /*#
4 * This package contains the measurement type APIs for use by Organization
5 * Training Plans.
6 * @rep:scope public
7 * @rep:product ota
8 * @rep:displayname Measurement Type
9 */
10 --
11 -- ----------------------------------------------------------------------------
12 -- |------------------------------< create_measure >--------------------------|
13 -- ----------------------------------------------------------------------------
14 --
15 -- {Start Of Comments}
16 /*#
17 * This API creates a measurement type.
18 *
19 * The created measurement type is used against budget or cost values within
20 * the Organization Training Plans functionality.
21 *
22 * <p><b>Licensing</b><br>
23 * This API is licensed for use with Learning Management.
24 *
25 * <p><b>Prerequisites</b><br>
26 * The referenced values must exist in the database.
27 *
28 * <p><b>Post Success</b><br>
29 * The measurement type is successfully created.
30 *
31 * <p><b>Post Failure</b><br>
32 * The API does not create a measurement type, and raises an error.
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_effective_date Reference date for validating lookup values are
37 * applicable during the start to end active date range. This date does not
38 * determine when the changes take effect.
39 * @param p_business_group_id The business group owning the measurement type.
40 * @param p_tp_measurement_code What the measure is measuring. Valid values
41 * exist in the 'OTA_PLAN_MEASUREMENT_TYPE' lookup type.
42 * @param p_unit The units of measure. Valid values are 'I', 'M','N', from the
43 * 'UNITS' lookup type.
44 * @param p_budget_level The level at which this can be used for budgeting.
45 * Valid values exist in the 'OTA_TRAINING_PLAN_BUDGET_LEVEL' lookup type.
46 * @param p_cost_level The level at which this can be used for recording costs.
47 * Valid values exist in the 'OTA_TRAINING_PLAN_COST_LEVEL' lookup type.
48 * @param p_many_budget_values_flag If many budget values can be recorded
49 * against one budget, this allows breakdowns of budget values.
50 * @param p_reporting_sequence The sort order to report measures.
51 * @param p_item_type_usage_id The calculation function used to derive cost
52 * values.
53 * @param p_attribute_category This context value determines which flexfield
54 * structure to use with the descriptive flexfield segments.
55 * @param p_attribute1 Descriptive flexfield segment.
56 * @param p_attribute2 Descriptive flexfield segment.
57 * @param p_attribute3 Descriptive flexfield segment.
58 * @param p_attribute4 Descriptive flexfield segment.
59 * @param p_attribute5 Descriptive flexfield segment.
60 * @param p_attribute6 Descriptive flexfield segment.
61 * @param p_attribute7 Descriptive flexfield segment.
62 * @param p_attribute8 Descriptive flexfield segment.
63 * @param p_attribute9 Descriptive flexfield segment.
64 * @param p_attribute10 Descriptive flexfield segment.
65 * @param p_attribute11 Descriptive flexfield segment.
66 * @param p_attribute12 Descriptive flexfield segment.
67 * @param p_attribute13 Descriptive flexfield segment.
68 * @param p_attribute14 Descriptive flexfield segment.
69 * @param p_attribute15 Descriptive flexfield segment.
70 * @param p_attribute16 Descriptive flexfield segment.
71 * @param p_attribute17 Descriptive flexfield segment.
72 * @param p_attribute18 Descriptive flexfield segment.
73 * @param p_attribute19 Descriptive flexfield segment.
74 * @param p_attribute20 Descriptive flexfield segment.
78 * @param p_attribute24 Descriptive flexfield segment.
75 * @param p_attribute21 Descriptive flexfield segment.
76 * @param p_attribute22 Descriptive flexfield segment.
77 * @param p_attribute23 Descriptive flexfield segment.
79 * @param p_attribute25 Descriptive flexfield segment.
80 * @param p_attribute26 Descriptive flexfield segment.
81 * @param p_attribute27 Descriptive flexfield segment.
82 * @param p_attribute28 Descriptive flexfield segment.
83 * @param p_attribute29 Descriptive flexfield segment.
84 * @param p_attribute30 Descriptive flexfield segment.
85 * @param p_tp_measurement_type_id If p_validate is false, then the ID is set
86 * to the unique identifier for the created measurement type. If p_validate is
87 * true, then it is null.
88 * @param p_object_version_number If p_validate is false, then set to the
89 * version number of the created measurement type. If p_validate is true, then
90 * the value will be null.
91 * @rep:displayname Create Measurement Type
92 * @rep:category BUSINESS_ENTITY OTA_TRAINING_PLAN
93 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
94 * @rep:scope public
95 * @rep:lifecycle active
96 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
97 */
98 --
99 -- {End Of Comments}
100 --
101 procedure Create_measure
102 (p_validate in boolean default false
103 ,p_effective_date in date
104 ,p_business_group_id in number
105 ,p_tp_measurement_code in varchar2
106 ,p_unit in varchar2
107 ,p_budget_level in varchar2
108 ,p_cost_level in varchar2
109 ,p_many_budget_values_flag in varchar2
110 ,p_reporting_sequence in number default null
111 ,p_item_type_usage_id in number default null
112 ,p_attribute_category in varchar2 default null
113 ,p_attribute1 in varchar2 default null
114 ,p_attribute2 in varchar2 default null
115 ,p_attribute3 in varchar2 default null
116 ,p_attribute4 in varchar2 default null
117 ,p_attribute5 in varchar2 default null
118 ,p_attribute6 in varchar2 default null
119 ,p_attribute7 in varchar2 default null
120 ,p_attribute8 in varchar2 default null
121 ,p_attribute9 in varchar2 default null
122 ,p_attribute10 in varchar2 default null
123 ,p_attribute11 in varchar2 default null
124 ,p_attribute12 in varchar2 default null
125 ,p_attribute13 in varchar2 default null
126 ,p_attribute14 in varchar2 default null
127 ,p_attribute15 in varchar2 default null
128 ,p_attribute16 in varchar2 default null
129 ,p_attribute17 in varchar2 default null
130 ,p_attribute18 in varchar2 default null
131 ,p_attribute19 in varchar2 default null
132 ,p_attribute20 in varchar2 default null
133 ,p_attribute21 in varchar2 default null
134 ,p_attribute22 in varchar2 default null
135 ,p_attribute23 in varchar2 default null
136 ,p_attribute24 in varchar2 default null
137 ,p_attribute25 in varchar2 default null
138 ,p_attribute26 in varchar2 default null
139 ,p_attribute27 in varchar2 default null
140 ,p_attribute28 in varchar2 default null
141 ,p_attribute29 in varchar2 default null
142 ,p_attribute30 in varchar2 default null
143 ,p_tp_measurement_type_id out nocopy number
144 ,p_object_version_number out nocopy number
145 );
146 --
147 -- ----------------------------------------------------------------------------
148 -- |------------------------------< update_measure >--------------------------|
149 -- ----------------------------------------------------------------------------
150 --
151 -- {Start Of Comments}
152 /*#
153 * This API updates a measurement type.
154 *
155 *
156 * <p><b>Licensing</b><br>
157 * This API is licensed for use with Learning Management.
158 *
159 * <p><b>Prerequisites</b><br>
160 * The measurement type to be updated must exist.
161 *
162 * <p><b>Post Success</b><br>
163 * The measurement type is successfully updated.
164 *
165 * <p><b>Post Failure</b><br>
166 * The API does not update the measurement type, and raises an error.
167 * @param p_validate If true, then validation alone will be performed and the
168 * database will remain unchanged. If false and all validation checks pass,
169 * then the database will be modified.
170 * @param p_effective_date Reference date for validating lookup values are
171 * applicable during the start to end active date range. This date does not
172 * determine when the changes take effect.
173 * @param p_tp_measurement_type_id The unique identifier for the measurement
174 * type to be updated.
175 * @param p_object_version_number Pass in the current version number of the
176 * measurement type to be updated. When the API completes, if p_validate is
177 * false, will be set to the new version number of the updated measurement
178 * type. If p_validate is true will be set to the same value which is passed
179 * in.
180 * @param p_unit The units of measure. Valid values are 'I', 'M','N', from the
181 * 'UNITS' lookup type.
182 * @param p_budget_level The level at which this can be used for budgeting.
183 * Valid values exist in the 'OTA_TRAINING_PLAN_BUDGET_LEVEL' lookup type.
187 * against one budget, this allows breakdowns of budget values.
184 * @param p_cost_level The level at which this can be used for recording costs.
185 * Valid values exist in the 'OTA_TRAINING_PLAN_COST_LEVEL' lookup type.
186 * @param p_many_budget_values_flag If many budget values can be recorded
188 * @param p_reporting_sequence The sort order to report measures
189 * @param p_item_type_usage_id The calculation function used to derive cost
190 * values.
191 * @param p_attribute_category This context value determines which flexfield
192 * structure to use with the descriptive flexfield segments.
193 * @param p_attribute1 Descriptive flexfield segment.
194 * @param p_attribute2 Descriptive flexfield segment.
195 * @param p_attribute3 Descriptive flexfield segment.
196 * @param p_attribute4 Descriptive flexfield segment.
197 * @param p_attribute5 Descriptive flexfield segment.
198 * @param p_attribute6 Descriptive flexfield segment.
199 * @param p_attribute7 Descriptive flexfield segment.
200 * @param p_attribute8 Descriptive flexfield segment.
201 * @param p_attribute9 Descriptive flexfield segment.
202 * @param p_attribute10 Descriptive flexfield segment.
203 * @param p_attribute11 Descriptive flexfield segment.
204 * @param p_attribute12 Descriptive flexfield segment.
205 * @param p_attribute13 Descriptive flexfield segment.
206 * @param p_attribute14 Descriptive flexfield segment.
207 * @param p_attribute15 Descriptive flexfield segment.
208 * @param p_attribute16 Descriptive flexfield segment.
209 * @param p_attribute17 Descriptive flexfield segment.
210 * @param p_attribute18 Descriptive flexfield segment.
211 * @param p_attribute19 Descriptive flexfield segment.
212 * @param p_attribute20 Descriptive flexfield segment.
213 * @param p_attribute21 Descriptive flexfield segment.
214 * @param p_attribute22 Descriptive flexfield segment.
215 * @param p_attribute23 Descriptive flexfield segment.
216 * @param p_attribute24 Descriptive flexfield segment.
217 * @param p_attribute25 Descriptive flexfield segment.
218 * @param p_attribute26 Descriptive flexfield segment.
219 * @param p_attribute27 Descriptive flexfield segment.
220 * @param p_attribute28 Descriptive flexfield segment.
221 * @param p_attribute29 Descriptive flexfield segment.
222 * @param p_attribute30 Descriptive flexfield segment.
223 * @rep:displayname Update Measurement Type
224 * @rep:category BUSINESS_ENTITY OTA_TRAINING_PLAN
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 Update_measure
234 (p_validate in boolean default false
235 ,p_effective_date in date
236 ,p_tp_measurement_type_id in number
237 ,p_object_version_number in out nocopy number
238 ,p_unit in varchar2 default hr_api.g_varchar2
239 ,p_budget_level in varchar2 default hr_api.g_varchar2
240 ,p_cost_level in varchar2 default hr_api.g_varchar2
241 ,p_many_budget_values_flag in varchar2 default hr_api.g_varchar2
242 ,p_reporting_sequence in number default hr_api.g_number
243 ,p_item_type_usage_id in number default hr_api.g_number
244 ,p_attribute_category in varchar2 default hr_api.g_varchar2
245 ,p_attribute1 in varchar2 default hr_api.g_varchar2
246 ,p_attribute2 in varchar2 default hr_api.g_varchar2
247 ,p_attribute3 in varchar2 default hr_api.g_varchar2
248 ,p_attribute4 in varchar2 default hr_api.g_varchar2
249 ,p_attribute5 in varchar2 default hr_api.g_varchar2
250 ,p_attribute6 in varchar2 default hr_api.g_varchar2
251 ,p_attribute7 in varchar2 default hr_api.g_varchar2
252 ,p_attribute8 in varchar2 default hr_api.g_varchar2
253 ,p_attribute9 in varchar2 default hr_api.g_varchar2
254 ,p_attribute10 in varchar2 default hr_api.g_varchar2
255 ,p_attribute11 in varchar2 default hr_api.g_varchar2
256 ,p_attribute12 in varchar2 default hr_api.g_varchar2
257 ,p_attribute13 in varchar2 default hr_api.g_varchar2
258 ,p_attribute14 in varchar2 default hr_api.g_varchar2
259 ,p_attribute15 in varchar2 default hr_api.g_varchar2
260 ,p_attribute16 in varchar2 default hr_api.g_varchar2
261 ,p_attribute17 in varchar2 default hr_api.g_varchar2
262 ,p_attribute18 in varchar2 default hr_api.g_varchar2
263 ,p_attribute19 in varchar2 default hr_api.g_varchar2
264 ,p_attribute20 in varchar2 default hr_api.g_varchar2
265 ,p_attribute21 in varchar2 default hr_api.g_varchar2
266 ,p_attribute22 in varchar2 default hr_api.g_varchar2
267 ,p_attribute23 in varchar2 default hr_api.g_varchar2
268 ,p_attribute24 in varchar2 default hr_api.g_varchar2
269 ,p_attribute25 in varchar2 default hr_api.g_varchar2
270 ,p_attribute26 in varchar2 default hr_api.g_varchar2
271 ,p_attribute27 in varchar2 default hr_api.g_varchar2
272 ,p_attribute28 in varchar2 default hr_api.g_varchar2
273 ,p_attribute29 in varchar2 default hr_api.g_varchar2
274 ,p_attribute30 in varchar2 default hr_api.g_varchar2
275 );
276 --
277 -- ----------------------------------------------------------------------------
278 -- |------------------------------< delete_measure >--------------------------|
279 -- ----------------------------------------------------------------------------
280 --
281 -- {Start Of Comments}
282 /*#
283 * This API deletes a measurement type used for recording budget or cost values
284 * within an OTA organization training plan.
285 *
286 *
287 * <p><b>Licensing</b><br>
288 * This API is licensed for use with Learning Management.
289 *
290 * <p><b>Prerequisites</b><br>
291 * The measurement type to be deleted must exist.
292 *
293 * <p><b>Post Success</b><br>
294 * The measurement type is successfully deleted from the database.
295 *
296 * <p><b>Post Failure</b><br>
297 * The API does not update the measurement type, and raises an error.
298 * @param p_validate If true, then validation alone will be performed and the
299 * database will remain unchanged. If false and all validation checks pass,
300 * then the database will be modified.
301 * @param p_tp_measurement_type_id The unique identifier for the measurement
302 * type to be deleted.
303 * @param p_object_version_number Current version number of the measurement
304 * type to be deleted.
305 * @rep:displayname Delete Measurement Type
306 * @rep:category BUSINESS_ENTITY OTA_TRAINING_PLAN
307 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
308 * @rep:scope public
309 * @rep:lifecycle active
310 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
311 */
312 --
313 -- {End Of Comments}
314 --
315 procedure delete_measure
316 (p_validate in boolean default false
317 ,p_tp_measurement_type_id in number
318 ,p_object_version_number in number
319 );
320 end ota_tmt_api;
[Home] [Help]