1 Package OTA_NHS_API as
2 /* $Header: otnhsapi.pkh 120.2 2006/01/09 03:19:33 dbatra noship $ */
3 /*#
4 * This package creates and updates a user's external learning.
5 * @rep:scope public
6 * @rep:product ota
7 * @rep:displayname External Learning
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |--------------------------< <create_non_ota_histories> >--------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a user's external learning.
17 *
18 * This API, called from both OAF and the PUI, inserts records in the
19 * OTA_NOTRNG_HISTORIES table.
20 *
21 * <p><b>Licensing</b><br>
22 * This API is licensed for use with Learning Management.
23 *
24 * <p><b>Prerequisites</b><br>
25 * User should be a valid employee on effective date
26 *
27 * <p><b>Post Success</b><br>
28 * External Learning record for the user is created in the database
29 *
30 * <p><b>Post Failure</b><br>
31 * External Learning record is not created for the user and an error is raised
32 * @param p_validate If true, then validation alone will be performed and the
33 * database will remain unchanged. If false and all validation checks pass,
34 * then the database will be modified.
35 * @param p_effective_date Reference date for validating lookup values are
36 * applicable during the start to end active date range. This date does not
37 * determine when the changes take effect.
38 * @param p_nota_history_id If p_validate is false then this uniquely
39 * identifies the external learning created. If p_validate is true, then set to
40 * null.
41 * @param p_person_id Identifies the person for whom you create the external
42 * learning record.
43 * @param p_contact_id {@rep:casecolumn OTA_NOTRNG_HISTORIES.CONTACT_ID}
44 * @param p_trng_title {@rep:casecolumn OTA_NOTRNG_HISTORIES.TRNG_TITLE}
45 * @param p_provider {@rep:casecolumn OTA_NOTRNG_HISTORIES.PROVIDER}
46 * @param p_type External Learning's type. Valid values are defined by the
47 * 'OTA_TRAINING_TYPES' lookup type.
48 * @param p_centre {@rep:casecolumn OTA_NOTRNG_HISTORIES.CENTRE}
49 * @param p_completion_date {@rep:casecolumn
50 * OTA_NOTRNG_HISTORIES.COMPLETION_DATE}
51 * @param p_award {@rep:casecolumn OTA_NOTRNG_HISTORIES.AWARD}
52 * @param p_rating {@rep:casecolumn OTA_NOTRNG_HISTORIES.RATING}
53 * @param p_duration {@rep:casecolumn OTA_NOTRNG_HISTORIES.DURATION}
54 * @param p_duration_units External Learning's duration units. Valid values are
55 * defined by 'OTA_DURATION_UNITS' lookup type.
56 * @param p_activity_version_id The unique identifier of the equivalent Course
57 * @param p_status External Learning's Status.Valid values are defined by
58 * 'OTA_TRAINING_STATUSES' lookup type.
59 * @param p_verified_by_id {@rep:casecolumn
60 * OTA_NOTRNG_HISTORIES.VERIFIED_BY_ID}
61 * @param p_nth_information_category This context value determines which
62 * Flexfield Structure to use with the Descriptive flexfield segments.
63 * @param p_nth_information1 Descriptive flexfield segment.
64 * @param p_nth_information2 Descriptive flexfield segment.
65 * @param p_nth_information3 Descriptive flexfield segment.
66 * @param p_nth_information4 Descriptive flexfield segment.
67 * @param p_nth_information5 Descriptive flexfield segment.
68 * @param p_nth_information6 Descriptive flexfield segment.
69 * @param p_nth_information7 Descriptive flexfield segment.
70 * @param p_nth_information8 Descriptive flexfield segment.
71 * @param p_nth_information9 Descriptive flexfield segment.
72 * @param p_nth_information10 Descriptive flexfield segment.
73 * @param p_nth_information11 Descriptive flexfield segment.
74 * @param p_nth_information12 Descriptive flexfield segment.
75 * @param p_nth_information13 Descriptive flexfield segment.
76 * @param p_nth_information15 Descriptive flexfield segment.
77 * @param p_nth_information16 Descriptive flexfield segment.
78 * @param p_nth_information17 Descriptive flexfield segment.
79 * @param p_nth_information18 Descriptive flexfield segment.
80 * @param p_nth_information19 Descriptive flexfield segment.
81 * @param p_nth_information20 Descriptive flexfield segment.
82 * @param p_org_id {@rep:casecolumn OTA_NOTRNG_HISTORIES.ORG_ID}
83 * @param p_object_version_number If p_validate is false, then set to the
84 * version number of the created external learning. If p_validate is true, then
85 * the value will be null.
86 * @param p_business_group_id {@rep:casecolumn
87 * OTA_NOTRNG_HISTORIES.BUSINESS_GROUP_ID}
88 * @param p_nth_information14 Descriptive flexfield segment.
89 * @param p_customer_id {@rep:casecolumn OTA_NOTRNG_HISTORIES.CUSTOMER_ID}
90 * @param p_organization_id {@rep:casecolumn
91 * OTA_NOTRNG_HISTORIES.ORGANIZATION_ID}
92 * @param p_some_warning If set to true then one of the business logic
93 * validations has failed
94 * @rep:displayname Create External Learning
95 * @rep:category BUSINESS_ENTITY OTA_LEARNING_EXTERNAL
96 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
97 * @rep:scope public
98 * @rep:lifecycle active
99 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
100 */
101 --
102 -- {End Of Comments}
103 --
104 procedure create_non_ota_histories
105 (p_validate in boolean default false
106 ,p_effective_date in date
107 ,p_nota_history_id out nocopy number
108 ,p_person_id in number
109 ,p_contact_id in number default null
110 ,p_trng_title in varchar2
111 ,p_provider in varchar2
112 ,p_type in varchar2 default null
113 ,p_centre in varchar2 default null
114 ,p_completion_date in date
115 ,p_award in varchar2 default null
116 ,p_rating in varchar2 default null
117 ,p_duration in number default null
118 ,p_duration_units in varchar2 default null
119 ,p_activity_version_id in number default null
120 ,p_status in varchar2 default null
121 ,p_verified_by_id in number default null
122 ,p_nth_information_category in varchar2 default null
123 ,p_nth_information1 in varchar2 default null
124 ,p_nth_information2 in varchar2 default null
125 ,p_nth_information3 in varchar2 default null
126 ,p_nth_information4 in varchar2 default null
127 ,p_nth_information5 in varchar2 default null
128 ,p_nth_information6 in varchar2 default null
129 ,p_nth_information7 in varchar2 default null
130 ,p_nth_information8 in varchar2 default null
131 ,p_nth_information9 in varchar2 default null
132 ,p_nth_information10 in varchar2 default null
133 ,p_nth_information11 in varchar2 default null
134 ,p_nth_information12 in varchar2 default null
135 ,p_nth_information13 in varchar2 default null
136 ,p_nth_information15 in varchar2 default null
137 ,p_nth_information16 in varchar2 default null
138 ,p_nth_information17 in varchar2 default null
139 ,p_nth_information18 in varchar2 default null
140 ,p_nth_information19 in varchar2 default null
141 ,p_nth_information20 in varchar2 default null
142 ,p_org_id in number default null
143 ,p_object_version_number out nocopy number
144 ,p_business_group_id in number
145 ,p_nth_information14 in varchar2 default null
146 ,p_customer_id in number default null
147 ,p_organization_id in number default null
148 ,p_some_warning out nocopy boolean
149 );
150 --
151
152
153
154
155
156 -- ----------------------------------------------------------------------------
157 -- |--------------------------< <update_non_ota_histories> >--------------------------|
158 -- ----------------------------------------------------------------------------
159 --
160 -- {Start Of Comments}
161 /*#
162 * This API updates a user's external learning.
163 *
164 * This API, called from both OAF and the PUI, updates records in the
165 * OTA_NOTRNG_HISTORIES table.
166 *
167 * <p><b>Licensing</b><br>
168 * This API is licensed for use with Learning Management.
169 *
170 * <p><b>Prerequisites</b><br>
171 * External Learning record must exist for the user
172 *
173 * <p><b>Post Success</b><br>
174 * External Learning record of the user is updated
175 *
176 * <p><b>Post Failure</b><br>
177 * External Learning record is not updated for the user and an error is raised
178 * @param p_validate If true, then validation alone will be performed and the
179 * database will remain unchanged. If false and all validation checks pass,
180 * then the database will be modified.
181 * @param p_effective_date Reference date for validating lookup values are
182 * applicable during the start to end active date range. This date does not
183 * determine when the changes take effect.
184 * @param p_nota_history_id {@rep:casecolumn
185 * OTA_NOTRNG_HISTORIES.NOTA_HISTORY_ID}
186 * @param p_person_id Identifies the person for whom you update the external
187 * learning record.
188 * @param p_contact_id {@rep:casecolumn OTA_NOTRNG_HISTORIES.CONTACT_ID}
189 * @param p_trng_title {@rep:casecolumn OTA_NOTRNG_HISTORIES.TRNG_TITLE}
190 * @param p_provider {@rep:casecolumn OTA_NOTRNG_HISTORIES.PROVIDER}
191 * @param p_type External Learning's Type.Valid values are defined by the
192 * 'OTA_TRAINING_TYPES' lookup type.
193 * @param p_centre {@rep:casecolumn OTA_NOTRNG_HISTORIES.CENTRE}
194 * @param p_completion_date {@rep:casecolumn
195 * OTA_NOTRNG_HISTORIES.COMPLETION_DATE}
196 * @param p_award {@rep:casecolumn OTA_NOTRNG_HISTORIES.AWARD}
197 * @param p_rating {@rep:casecolumn OTA_NOTRNG_HISTORIES.RATING}
198 * @param p_duration {@rep:casecolumn OTA_NOTRNG_HISTORIES.DURATION}
199 * @param p_duration_units External Learning's duration units. Valid values are
200 * defined by the 'OTA_DURATION_UNITS' lookup type.
201 * @param p_activity_version_id The unique identifier of the equivalent Course
202 * @param p_status External Learning's Status. Valid values are defined by the
203 * 'OTA_TRAINING_STATUSES' lookup type.
204 * @param p_verified_by_id {@rep:casecolumn
205 * OTA_NOTRNG_HISTORIES.VERIFIED_BY_ID}
206 * @param p_nth_information_category This context value determines which
207 * Flexfield Structure to use with the Developer Descriptive flexfield segment
208 * @param p_nth_information1 Descriptive flexfield segment.
209 * @param p_nth_information2 Descriptive flexfield segment.
210 * @param p_nth_information3 Descriptive flexfield segment.
211 * @param p_nth_information4 Descriptive flexfield segment.
212 * @param p_nth_information5 Descriptive flexfield segment.
213 * @param p_nth_information6 Descriptive flexfield segment.
214 * @param p_nth_information7 Descriptive flexfield segment.
215 * @param p_nth_information8 Descriptive flexfield segment.
216 * @param p_nth_information9 Descriptive flexfield segment.
217 * @param p_nth_information10 Descriptive flexfield segment.
218 * @param p_nth_information11 Descriptive flexfield segment.
219 * @param p_nth_information12 Descriptive flexfield segment.
220 * @param p_nth_information13 Descriptive flexfield segment.
221 * @param p_nth_information15 Descriptive flexfield segment.
222 * @param p_nth_information16 Descriptive flexfield segment.
223 * @param p_nth_information17 Descriptive flexfield segment.
224 * @param p_nth_information18 Descriptive flexfield segment.
225 * @param p_nth_information19 Descriptive flexfield segment.
226 * @param p_nth_information20 Descriptive flexfield segment.
227 * @param p_org_id {@rep:casecolumn OTA_NOTRNG_HISTORIES.ORG_ID}
228 * @param p_object_version_number Pass in the current version number of the
229 * external learning to be updated. When the API completes if p_validate is
230 * false, will be set to the new version number of the updated external
231 * learning. If p_validate is true will be set to the same value which was
232 * passed in.
233 * @param p_business_group_id {@rep:casecolumn
234 * OTA_NOTRNG_HISTORIES.BUSINESS_GROUP_ID}
235 * @param p_nth_information14 Developer Descriptive flexfield segment.
236 * @param p_customer_id {@rep:casecolumn OTA_NOTRNG_HISTORIES.CUSTOMER_ID}
237 * @param p_organization_id {@rep:casecolumn
238 * OTA_NOTRNG_HISTORIES.ORGANIZATION_ID}
239 * @param p_some_warning If set to true then one of the business logic
240 * validations has failed
241 * @rep:displayname Update External Learning
242 * @rep:category BUSINESS_ENTITY OTA_LEARNING_EXTERNAL
243 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
244 * @rep:scope public
245 * @rep:lifecycle active
246 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
247 */
248 --
249 -- {End Of Comments}
250 --
251
252 procedure update_non_ota_histories
253 (p_validate in boolean default false
254 ,p_effective_date in date
255 ,p_nota_history_id in number
256 ,p_person_id in number
257 ,p_contact_id in number default hr_api.g_number
258 ,p_trng_title in varchar2
259 ,p_provider in varchar2
260 ,p_type in varchar2 default hr_api.g_varchar2
261 ,p_centre in varchar2 default hr_api.g_varchar2
262 ,p_completion_date in date
263 ,p_award in varchar2 default hr_api.g_varchar2
264 ,p_rating in varchar2 default hr_api.g_varchar2
265 ,p_duration in number default hr_api.g_number
266 ,p_duration_units in varchar2 default hr_api.g_varchar2
267 ,p_activity_version_id in number default hr_api.g_number
268 ,p_status in varchar2 default hr_api.g_varchar2
269 ,p_verified_by_id in number default hr_api.g_number
270 ,p_nth_information_category in varchar2 default hr_api.g_varchar2
271 ,p_nth_information1 in varchar2 default hr_api.g_varchar2
272 ,p_nth_information2 in varchar2 default hr_api.g_varchar2
273 ,p_nth_information3 in varchar2 default hr_api.g_varchar2
274 ,p_nth_information4 in varchar2 default hr_api.g_varchar2
275 ,p_nth_information5 in varchar2 default hr_api.g_varchar2
276 ,p_nth_information6 in varchar2 default hr_api.g_varchar2
277 ,p_nth_information7 in varchar2 default hr_api.g_varchar2
278 ,p_nth_information8 in varchar2 default hr_api.g_varchar2
279 ,p_nth_information9 in varchar2 default hr_api.g_varchar2
280 ,p_nth_information10 in varchar2 default hr_api.g_varchar2
281 ,p_nth_information11 in varchar2 default hr_api.g_varchar2
282 ,p_nth_information12 in varchar2 default hr_api.g_varchar2
283 ,p_nth_information13 in varchar2 default hr_api.g_varchar2
284 ,p_nth_information15 in varchar2 default hr_api.g_varchar2
285 ,p_nth_information16 in varchar2 default hr_api.g_varchar2
286 ,p_nth_information17 in varchar2 default hr_api.g_varchar2
287 ,p_nth_information18 in varchar2 default hr_api.g_varchar2
288 ,p_nth_information19 in varchar2 default hr_api.g_varchar2
289 ,p_nth_information20 in varchar2 default hr_api.g_varchar2
290 ,p_org_id in number default hr_api.g_number
291 ,p_object_version_number in out nocopy number
292 ,p_business_group_id in number
293 ,p_nth_information14 in varchar2 default hr_api.g_varchar2
294 ,p_customer_id in number default hr_api.g_number
295 ,p_organization_id in number default hr_api.g_number
296 ,p_some_warning out nocopy boolean
297 );
298
299
300 -- ----------------------------------------------------------------------------
301 -- |--------------------------< <delete_external_learning> >-------------------|
302 -- ----------------------------------------------------------------------------
303 --
304 -- {Start Of Comments}
305 /*#
306 * This API deletes an external learning.
307 *
308 * This business process allows the user to delete an external learning
309 * identified by a external learning identifier (p_nota_history_id ).
310 *
311 * <p><b>Licensing</b><br>
312 * This API is licensed for use with Learning Management.
313 *
314 * <p><b>Prerequisites</b><br>
315 * The external learning must exist
316 *
317 * <p><b>Post Success</b><br>
318 * The external learning is deleted.
319 *
320 * <p><b>Post Failure</b><br>
321 * The API does not delete the external learning record and raises an
322 * error.
323 * @param p_validate If true, then validation alone will be performed and the
324 * database will remain unchanged. If false and all validation checks pass,
325 * then the database will be modified.
326 * @param p_nota_history_id {@rep:casecolumn
327 * OTA_NOTRNG_HISTORIES.NOTA_HISTORY_ID}
328 * @param p_object_version_number Passes in the current version number of the
329 * course-to-category inclusion to be deleted.
330 * @rep:displayname Delete External Learning
331 * @rep:category BUSINESS_ENTITY OTA_LEARNING_EXTERNAL
332 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
333 * @rep:scope public
334 * @rep:lifecycle active
335 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
336 */
337 --
338 -- {End Of Comments}
339 --
340 procedure delete_external_learning
341 (p_validate in boolean default false
342 ,p_nota_history_id in number
343 ,p_object_version_number in number
344 );
345
346 end OTA_NHS_API;
[Home] [Help]