DBA Data[Home] [Help]

PACKAGE: APPS.OTA_RESOURCE_DEFINITION_API

Source


1 PACKAGE OTA_RESOURCE_DEFINITION_API AUTHID CURRENT_USER as
2 /* $Header: ottsrapi.pkh 120.3 2006/08/04 10:43:59 niarora noship $ */
3 /*#
4  * This package contains Resource definition section APIs.
5  * @rep:scope public
6  * @rep:product OTA
7  * @rep:displayname Resource Definition
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |------------------------< create_resource_definition >--------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16  * This API creates the Resource Definition.
17  *
18  *
19  * <p><b>Licensing</b><br>
20  * This API is licensed for use with Learning Management.
21  *
22  * <p><b>Prerequisites</b><br>
23  * Business group record must exist.
24  *
25  * <p><b>Post Success</b><br>
26  * The Resource Definition is created successfully.
27  *
28  * <p><b>Post Failure</b><br>
29  * The API does not create a Resource Definition record and raises an error.
30  *
31  * @param p_supplied_resource_id The unique identifier for the Resource definition.
32  * @param p_vendor_id The vendor.
33  * @param p_business_group_id The business group owning the Resource definition.
34  * @param p_resource_definition_id The foreign key of the OTA_RESOURCE_DEFINITIONS.
35  * @param p_consumable_flag The warn-if-overlapping-booking flag.
36  * Permissible values Y and N.
37  * @param p_object_version_number If p_validate is false, then set to the
38  * version number of the created Resource Definition. If p_validate is true,
39  * then the value will be null.
40  * @param p_resource_type The resource type of the resource.
41  * @param p_start_date Start date of a resource.
42  * If p_validate is true, then set to null.
43  * @param p_comments Comment text.
47  * @param p_end_date End date of a resource.
44  * @param p_cost The cost associated with the resource.
45  * @param p_cost_unit The rate of charge of the resource.
46  * @param p_currency_code The currency for the rate of the charge of the resource.
48  * @param p_internal_address_line The further address detail relating to
49  * a location.
50  * @param p_lead_time The normal lead time when hiring from this supplier.
51  * Days (99.99).
52  * @param p_name  The name of the resource.
53  * @param p_supplier_reference The name by which the supplier will recognize
54  * this resource.
55  * @param p_tsr_information_category This context value determines which
56  * flexfield structure to use with the descriptive flexfield segments.
57  * @param p_tsr_information1   Descriptive flexfield segment.
58  * @param p_tsr_information2   Descriptive flexfield segment.
59  * @param p_tsr_information3   Descriptive flexfield segment.
60  * @param p_tsr_information4   Descriptive flexfield segment.
61  * @param p_tsr_information5   Descriptive flexfield segment.
62  * @param p_tsr_information6   Descriptive flexfield segment.
63  * @param p_tsr_information7   Descriptive flexfield segment.
64  * @param p_tsr_information8   Descriptive flexfield segment.
65  * @param p_tsr_information9   Descriptive flexfield segment.
66  * @param p_tsr_information10  Descriptive flexfield segment.
67  * @param p_tsr_information11  Descriptive flexfield segment.
68  * @param p_tsr_information12  Descriptive flexfield segment.
69  * @param p_tsr_information13  Descriptive flexfield segment.
70  * @param p_tsr_information14  Descriptive flexfield segment.
71  * @param p_tsr_information15  Descriptive flexfield segment.
72  * @param p_tsr_information16  Descriptive flexfield segment.
73  * @param p_tsr_information17  Descriptive flexfield segment.
74  * @param p_tsr_information18  Descriptive flexfield segment.
75  * @param p_tsr_information19  Descriptive flexfield segment.
76  * @param p_tsr_information20  Descriptive flexfield segment.
77  * @param p_training_center_id The Training center of the resource.
78  * @param p_location_id The Location associated to the resource.
79  * @param p_trainer_id The trainer associated to the resource.
80  * @param p_special_instruction Special Instruction.
81  * @param p_validate If true, then validation alone will be performed and the
82  * database will remain unchanged. If false and all validation checks pass,
83  * then the database will be modified.
84  * @param p_effective_date Reference date for validating that lookup values
85  * are applicable during the start to end active date range. This date does
86  * not determine when the changes take effect.
87  * @param p_data_source Obsolete.
88  * @rep:displayname Create Resource Definition
89  * @rep:category BUSINESS_ENTITY OTA_RESOURCE
90  * @rep:lifecycle active
91  * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
92  * @rep:scope public
93  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
94 */
95 --
96 -- {End Of Comments}
97 --
98 
99 procedure CREATE_RESOURCE_DEFINITION
100   (  p_supplied_resource_id          out nocopy number
101   ,p_vendor_id                    in number
102   ,p_business_group_id            in number
103   ,p_resource_definition_id       in number
104   ,p_consumable_flag              in varchar2 default null
105   ,p_object_version_number        out nocopy number
106   ,p_resource_type                in varchar2 default null
107   ,p_start_date                   in date default null
108   ,p_comments                     in varchar2 default null
109   ,p_cost                         in number
110   ,p_cost_unit                    in varchar2 default null
111   ,p_currency_code                in varchar2 default null
112   ,p_end_date                     in date default null
113   ,p_internal_address_line        in varchar2 default null
114   ,p_lead_time                    in number
115   ,p_name                         in varchar2 default null
116   ,p_supplier_reference           in varchar2 default null
117   ,p_tsr_information_category     in varchar2 default null
118   ,p_tsr_information1             in varchar2 default null
119   ,p_tsr_information2             in varchar2 default null
120   ,p_tsr_information3             in varchar2 default null
121   ,p_tsr_information4             in varchar2 default null
122   ,p_tsr_information5             in varchar2 default null
123   ,p_tsr_information6             in varchar2 default null
124   ,p_tsr_information7             in varchar2 default null
125   ,p_tsr_information8             in varchar2 default null
126   ,p_tsr_information9             in varchar2 default null
127   ,p_tsr_information10            in varchar2 default null
128   ,p_tsr_information11            in varchar2 default null
129   ,p_tsr_information12            in varchar2 default null
130   ,p_tsr_information13            in varchar2 default null
131   ,p_tsr_information14            in varchar2 default null
132   ,p_tsr_information15            in varchar2 default null
133   ,p_tsr_information16            in varchar2 default null
134   ,p_tsr_information17            in varchar2 default null
135   ,p_tsr_information18            in varchar2 default null
136   ,p_tsr_information19            in varchar2 default null
137   ,p_tsr_information20            in varchar2 default null
138   ,p_training_center_id           in number
139   ,p_location_id	          in number
140   ,p_trainer_id                   in number
141   ,p_special_instruction          in varchar2 default null
142   ,p_validate                     in boolean
143   ,p_effective_date               in date
144   ,p_data_source                  in varchar2 default null
145   );
146   --
147   -- ----------------------------------------------------------------------------
151   -- {Start Of Comments}
148   -- |------------------------< update_resource_definition >--------------------|
149   -- ----------------------------------------------------------------------------
150   --
152   /*#
153    * This API updates the Resource Definition.
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    * Resource definition with the given object version number should exist.
161    *
162    * <p><b>Post Success</b><br>
163    * The Resource Definition is updated successfully.
164    *
165    * <p><b>Post Failure</b><br>
166    * The API does not update a Resource Definition record, and raises an error.
167    *
168    * @param p_supplied_resource_id The unique identifier for the Resource definition.
169    * @param p_vendor_id The vendor.
170    * @param p_business_group_id The business group owning the Resource definition.
171    * @param p_resource_definition_id The foreign key of the OTA_RESOURCE_DEFINITIONS.
172    * @param p_consumable_flag The warn-if-overlapping-booking flag.
173    * Permissible values Y and N.
174    * @param p_object_version_number If p_validate is false, then set to
175    * the version number of the created Resource Definition. If p_validate
176    * is true, then the value will be null.
177    * @param p_resource_type The resource type of the resource.
178    * @param p_start_date Start date of a resource.
179    * @param p_comments Comment text.
180    * @param p_cost The cost associated with the resource.
181    * @param p_cost_unit The rate of charge of the resource.
182    * @param p_currency_code The currency for the rate of the charge
183    * of the resource.
184    * @param p_end_date End date of a resource.
185    * If p_validate is true, then set to null.
186    * @param p_internal_address_line The further address detail relating
187    * to a location.
188    * @param p_lead_time The normal lead time when hiring from this supplier.
189    * Days (99.99).
190    * @param p_name The name of the resource.
191    * @param p_supplier_reference The name by which the supplier will
192    * recognize this resource.
193    * @param p_tsr_information_category This context value determines
194    * which flexfield structure to use with the descriptive flexfield segments.
195    * @param p_tsr_information1  Descriptive flexfield segment.
196    * @param p_tsr_information2  Descriptive flexfield segment.
197    * @param p_tsr_information3  Descriptive flexfield segment.
198    * @param p_tsr_information4  Descriptive flexfield segment.
199    * @param p_tsr_information5  Descriptive flexfield segment.
200    * @param p_tsr_information6  Descriptive flexfield segment.
201    * @param p_tsr_information7  Descriptive flexfield segment.
202    * @param p_tsr_information8  Descriptive flexfield segment.
203    * @param p_tsr_information9  Descriptive flexfield segment.
204    * @param p_tsr_information10 Descriptive flexfield segment.
205    * @param p_tsr_information11 Descriptive flexfield segment.
206    * @param p_tsr_information12 Descriptive flexfield segment.
207    * @param p_tsr_information13 Descriptive flexfield segment.
208    * @param p_tsr_information14 Descriptive flexfield segment.
209    * @param p_tsr_information15 Descriptive flexfield segment.
210    * @param p_tsr_information16 Descriptive flexfield segment.
211    * @param p_tsr_information17 Descriptive flexfield segment.
212    * @param p_tsr_information18 Descriptive flexfield segment.
213    * @param p_tsr_information19 Descriptive flexfield segment.
214    * @param p_tsr_information20 Descriptive flexfield segment.
215    * @param p_training_center_id The Training center of the resource.
216    * @param p_location_id The location associated to the resource.
217    * @param p_trainer_id The trainer associated to the resource.
218    * @param p_special_instruction Special Instruction.
219    * @param p_validate If true, then validation alone will be performed and the
220    * database will remain unchanged. If false and all validation checks pass,
221    * then the database will be modified.
222    * @param p_effective_date Reference date for validating that lookup values
223    * are applicable during the start to end active date range. This date does
224    * not determine when the changes take effect.
225    * @param p_data_source Obsolete.
226    * @rep:displayname Update Resource Definition
227    * @rep:category BUSINESS_ENTITY OTA_RESOURCE
228    * @rep:lifecycle active
229    * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
230    * @rep:scope public
231    * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
232   */
233   --
234   -- {End Of Comments}
235   --
236 
237 procedure UPDATE_RESOURCE_DEFINITION
238   (p_supplied_resource_id          in number
239   ,p_vendor_id                    in number
240   ,p_business_group_id            in number
241   ,p_resource_definition_id       in number
242   ,p_consumable_flag              in varchar2
243   ,p_object_version_number        in out nocopy number
244   ,p_resource_type                in varchar2
245   ,p_start_date                   in date default hr_api.g_date
246   ,p_comments                     in varchar2
247   ,p_cost                         in number
248   ,p_cost_unit                    in varchar2
249   ,p_currency_code                in varchar2
250   ,p_end_date                     in date default hr_api.g_date
251   ,p_internal_address_line        in varchar2
252   ,p_lead_time                    in number
253   ,p_name                         in varchar2
254   ,p_supplier_reference           in varchar2
255   ,p_tsr_information_category     in varchar2
256   ,p_tsr_information1             in varchar2
257   ,p_tsr_information2             in varchar2
258   ,p_tsr_information3             in varchar2
259   ,p_tsr_information4             in varchar2
260   ,p_tsr_information5             in varchar2
261   ,p_tsr_information6             in varchar2
262   ,p_tsr_information7             in varchar2
263   ,p_tsr_information8             in varchar2
264   ,p_tsr_information9             in varchar2
265   ,p_tsr_information10            in varchar2
266   ,p_tsr_information11            in varchar2
267   ,p_tsr_information12            in varchar2
268   ,p_tsr_information13            in varchar2
269   ,p_tsr_information14            in varchar2
270   ,p_tsr_information15            in varchar2
271   ,p_tsr_information16            in varchar2
272   ,p_tsr_information17            in varchar2
273   ,p_tsr_information18            in varchar2
274   ,p_tsr_information19            in varchar2
275   ,p_tsr_information20            in varchar2
276   ,p_training_center_id           in number
277   ,p_location_id	          in number
278   ,p_trainer_id                   in number
279   ,p_special_instruction          in varchar2
280   ,p_validate                     in boolean
281   ,p_effective_date               in date
282   ,p_data_source                  in varchar2
283   );
284   --
285   -- ----------------------------------------------------------------------------
286   -- |------------------------< delete_resource_definition >--------------------|
287   -- ----------------------------------------------------------------------------
288   --
289   -- {Start Of Comments}
290   /*#
291    * This API deletes the Resource Definition.
292    *
293    *
294    * <p><b>Licensing</b><br>
295    * This API is licensed for use with Learning Management.
296    *
297    * <p><b>Prerequisites</b><br>
298    * Resource definition with the given object version number should exist.
299    *
300    * <p><b>Post Success</b><br>
301    * The Resource Definition is deleted successfully.
302    *
303    * <p><b>Post Failure</b><br>
304    * The API does not delete a Resource Definition record and raises an error.
305    *
306    * @param p_validate If true, then validation alone will be performed and the
307    * database will remain unchanged. If false and all validation checks pass,
308    * then the database will be modified.
309    * @param p_supplied_resource_id The unique identifier for the Resource definition.
310    * @param p_object_version_number If p_validate is false, then set to the version
311    * number of the created Resource Definition. If p_validate is true, then the
312    * value will be null.
313    * @rep:displayname Delete Resource Definition
314    * @rep:category BUSINESS_ENTITY OTA_RESOURCE
315    * @rep:lifecycle active
316    * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
317    * @rep:scope public
318    * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
319   */
320   --
321   -- {End Of Comments}
322   --
323 
324 procedure DELETE_RESOURCE_DEFINITION
325   (p_validate                      in     boolean  default false
326   ,p_supplied_resource_id        in     number
327   ,p_object_version_number         in     number
328   );
329 
330 end ota_RESOURCE_DEFINITION_api;