1 PACKAGE OTA_RESOURCE_USAGE_API AUTHID CURRENT_USER as
2 /* $Header: otrudapi.pkh 120.1 2005/10/02 02:07:53 aroussel $ */
3 /*#
4 * This package creates, updates, and deletes resource associations at the
5 * offering level.
6 * @rep:scope public
7 * @rep:product ota
8 * @rep:displayname Resource Usage
9 */
10 --
11 -- ----------------------------------------------------------------------------
12 -- |-----------------------------< create_resource >--------------------------|
13 -- ----------------------------------------------------------------------------
14 --
15 -- {Start Of Comments}
16 /*#
17 * This API associates a resource with an offering.
18 *
19 *
20 * <p><b>Licensing</b><br>
21 * This API is licensed for use with Learning Management.
22 *
23 * <p><b>Prerequisites</b><br>
24 * Offering must exist.
25 *
26 * <p><b>Post Success</b><br>
27 * Record for resource association with an offering is created.
28 *
29 * <p><b>Post Failure</b><br>
30 * The record for resource association with an offering is not created and an
31 * 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_activity_version_id Populates the activity_version_id corresponding
39 * to the offering.
40 * @param p_required_flag This flag identifies a resource as Required or
41 * Useful. Valid values are defined by the 'YES_NO' lookup type.
42 * @param p_start_date {@rep:casecolumn OTA_RESOURCE_USAGES.START_DATE}
43 * @param p_supplied_resource_id {@rep:casecolumn
44 * OTA_RESOURCE_USAGES.SUPPLIED_RESOURCE_ID}
45 * @param p_comments If profile 'HR:Use Standard Attachments
46 * (PER_ATTACHMENT_USAGE)' is set to 'No', this text serves as HR-specific
47 * attachment text.
48 * @param p_end_date {@rep:casecolumn OTA_RESOURCE_USAGES.END_DATE}
49 * @param p_quantity {@rep:casecolumn OTA_RESOURCE_USAGES.QUANTITY}
50 * @param p_resource_type It identifies the type of the resource. Valid values
51 * are defined by 'RESOURCE_TYPE' lookup type
52 * @param p_role_to_play It identifies the role of the resource. Valid values
53 * are defined by 'TRAINER_PARTICIPATION' lookup type.
54 * @param p_usage_reason It identifies the reason for the resource. Valid
55 * values are defined by the 'RESOURCE_USAGE_REASON' lookup type.
56 * @param p_rud_information_category This context value determines which
57 * Flexfield Structure to use with the Descriptive flexfield segment
58 * @param p_rud_information1 Descriptive flexfield segment.
59 * @param p_rud_information2 Descriptive flexfield segment.
60 * @param p_rud_information3 Descriptive flexfield segment.
61 * @param p_rud_information4 Descriptive flexfield segment.
62 * @param p_rud_information5 Descriptive flexfield segment.
63 * @param p_rud_information6 Descriptive flexfield segment.
64 * @param p_rud_information7 Descriptive flexfield segment.
65 * @param p_rud_information8 Descriptive flexfield segment.
66 * @param p_rud_information9 Descriptive flexfield segment.
67 * @param p_rud_information10 Descriptive flexfield segment.
68 * @param p_rud_information11 Descriptive flexfield segment.
69 * @param p_rud_information12 Descriptive flexfield segment.
70 * @param p_rud_information13 Descriptive flexfield segment.
71 * @param p_rud_information14 Descriptive flexfield segment.
72 * @param p_rud_information15 Descriptive flexfield segment.
73 * @param p_rud_information16 Descriptive flexfield segment.
74 * @param p_rud_information17 Descriptive flexfield segment.
75 * @param p_rud_information18 Descriptive flexfield segment.
76 * @param p_rud_information19 Descriptive flexfield segment.
77 * @param p_rud_information20 Descriptive flexfield segment.
78 * @param p_resource_usage_id {@rep:casecolumn
79 * OTA_RESOURCE_USAGES.RESOURCE_USAGE_ID}
80 * @param p_object_version_number If p_validate is false, then the number is
81 * set to the version number of the created external learning. If p_validate is
82 * true, then the value is null.
83 * @param p_offering_id The unique identifer of the offering for which the
84 * resources are being defined
85 * @rep:displayname Create Resource
86 * @rep:category BUSINESS_ENTITY OTA_LEARNING_OFFER_RES_CHKLST
87 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
88 * @rep:scope public
89 * @rep:lifecycle active
90 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
91 */
92 --
93 -- {End Of Comments}
94 --
95 procedure Create_resource
96 (p_validate in boolean default false
97 ,p_effective_date in date
98 ,p_activity_version_id in number default null
99 ,p_required_flag in varchar2
100 ,p_start_date in date
101 ,p_supplied_resource_id in number default null
102 ,p_comments in varchar2 default null
103 ,p_end_date in date default null
104 ,p_quantity in number default null
105 ,p_resource_type in varchar2 default null
106 ,p_role_to_play in varchar2 default null
107 ,p_usage_reason in varchar2 default null
108 ,p_rud_information_category in varchar2 default null
109 ,p_rud_information1 in varchar2 default null
110 ,p_rud_information2 in varchar2 default null
111 ,p_rud_information3 in varchar2 default null
112 ,p_rud_information4 in varchar2 default null
113 ,p_rud_information5 in varchar2 default null
114 ,p_rud_information6 in varchar2 default null
115 ,p_rud_information7 in varchar2 default null
116 ,p_rud_information8 in varchar2 default null
117 ,p_rud_information9 in varchar2 default null
118 ,p_rud_information10 in varchar2 default null
119 ,p_rud_information11 in varchar2 default null
120 ,p_rud_information12 in varchar2 default null
121 ,p_rud_information13 in varchar2 default null
122 ,p_rud_information14 in varchar2 default null
123 ,p_rud_information15 in varchar2 default null
124 ,p_rud_information16 in varchar2 default null
125 ,p_rud_information17 in varchar2 default null
126 ,p_rud_information18 in varchar2 default null
127 ,p_rud_information19 in varchar2 default null
128 ,p_rud_information20 in varchar2 default null
129 ,p_resource_usage_id out nocopy number
130 ,p_object_version_number out nocopy number
131 ,p_offering_id in number default null
132 );
133 --
134 -- ----------------------------------------------------------------------------
135 -- |-----------------------------< update_resource >--------------------------|
136 -- ----------------------------------------------------------------------------
137 --
138 -- {Start Of Comments}
139 /*#
140 * This API updates a resource-to-offering association.
141 *
142 *
143 * <p><b>Licensing</b><br>
144 * This API is licensed for use with Learning Management.
145 *
146 * <p><b>Prerequisites</b><br>
147 * Record for resource must exist.
148 *
149 * <p><b>Post Success</b><br>
150 * Record for resource association with an offering is updated.
151 *
152 * <p><b>Post Failure</b><br>
153 * Record for resource association with an offering is not updated and an error
154 * is raised.
155 * @param p_validate If true, then validation alone will be performed and the
156 * database will remain unchanged. If false and all validation checks pass,
157 * then the database will be modified.
158 * @param p_effective_date Reference date for validating lookup values are
159 * applicable during the start to end active date range. This date does not
160 * determine when the changes take effect.
161 * @param p_resource_usage_id {@rep:casecolumn
162 * OTA_RESOURCE_USAGES.RESOURCE_USAGE_ID}
163 * @param p_object_version_number Pass in the current version number of the
164 * resource to be updated. When the API completes if p_validate is false, the
165 * number is set to the new version number of the updated resource. If
166 * p_validate is true will be set to the same value which was passed in.
167 * @param p_activity_version_id Populates the activity_version_id corresponding
168 * to the offering.
169 * @param p_required_flag This flag identifies resource as Required or Useful.
170 * Valid values are defined by the 'YES_NO' lookup type.
171 * @param p_start_date {@rep:casecolumn OTA_RESOURCE_USAGES.START_DATE}
172 * @param p_supplied_resource_id {@rep:casecolumn
173 * OTA_RESOURCE_USAGES.SUPPLIED_RESOURCE_ID}
174 * @param p_comments If the profile 'HR:Use Standard Attachments
175 * (PER_ATTACHMENT_USAGE)' is set to 'No', this text serves as HR-specific
176 * attachment text.
177 * @param p_end_date {@rep:casecolumn OTA_RESOURCE_USAGES.END_DATE}
178 * @param p_quantity {@rep:casecolumn OTA_RESOURCE_USAGES.QUANTITY}
179 * @param p_resource_type Identifies the type of the resource. Valid values are
180 * defined by the 'RESOURCE_TYPE' lookup type
181 * @param p_role_to_play Identifies the role of the resource. Valid values are
182 * defined by the 'TRAINER_PARTICIPATION' lookup type
183 * @param p_usage_reason Identifies the reason for the resource. Valid values
184 * are defined by the 'RESOURCE_USAGE_REASON' lookup type.
185 * @param p_rud_information_category This context value determines which
186 * Flexfield Structure to use with the Descriptive flexfield segment
187 * @param p_rud_information1 Descriptive flexfield segment.
188 * @param p_rud_information2 Descriptive flexfield segment.
189 * @param p_rud_information3 Descriptive flexfield segment.
190 * @param p_rud_information4 Descriptive flexfield segment.
191 * @param p_rud_information5 Descriptive flexfield segment.
192 * @param p_rud_information6 Descriptive flexfield segment.
193 * @param p_rud_information7 Descriptive flexfield segment.
194 * @param p_rud_information8 Descriptive flexfield segment.
195 * @param p_rud_information9 Descriptive flexfield segment.
196 * @param p_rud_information10 Descriptive flexfield segment.
197 * @param p_rud_information11 Descriptive flexfield segment.
198 * @param p_rud_information12 Descriptive flexfield segment.
199 * @param p_rud_information13 Descriptive flexfield segment.
200 * @param p_rud_information14 Descriptive flexfield segment.
201 * @param p_rud_information15 Descriptive flexfield segment.
202 * @param p_rud_information16 Descriptive flexfield segment.
203 * @param p_rud_information17 Descriptive flexfield segment.
204 * @param p_rud_information18 Descriptive flexfield segment.
205 * @param p_rud_information19 Descriptive flexfield segment.
206 * @param p_rud_information20 Descriptive flexfield segment.
207 * @param p_offering_id The unique identifer of the offering for which the
208 * resources are being defined
209 * @rep:displayname Update Resource
210 * @rep:category BUSINESS_ENTITY OTA_LEARNING_OFFER_RES_CHKLST
211 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
212 * @rep:scope public
213 * @rep:lifecycle active
214 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
215 */
216 --
217 -- {End Of Comments}
218 --
219 procedure Update_resource
220 (p_validate in boolean default false
221 ,p_effective_date in date
222 ,p_resource_usage_id in number
226 ,p_start_date in date default hr_api.g_date
223 ,p_object_version_number in out nocopy number
224 ,p_activity_version_id in number default hr_api.g_number
225 ,p_required_flag in varchar2 default hr_api.g_varchar2
227 ,p_supplied_resource_id in number default hr_api.g_number
228 ,p_comments in varchar2 default hr_api.g_varchar2
229 ,p_end_date in date default hr_api.g_date
230 ,p_quantity in number default hr_api.g_number
231 ,p_resource_type in varchar2 default hr_api.g_varchar2
232 ,p_role_to_play in varchar2 default hr_api.g_varchar2
233 ,p_usage_reason in varchar2 default hr_api.g_varchar2
234 ,p_rud_information_category in varchar2 default hr_api.g_varchar2
235 ,p_rud_information1 in varchar2 default hr_api.g_varchar2
236 ,p_rud_information2 in varchar2 default hr_api.g_varchar2
237 ,p_rud_information3 in varchar2 default hr_api.g_varchar2
238 ,p_rud_information4 in varchar2 default hr_api.g_varchar2
239 ,p_rud_information5 in varchar2 default hr_api.g_varchar2
240 ,p_rud_information6 in varchar2 default hr_api.g_varchar2
241 ,p_rud_information7 in varchar2 default hr_api.g_varchar2
242 ,p_rud_information8 in varchar2 default hr_api.g_varchar2
243 ,p_rud_information9 in varchar2 default hr_api.g_varchar2
244 ,p_rud_information10 in varchar2 default hr_api.g_varchar2
245 ,p_rud_information11 in varchar2 default hr_api.g_varchar2
246 ,p_rud_information12 in varchar2 default hr_api.g_varchar2
247 ,p_rud_information13 in varchar2 default hr_api.g_varchar2
248 ,p_rud_information14 in varchar2 default hr_api.g_varchar2
249 ,p_rud_information15 in varchar2 default hr_api.g_varchar2
250 ,p_rud_information16 in varchar2 default hr_api.g_varchar2
251 ,p_rud_information17 in varchar2 default hr_api.g_varchar2
252 ,p_rud_information18 in varchar2 default hr_api.g_varchar2
253 ,p_rud_information19 in varchar2 default hr_api.g_varchar2
254 ,p_rud_information20 in varchar2 default hr_api.g_varchar2
255 ,p_offering_id in number default hr_api.g_number
256 );
257 --
258 -- ----------------------------------------------------------------------------
259 -- |-----------------------------< delete_resource >--------------------------|
260 -- ----------------------------------------------------------------------------
261 --
262 -- {Start Of Comments}
263 /*#
264 * This API deletes a resource-to-offering association.
265 *
266 *
267 * <p><b>Licensing</b><br>
268 * This API is licensed for use with Learning Management.
269 *
270 * <p><b>Prerequisites</b><br>
271 * Record for the resource must exist.
272 *
273 * <p><b>Post Success</b><br>
274 * Record for resource association with an offering is deleted from database.
275 *
276 * <p><b>Post Failure</b><br>
277 * Record for resource association with an offering is not deleted and an error
278 * is raised.
279 * @param p_validate If true, then validation alone will be performed and the
280 * database will remain unchanged. If false and all validation checks pass,
281 * then the database will be modified.
282 * @param p_resource_usage_id {@rep:casecolumn
283 * OTA_RESOURCE_USAGES.RESOURCE_USAGE_ID}
284 * @param p_object_version_number Pass in the current version number of the
285 * resource to be deleted.
286 * @rep:displayname Delete Resource
287 * @rep:category BUSINESS_ENTITY OTA_LEARNING_OFFER_RES_CHKLST
288 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
289 * @rep:scope public
290 * @rep:lifecycle active
291 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
292 */
293 --
294 -- {End Of Comments}
295 --
296 procedure Delete_resource
297 (p_validate in boolean default false
298 ,p_resource_usage_id in number
299 ,p_object_version_number in number
300 );
301
302 end ota_resource_usage_api;
[Home] [Help]