1 PACKAGE hxc_timestore_deposit AUTHID CURRENT_USER AS
2 /* $Header: hxctsdp.pkh 120.8.12010000.2 2009/11/20 10:00:52 bbayragi ship $ */
3 /*#
4 * This package contains procedures that can be used to manage timecards and
5 * save them into the OTL TimeStore.
6 * @rep:scope public
7 * @rep:product HXT
8 * @rep:displayname TimeStore Deposit
9 */
10 g_otl_deposit_process CONSTANT hxc_deposit_processes.NAME%TYPE
11 := 'OTL Deposit Process';
12 g_validate BOOLEAN;
13
14 SUBTYPE mode_varchar2 IS VARCHAR2 (15);
15
16 c_hours_uom CONSTANT hxc_time_building_blocks.unit_of_measure%TYPE
17 := 'HOURS';
18 c_migration CONSTANT mode_varchar2 := 'MIGRATION';
19 c_tk_save CONSTANT mode_varchar2 := 'FORCE_SAVE';
20 c_tk_submit CONSTANT mode_varchar2 := 'FORCE_SUBMIT';
21 c_auto_approve_name CONSTANT hxc_approval_styles.NAME%TYPE
22 := 'OTL Auto Approve';
23 c_approval_on_submit_name CONSTANT hxc_approval_styles.NAME%TYPE
24 := 'Approval on Submit';
25
26 --
27 -- ----------------------------------------------------------------------------
28 -- |---------------------------< get_timecard_tables >------------------------|
29 -- ----------------------------------------------------------------------------
30 --
31 -- {Start Of Comments}
32 /*#
33 * Procedure used to retrieve the Timecard from the TimeStore and place the
34 * Time Building Blocks in a SQL Type Nested Table and the attributes in a
35 * PL/SQL Type Nested Table.
36 *
37 * Use this procedure to retrieve the currently active Timecard and its
38 * Attributes from the Database into their respective PL/SQL Collections.
39 *
40 * <p><b>Licensing</b><br>
41 * This API version is licensed for use with Time and Labor.
42 *
43 * <p><b>Prerequisites</b><br>
44 * Timecard should be present in the TimeStore.
45 *
46 * <p><b>Post Success</b><br>
47 * SQL and PL/SQL Type Nested Tables will contain Timecard and Timecard
48 * Attributes.
49 *
50 * <p><b>Post Failure</b><br>
51 * SQL and PL/SQL Type Nested Tables will be empty.
52 *
53 * @param p_building_block_id Time Building Block of the Timecard to retrieve.
54 * @param p_deposit_process Deposit process indicates which attribute to
55 * application mapping should be used to retrieve the Timecard attributes.
56 * @param p_clear_mapping_cache can be used to clear the mapping cache
57 * @param p_app_blocks SQL Type Nested Table that will hold the Time Building
58 * Blocks of the Timecard.
59 * @param p_app_attributes PL/SQL Type Nested Table that will hold the Time
60 * Attributes of the Timecard.
61 * @rep:displayname Get Timecard
62 * @rep:category BUSINESS_ENTITY HXC_TIMECARD
63 * @rep:lifecycle active
64 * @rep:primaryinstance
65 * @rep:scope public
66 * @rep:metalink 223987.1 OTL HXC TimeStore Deposit
67 */
68 --
69 -- {End Of Comments}
70 --
71 PROCEDURE get_timecard_tables (
72 p_building_block_id IN hxc_time_building_blocks.time_building_block_id%TYPE,
73 -- p_time_recipient_id IN NUMBER,
74 p_deposit_process IN hxc_deposit_processes.NAME%TYPE
75 DEFAULT g_otl_deposit_process,
76 p_clear_mapping_cache IN BOOLEAN DEFAULT FALSE,
77 p_app_blocks OUT NOCOPY hxc_block_table_type,
78 p_app_attributes OUT NOCOPY hxc_self_service_time_deposit.app_attributes_info
79 );
80
81 --
82 -- ----------------------------------------------------------------------------
83 -- |---------------------------< get_timecard_tables >------------------------|
84 -- ----------------------------------------------------------------------------
85 --
86 -- {Start Of Comments}
87 /*#
88 * Procedure used to retrieve the Timecard from the TimeStore and place the
89 * Time Building Blocks and the attributes in a PL/SQL Type Nested Table.
90 *
91 * Use this procedure to retrieve the currently active Timecard and its
92 * Attributes from the Database into their respective PL/SQL Collections.
93 *
94 * <p><b>Licensing</b><br>
95 * This API version is licensed for use with Time and Labor.
96 *
97 * <p><b>Prerequisites</b><br>
98 * Timecard should be present in the TimeStore.
99 *
100 * <p><b>Post Success</b><br>
101 * PL/SQL Type Nested Tables will contain Timecard and Timecard Attributes.
102 *
103 * <p><b>Post Failure</b><br>
104 * PL/SQL Type Nested Tables will be empty.
105 *
106 * @param p_building_block_id Building Block of the Timecard to retrieve.
107 * @param p_deposit_process Deposit process indicates which attribute to
108 * application mapping should be used to retrieve the Timecard attributes.
109 * @param p_clear_mapping_cache can be used to clear the mapping cache
110 * @param p_app_blocks PL/SQL Table that will hold the time portion of the
111 * Timecard object.
112 * @param p_app_attributes PL/SQL Table that will hold the attributes related
113 * to the Time Building Blocks held in p_app_blocks.
114 * @rep:displayname Get Timecard
115 * @rep:category BUSINESS_ENTITY HXC_TIMECARD
116 * @rep:lifecycle active
117 * @rep:scope public
118 * @rep:metalink 223987.1 OTL HXC TimeStore Deposit
119 */
120 --
121 -- {End Of Comments}
122 --
123 PROCEDURE get_timecard_tables (
124 p_building_block_id IN hxc_time_building_blocks.time_building_block_id%TYPE,
125 -- p_time_recipient_id IN NUMBER,
126 p_deposit_process IN hxc_deposit_processes.NAME%TYPE
127 DEFAULT g_otl_deposit_process,
128 p_clear_mapping_cache IN BOOLEAN DEFAULT FALSE,
129 p_app_blocks OUT NOCOPY hxc_self_service_time_deposit.timecard_info,
130 p_app_attributes OUT NOCOPY hxc_self_service_time_deposit.app_attributes_info
131 );
132
133 --
134 -- ----------------------------------------------------------------------------
135 -- |--------------------------------< create_bb >-----------------------------|
136 -- ----------------------------------------------------------------------------
137 --
138 -- {Start Of Comments}
139 /*#
140 * Procedure to add one Time Building Block to the Time Building Block SQL Type
141 * Nested Table.
142 *
143 * Note that this procedure does not manipulate any of the database table
144 * contents. Only the PL/SQL nested table parameters passed into this procedure
145 * will be modified. The execute_deposit_process API will need to be used to
146 * actually update the database.
147 *
148 * <p><b>Licensing</b><br>
149 * This API version is licensed for use with Time and Labor.
150 *
151 * <p><b>Prerequisites</b><br>
152 * The resource must exist.
153 *
154 * <p><b>Post Success</b><br>
155 * Time Building Block will have been added to the Time Building Block SQL Type
156 * Nested Table.
157 *
158 * <p><b>Post Failure</b><br>
159 * Time Building Block will not be added to the Time Building Block SQL Type
160 * Nested Table.
161 *
162 * @param p_time_building_block_id Surrogate Time Building Block for the Time
163 * Building Block, this is needed to link potential child Time Building Blocks
164 * to this Time Building Block.
165 * @param p_type Type of the Time Building Block: 'MEASURE' or 'RANGE'.
166 * @param p_measure The actual time recorded, only provide when type is
167 * 'MEASURE'.
168 * @param p_unit_of_measure Units of measure for p_measure, the default value
169 * is recommended for most scenarios.
170 * @param p_start_time The IN time: only provide when type is 'RANGE'.
171 * @param p_stop_time The OUT time: only provide when type is 'RANGE'.
172 * @param p_parent_building_block_id Identifies the Time Building Block to
173 * which this Time Building Block needs to be attached.
174 * @param p_parent_is_new Set to 'Y', if the parent Time Building Block does
175 * not exist in the database, else set to 'N'.
176 * @param p_scope Use one of the following values: 'TIMECARD', 'DAY' or
177 * 'DETAIL'.
178 * @param p_object_version_number Object version number of the Time Building
179 * Block being created, the default value is recommended for most scenarios.
180 * @param p_approval_status Use one of the following values: 'WORKING' or
181 * 'SUBMITTED'.
182 * @param p_resource_id Resource identifier to which the Time Building Block
183 * belongs.
184 * @param p_resource_type Type of resource, currently must be set to 'PERSON'.
185 * @param p_approval_style_id The identifier of the approval style, used to
186 * approve the Time Building Block.
187 * @param p_date_from Date from which the Time Building Block is valid, the
188 * default value is recommended for most scenarios.
189 * @param p_date_to The latest date this Time Building Block is valid, the
190 * default value is recommended for most scenarios.
191 * @param p_comment_text Comment to be stored with the Time Building Block.
192 * @param p_parent_building_block_ovn Object Version Number of the parent Time
193 * Building Block.
194 * @param p_new For new Time Building Blocks this needs to be 'Y', the default
195 * value is recommended for most scenarios.
196 * @param p_changed For new Time Building Blocks this needs to be 'N', the
197 * default value is recommended for most scenarios.
198 * @param p_app_blocks Pass in the Time Building Block SQL Type Nested Table to
199 * attach the Time Building Block to. On success, the Time Building Block
200 * created will be added to this SQL Type Nested Table.
201 * @rep:displayname Create Time Building Block
202 * @rep:category BUSINESS_ENTITY HXC_TIMECARD
203 * @rep:lifecycle active
204 * @rep:primaryinstance
205 * @rep:scope public
206 * @rep:metalink 223987.1 OTL HXC TimeStore Deposit
207 */
208 --
209 -- {End Of Comments}
210 --
211 PROCEDURE create_bb (
212 p_time_building_block_id IN hxc_time_building_blocks.time_building_block_id%TYPE,
213 p_type IN hxc_time_building_blocks.TYPE%TYPE,
214 p_measure IN hxc_time_building_blocks.measure%TYPE
215 DEFAULT NULL,
216 p_unit_of_measure IN hxc_time_building_blocks.unit_of_measure%TYPE
217 DEFAULT c_hours_uom,
218 p_start_time IN hxc_time_building_blocks.start_time%TYPE
219 DEFAULT NULL,
220 p_stop_time IN hxc_time_building_blocks.stop_time%TYPE
221 DEFAULT NULL,
222 p_parent_building_block_id IN hxc_time_building_blocks.parent_building_block_id%TYPE
223 DEFAULT NULL,
224 p_parent_is_new IN VARCHAR2,
225 p_scope IN hxc_time_building_blocks.SCOPE%TYPE,
226 p_object_version_number IN hxc_time_building_blocks.object_version_number%TYPE
227 DEFAULT 1,
228 p_approval_status IN hxc_time_building_blocks.approval_status%TYPE
229 DEFAULT NULL,
230 p_resource_id IN hxc_time_building_blocks.resource_id%TYPE,
231 p_resource_type IN hxc_time_building_blocks.resource_type%TYPE,
232 p_approval_style_id IN hxc_time_building_blocks.approval_style_id%TYPE,
233 p_date_from IN hxc_time_building_blocks.date_from%TYPE
234 DEFAULT SYSDATE,
235 p_date_to IN hxc_time_building_blocks.date_to%TYPE
236 DEFAULT hr_general.end_of_time,
237 p_comment_text IN hxc_time_building_blocks.comment_text%TYPE
238 DEFAULT NULL,
239 p_parent_building_block_ovn IN hxc_time_building_blocks.parent_building_block_ovn%TYPE
240 DEFAULT NULL,
241 p_new IN VARCHAR2 DEFAULT 'Y',
242 p_changed IN VARCHAR2 DEFAULT '',
243 p_app_blocks IN OUT NOCOPY hxc_block_table_type
244 );
245
246 --
247 -- ----------------------------------------------------------------------------
248 -- |--------------------------------< create_bb >-----------------------------|
249 -- ----------------------------------------------------------------------------
250 --
251 -- {Start Of Comments}
252 /*#
253 * Procedure to add one Time Building Block to the Time Building Block PL/SQL
254 * Type Nested Table.
255 *
256 * Note that this procedure does not manipulate any of the database table
257 * contents. Only the PL/SQL nested table parameters passed into this procedure
258 * will be modified. The execute_deposit_process API will need to be used to
259 * actually update the database.
260 *
261 * <p><b>Licensing</b><br>
262 * This API version is licensed for use with Time and Labor.
263 *
264 * <p><b>Prerequisites</b><br>
265 * The resource must exist.
266 *
267 * <p><b>Post Success</b><br>
268 * Time Building Block will have been added to the Time Building Block PL/SQL
269 * Type Nested Table.
270 *
271 * <p><b>Post Failure</b><br>
272 * Time Building Block will not be added to the Time Building Block PL/SQL Type
273 * Nested Table.
274 *
275 * @param p_time_building_block_id Surrogate Time Building Block identifierfor
276 * the Time Building Block. This is needed to link potential child Time
277 * Building Blocks to this Time Building Block.
278 * @param p_type Type of the Time Building Block: 'MEASURE' or 'RANGE'.
279 * @param p_measure The actual time recorded, only provide when type is
280 * 'MEASURE'.
281 * @param p_unit_of_measure Units of measure for p_measure, the default value
282 * is recommended for most scenarios.
283 * @param p_start_time The IN time: only provide when type is 'RANGE'.
284 * @param p_stop_time The OUT time: only provide when type is 'RANGE'.
285 * @param p_parent_building_block_id Identifies of the Time Building Block to
286 * which this Time Building Block needs to be attached.
287 * @param p_parent_is_new Set to 'Y', if the parent Time Building Block does
288 * not exist in the database, else set to 'N'.
289 * @param p_scope Use one of the following values: 'TIMECARD', 'DAY' or
290 * 'DETAIL'.
291 * @param p_object_version_number Object version number of the Time Building
292 * Block being created, the default value is recommended for most scenarios.
293 * @param p_approval_status Use one of the following values: 'WORKING' or
294 * 'SUBMITTED'.
295 * @param p_resource_id Resource Identifier to which the Time Building Block
296 * belongs.
297 * @param p_resource_type Type of resource, currently must be set to 'PERSON'.
298 * @param p_approval_style_id The identifier of the approval style used to
299 * approve the Time Building Block.
300 * @param p_date_from Date from which the Time Building Block is valid, the
301 * default value is recommended for most scenarios.
302 * @param p_date_to The latest date this Time Building Block is valid, the
303 * default value is recommended for most scenarios.
304 * @param p_comment_text Comment to be stored with the Time Building Block.
305 * @param p_parent_building_block_ovn Object Version Number of the parent Time
306 * Building Block.
307 * @param p_new For new Time Building Blocks this needs to be 'Y', the default
308 * value is recommended for most scenarios.
309 * @param p_changed For new Time Building Blocks this needs to be 'N', the
310 * default value is recommended for most scenarios.
311 * @param p_app_blocks Pass in the Time Building Block PL/SQL Type Nested Table
312 * to attach the Time Building Block to. On success, the Time Building Block
313 * created will be added to this PL/SQL Type Nested Table.
314 * @rep:displayname Create Time Building Block
315 * @rep:category BUSINESS_ENTITY HXC_TIMECARD
316 * @rep:lifecycle active
317 * @rep:scope public
318 * @rep:metalink 223987.1 OTL HXC TimeStore Deposit
319 */
320 --
321 -- {End Of Comments}
322 --
323 PROCEDURE create_bb (
324 p_time_building_block_id IN hxc_time_building_blocks.time_building_block_id%TYPE,
325 p_type IN hxc_time_building_blocks.TYPE%TYPE,
326 p_measure IN hxc_time_building_blocks.measure%TYPE
327 DEFAULT NULL,
328 p_unit_of_measure IN hxc_time_building_blocks.unit_of_measure%TYPE
329 DEFAULT c_hours_uom,
330 p_start_time IN hxc_time_building_blocks.start_time%TYPE
331 DEFAULT NULL,
332 p_stop_time IN hxc_time_building_blocks.stop_time%TYPE
333 DEFAULT NULL,
334 p_parent_building_block_id IN hxc_time_building_blocks.parent_building_block_id%TYPE
335 DEFAULT NULL,
336 p_parent_is_new IN VARCHAR2,
337 p_scope IN hxc_time_building_blocks.SCOPE%TYPE,
338 p_object_version_number IN hxc_time_building_blocks.object_version_number%TYPE
339 DEFAULT 1,
340 p_approval_status IN hxc_time_building_blocks.approval_status%TYPE
341 DEFAULT NULL,
342 p_resource_id IN hxc_time_building_blocks.resource_id%TYPE,
343 p_resource_type IN hxc_time_building_blocks.resource_type%TYPE,
344 p_approval_style_id IN hxc_time_building_blocks.approval_style_id%TYPE,
345 p_date_from IN hxc_time_building_blocks.date_from%TYPE
346 DEFAULT SYSDATE,
347 p_date_to IN hxc_time_building_blocks.date_to%TYPE
348 DEFAULT hr_general.end_of_time,
349 p_comment_text IN hxc_time_building_blocks.comment_text%TYPE
350 DEFAULT NULL,
351 p_parent_building_block_ovn IN hxc_time_building_blocks.parent_building_block_ovn%TYPE
352 DEFAULT NULL,
353 p_new IN VARCHAR2 DEFAULT 'Y',
354 p_changed IN VARCHAR2 DEFAULT '',
355 p_app_blocks IN OUT NOCOPY hxc_self_service_time_deposit.timecard_info
356 );
357
358 --
359 -- ----------------------------------------------------------------------------
360 -- |----------------------------< create_timecard_bb >------------------------|
361 -- ----------------------------------------------------------------------------
362 --
363 -- {Start Of Comments}
364 /*#
365 * Procedure that creates Time Building Blocks of type TIMECARD and adds them
366 * to the Time Building Block SQL Type Nested Table.
367 *
368 * Note that this procedure does not manipulate any of the database table
369 * contents. Only the PL/SQL nested table parameters passed into this procedure
370 * will be modified. The execute_deposit_process API will need to be used to
371 * actually update the database.
372 *
373 * <p><b>Licensing</b><br>
374 * This API version is licensed for use with Time and Labor.
375 *
376 * <p><b>Prerequisites</b><br>
377 * The resource must exist.
378 *
379 * <p><b>Post Success</b><br>
380 * Time Building Block of type TIMECARD will have been added to the Time
381 * Building Block SQL Type Nested Table.
382 *
383 * <p><b>Post Failure</b><br>
384 * Time Building Block of type TIMECARD will not get added to the Time Building
385 * Block SQL Type Nested Table.
386 *
387 * @param p_start_time The first day of the TIMECARD.
388 * @param p_stop_time The last day of the TIMECARD.
389 * @param p_resource_id Resource to which the Time Building Block belongs.
390 * @param p_resource_type Type of resource, currently must be set to 'PERSON'.
391 * @param p_approval_style_id WORKING' or 'SUBMITTED'. When this parameter is
392 * set to null, the real value will be derived from the mode used during
393 * deposit.
394 * @param p_comment_text Comment to be stored with the TIMECARD Time Building
395 * Block.
396 * @param p_app_blocks Pass in the Time Building Block SQL Type Nested Table to
397 * attach the TIMECARD Time Building Block to. On success, the Time Building
398 * Block created will be added to this SQL Type Nested Table.
399 * @param p_time_building_block_id Uniquely identifies the Time Building Block
400 * created.
401 * @rep:displayname Create Timecard Time Building Block
402 * @rep:category BUSINESS_ENTITY HXC_TIMECARD
403 * @rep:lifecycle active
404 * @rep:primaryinstance
405 * @rep:scope public
406 * @rep:metalink 223987.1 OTL HXC TimeStore Deposit
407 */
408 --
409 -- {End Of Comments}
410 --
411 PROCEDURE create_timecard_bb (
412 p_start_time IN hxc_time_building_blocks.start_time%TYPE,
413 p_stop_time IN hxc_time_building_blocks.stop_time%TYPE,
414 -- p_approval_status IN hxc_time_building_blocks.approval_status%TYPE,
415 p_resource_id IN hxc_time_building_blocks.resource_id%TYPE,
416 -- default to person because there is no other resource type at the moment.
417 p_resource_type IN hxc_time_building_blocks.resource_type%TYPE
418 DEFAULT hxc_timecard.c_person_resource,
419 -- We cannot use approval_style_name because that is not unique.
420 p_approval_style_id IN hxc_time_building_blocks.approval_style_id%TYPE
421 DEFAULT NULL,
422 p_comment_text IN hxc_time_building_blocks.comment_text%TYPE
423 DEFAULT NULL,
424 p_app_blocks IN OUT NOCOPY hxc_block_table_type,
425 p_time_building_block_id OUT NOCOPY hxc_time_building_blocks.time_building_block_id%TYPE
426 );
427
428 --
429 -- ----------------------------------------------------------------------------
430 -- |----------------------------< create_timecard_bb >------------------------|
431 -- ----------------------------------------------------------------------------
432 --
433 -- {Start Of Comments}
434 /*#
435 * Procedure that creates Time Building Blocks of type TIMECARD and adds them
436 * to the Time Building Block PL/SQL Type Nested Table.
437 *
438 * Note that this procedure does not manipulate any of the database table
439 * contents. Only the PL/SQL nested table parameters passed into this procedure
440 * will be modified. The execute_deposit_process API will need to be used to
441 * actually update the database.
442 *
443 * <p><b>Licensing</b><br>
444 * This API version is licensed for use with Time and Labor.
445 *
446 * <p><b>Prerequisites</b><br>
447 * The resource must exist.
448 *
449 * <p><b>Post Success</b><br>
450 * Time Building Block of type Timecard will have been added to the Time
451 * Building Block PL/SQL Type Nested Table.
452 *
453 * <p><b>Post Failure</b><br>
454 * Time Building Block of type Timecard will not get added to the Time Building
455 * Block PL/SQL Type Nested Table.
456 *
457 * @param p_start_time The first day of the TIMECARD.
458 * @param p_stop_time The last day of the TIMECARD.
459 * @param p_resource_id Resource to which the Time Building Block belongs.
460 * @param p_resource_type Type of resource, currently must be set to 'PERSON'.
461 * @param p_approval_style_id WORKING' or 'SUBMITTED'. When this parameter is
462 * set to null, the real value will be derived from the mode used during
463 * deposit.
464 * @param p_comment_text Comment to be stored with the TIMECARD Time Building
465 * Block.
466 * @param p_app_blocks Pass in the Timecard PL/SQL Table to attach the TIMECARD
467 * Time Building Block to. On success, the Time Building Block created will be
468 * added to this PL/SQL Table.
469 * @param p_time_building_block_id Uniquely identifies the Time Building Block
470 * created.
471 * @rep:displayname Create Timecard Time Building Block
472 * @rep:category BUSINESS_ENTITY HXC_TIMECARD
473 * @rep:lifecycle active
474 * @rep:scope public
475 * @rep:metalink 223987.1 OTL HXC TimeStore Deposit
476 */
477 --
478 -- {End Of Comments}
479 --
480 PROCEDURE create_timecard_bb (
481 p_start_time IN hxc_time_building_blocks.start_time%TYPE,
482 p_stop_time IN hxc_time_building_blocks.stop_time%TYPE,
483 -- p_approval_status IN hxc_time_building_blocks.approval_status%TYPE,
484 p_resource_id IN hxc_time_building_blocks.resource_id%TYPE,
485 -- default to person because there is no other resource type at the moment.
486 p_resource_type IN hxc_time_building_blocks.resource_type%TYPE
487 DEFAULT hxc_timecard.c_person_resource,
488 -- We cannot use approval_style_name because that is not unique.
489 p_approval_style_id IN hxc_time_building_blocks.approval_style_id%TYPE
490 DEFAULT NULL,
491 p_comment_text IN hxc_time_building_blocks.comment_text%TYPE
492 DEFAULT NULL,
493 p_app_blocks IN OUT NOCOPY hxc_self_service_time_deposit.timecard_info,
494 p_time_building_block_id OUT NOCOPY hxc_time_building_blocks.time_building_block_id%TYPE
495 );
496
497 --
498 -- ----------------------------------------------------------------------------
499 -- |------------------------------< create_day_bb >---------------------------|
500 -- ----------------------------------------------------------------------------
501 --
502 -- {Start Of Comments}
503 /*#
504 * Procedure that creates Time Building Blocks of type DAY and adds them to the
505 * Time Building Block SQL Type Nested Table.
506 *
507 * Note that this procedure does not manipulate any of the database table
508 * contents. Only the PL/SQL nested table parameters passed into this procedure
509 * will be modified. The execute_deposit_process API will need to be used to
510 * actually update the database.
511 *
512 * <p><b>Licensing</b><br>
513 * This API version is licensed for use with Time and Labor.
514 *
515 * <p><b>Prerequisites</b><br>
516 * A Time Building Block of type TIMECARD should have been already added to the
517 * SQL Type Nested Table.
518 *
519 * <p><b>Post Success</b><br>
520 * Time Building Block of type DAY will have been added to the Time Building
521 * Block SQL Type Nested Table.
522 *
523 * <p><b>Post Failure</b><br>
524 * Time Building Block of type DAY will not be added to the Time Building Block
525 * SQL Type Nested Table.
526 *
527 * @param p_day Day to create the DAY Time Building Block.
528 * @param p_resource_id Resource to which the Time Building Block belongs.
529 * @param p_resource_type Type of resource, currently must be set to 'PERSON'.
530 * @param p_comment_text Comment to be stored with the DAY Time Building Block.
531 * @param p_deposit_process Deposit process indicates which attribute to
532 * application mapping should be used to retrieve the Timecard attributes.
533 * @param p_app_blocks Pass in the Time Building Block SQL Type Nested Table to
534 * attach the DAY Time Building Block to. On success, the Time Building Block
535 * created will be added to this SQL Type Nested Table.
536 * @param p_time_building_block_id Uniquely identifies the Time Building Block
537 * created.
538 * @rep:displayname Create Day Time Building Block
539 * @rep:category BUSINESS_ENTITY HXC_TIMECARD
540 * @rep:lifecycle active
541 * @rep:primaryinstance
542 * @rep:scope public
543 * @rep:metalink 223987.1 OTL HXC TimeStore Deposit
544 */
545 --
546 -- {End Of Comments}
547 --
548 PROCEDURE create_day_bb (
549 p_day IN hxc_time_building_blocks.start_time%TYPE,
550 p_resource_id IN hxc_time_building_blocks.resource_id%TYPE,
551 p_resource_type IN hxc_time_building_blocks.resource_type%TYPE
552 DEFAULT hxc_timecard.c_person_resource,
553 p_comment_text IN hxc_time_building_blocks.comment_text%TYPE
554 DEFAULT NULL,
555 -- p_parent_building_block_ovn hxc_time_building_blocks.parent_building_block_ovn%TYPE
556 -- DEFAULT 1,
557 p_deposit_process IN hxc_deposit_processes.NAME%TYPE
558 DEFAULT g_otl_deposit_process,
559 p_app_blocks IN OUT NOCOPY hxc_block_table_type,
560 p_time_building_block_id OUT NOCOPY hxc_time_building_blocks.time_building_block_id%TYPE
561 );
562
563 --
564 -- ----------------------------------------------------------------------------
565 -- |------------------------------< create_day_bb >---------------------------|
566 -- ----------------------------------------------------------------------------
567 --
568 -- {Start Of Comments}
569 /*#
570 * Procedure that creates Time Building Blocks of type DAY and adds them to the
571 * Time Building Block PL/SQL Type Nested Table.
572 *
573 * Note that this procedure does not manipulate any of the database table
574 * contents. Only the PL/SQL nested table parameters passed into this procedure
575 * will be modified. The execute_deposit_process API will need to be used to
576 * actually update the database.
577 *
578 * <p><b>Licensing</b><br>
579 * This API version is licensed for use with Time and Labor.
580 *
581 * <p><b>Prerequisites</b><br>
582 * A Time Building Block of type TIMECARD should have been added already to the
583 * PL/SQL Type Nested Table.
584 *
585 * <p><b>Post Success</b><br>
586 * Time Building Block of type DAY will have been added to the Time Building
587 * Block PL/SQL Type Nested Table.
588 *
589 * <p><b>Post Failure</b><br>
590 * Time Building Block of type DAY will not get added to the Time Building
591 * Block PL/SQL Type Nested Table.
592 *
593 * @param p_day Day to create the DAY Time Building Block.
594 * @param p_resource_id Resource to which the Time Building Block belongs.
595 * @param p_resource_type Type of resource, currently must be set to 'PERSON'.
596 * @param p_comment_text Comment to be stored with the DAY Time Building Block.
597 * @param p_deposit_process Deposit process indicates which attribute to
598 * application mapping should be used to retrieve the Timecard attributes.
599 * @param p_app_blocks Pass in the Time Building Block PL/SQL Type Nested Table
600 * to attach the DAY Time Building Block to. On success, the Time Building
601 * Block created will be added to this PL/SQL Type Nested Table.
602 * @param p_time_building_block_id Uniquely identifies the Time Building Block
603 * created.
604 * @rep:displayname Create Day Time Building Block
605 * @rep:category BUSINESS_ENTITY HXC_TIMECARD
606 * @rep:lifecycle active
607 * @rep:scope public
608 * @rep:metalink 223987.1 OTL HXC TimeStore Deposit
609 */
610 --
611 -- {End Of Comments}
612 --
613 PROCEDURE create_day_bb (
614 p_day IN hxc_time_building_blocks.start_time%TYPE,
615 p_resource_id IN hxc_time_building_blocks.resource_id%TYPE,
616 p_resource_type IN hxc_time_building_blocks.resource_type%TYPE
617 DEFAULT hxc_timecard.c_person_resource,
618 p_comment_text IN hxc_time_building_blocks.comment_text%TYPE
619 DEFAULT NULL,
620 -- p_parent_building_block_ovn hxc_time_building_blocks.parent_building_block_ovn%TYPE
621 -- DEFAULT 1,
622 p_deposit_process IN hxc_deposit_processes.NAME%TYPE
623 DEFAULT g_otl_deposit_process,
624 p_app_blocks IN OUT NOCOPY hxc_self_service_time_deposit.timecard_info,
625 p_time_building_block_id OUT NOCOPY hxc_time_building_blocks.time_building_block_id%TYPE
626 );
627
628 --
629 -- ----------------------------------------------------------------------------
630 -- |------------------------------< create_day_bb >---------------------------|
631 -- ----------------------------------------------------------------------------
632 --
633 -- {Start Of Comments}
634 /*#
635 * Procedure that creates Time Building Blocks of type DAY and adds them to the
636 * Time Building Block SQL Type Nested Table.
637 *
638 * Note that this procedure does not manipulate any of the database table
639 * contents. Only the PL/SQL nested table parameters passed into this procedure
640 * will be modified. The execute_deposit_process API will need to be used to
641 * actually update the database.
642 *
643 * <p><b>Licensing</b><br>
644 * This API version is licensed for use with Time and Labor.
645 *
646 * <p><b>Prerequisites</b><br>
647 * A Time Building Block of type TIMECARD should have been added already to the
648 * SQL Type Nested Table.
649 *
650 * <p><b>Post Success</b><br>
651 * Time Building Block of type DAY will have been added to the Time Building
652 * Block SQL Type Nested Table.
653 *
654 * <p><b>Post Failure</b><br>
655 * Time Building Block of type DAY will not get added to the Time Building
656 * Block SQL Type Nested Table.
657 *
658 * @param p_day Day to create the DAY Time Building Block.
659 * @param p_parent_building_block_id Identifies the parent (Timecard) Time
660 * Building Block.
661 * @param p_comment_text Comment to be stored with the DAY Time Building Block.
662 * @param p_parent_building_block_ovn Object Version Number of the parent Time
663 * Building Block.
664 * @param p_deposit_process Deposit process indicates which attribute to
665 * application mapping should be used to retrieve the Timecard attributes.
666 * @param p_app_blocks Pass in the Time Building Block SQL Type Nested Table to
667 * attach the DAY Time Building Block to. On success, the Time Building Block
668 * created will be added to this SQL Type Nested Table.
669 * @param p_time_building_block_id Uniquely identifies the Time Building Block
670 * created.
671 * @rep:displayname Create Day Time Building Block
672 * @rep:category BUSINESS_ENTITY HXC_TIMECARD
673 * @rep:lifecycle active
674 * @rep:scope public
675 * @rep:metalink 223987.1 OTL HXC TimeStore Deposit
676 */
677 --
678 -- {End Of Comments}
679 --
680 PROCEDURE create_day_bb (
681 p_day IN hxc_time_building_blocks.start_time%TYPE,
682 p_parent_building_block_id IN hxc_time_building_blocks.parent_building_block_id%TYPE
683 DEFAULT NULL,
684 p_comment_text IN hxc_time_building_blocks.comment_text%TYPE
685 DEFAULT NULL,
686 p_parent_building_block_ovn IN hxc_time_building_blocks.parent_building_block_ovn%TYPE
687 DEFAULT 1,
688 p_deposit_process IN hxc_deposit_processes.NAME%TYPE
689 DEFAULT g_otl_deposit_process,
690 p_app_blocks IN OUT NOCOPY hxc_block_table_type,
691 p_time_building_block_id OUT NOCOPY hxc_time_building_blocks.time_building_block_id%TYPE
692 );
693
694 --
695 -- ----------------------------------------------------------------------------
696 -- |------------------------------< create_day_bb >---------------------------|
697 -- ----------------------------------------------------------------------------
698 --
699 -- {Start Of Comments}
700 /*#
701 * Procedure that creates Time Building Blocks of type DAY and adds them to the
702 * Time Building Block PL/SQL Type Nested Table.
703 *
704 * Note that this procedure does not manipulate any of the database table
705 * contents. Only the PL/SQL nested table parameters passed into this procedure
706 * will be modified. The execute_deposit_process API will need to be used to
707 * actually update the database.
708 *
709 * <p><b>Licensing</b><br>
710 * This API version is licensed for use with Time and Labor.
711 *
712 * <p><b>Prerequisites</b><br>
713 * A Time Building Block of type TIMECARD should have been added already to the
714 * PL/SQL Type Nested Table.
715 *
716 * <p><b>Post Success</b><br>
717 * Time Building Block of type DAY will have been added to the Time Building
718 * Block PL/SQL Type Nested Table.
719 *
720 * <p><b>Post Failure</b><br>
721 * Time Building Block of type DAY will not get added to the Time Building
722 * Block PL/SQL Type Nested Table.
723 *
724 * @param p_day Day to create the DAY Time Building Block.
725 * @param p_parent_building_block_id Identifies the parent Timecard Time
726 * Building Block.
727 * @param p_comment_text Comment to be stored with the DAY Time Building Block.
728 * @param p_parent_building_block_ovn Object Version Number of the parent Time
729 * Building Block.
730 * @param p_deposit_process Deposit process indicates which attribute to
731 * application mapping should be used to retrieve the Timecard attributes.
732 * @param p_app_blocks Pass in the Time Building Block PL/SQL Type Nested Table
733 * to attach the DAY Time Building Block to. On success, the Time Building
734 * Block created will be added to this PL/SQL Type Nested Table.
735 * @param p_time_building_block_id Uniquely identifies the Time Building Block
736 * created.
737 * @rep:displayname Create Day Time Building Block
738 * @rep:category BUSINESS_ENTITY HXC_TIMECARD
739 * @rep:lifecycle active
740 * @rep:scope public
741 * @rep:metalink 223987.1 OTL HXC TimeStore Deposit
742 */
743 --
744 -- {End Of Comments}
745 --
746 PROCEDURE create_day_bb (
747 p_day IN hxc_time_building_blocks.start_time%TYPE,
748 p_parent_building_block_id IN hxc_time_building_blocks.parent_building_block_id%TYPE
749 DEFAULT NULL,
750 p_comment_text IN hxc_time_building_blocks.comment_text%TYPE
751 DEFAULT NULL,
752 p_parent_building_block_ovn IN hxc_time_building_blocks.parent_building_block_ovn%TYPE
753 DEFAULT 1,
754 p_deposit_process IN hxc_deposit_processes.NAME%TYPE
755 DEFAULT g_otl_deposit_process,
756 p_app_blocks IN OUT NOCOPY hxc_self_service_time_deposit.timecard_info,
757 p_time_building_block_id OUT NOCOPY hxc_time_building_blocks.time_building_block_id%TYPE
758 );
759
760 /* PROCEDURE auto_create_timecard (
761 p_resource_id IN hxc_time_building_blocks.resource_id%TYPE,
762 p_resource_type IN hxc_time_building_blocks.resource_type%TYPE,
763 p_day IN hxc_time_building_blocks.start_time%TYPE,
764 p_deposit_process IN hxc_deposit_processes.NAME%TYPE
765 DEFAULT g_otl_deposit_process,
766 p_app_blocks IN OUT NOCOPY hxc_block_table_type,
767 p_app_attributes IN OUT NOCOPY hxc_self_service_time_deposit.app_attributes_info,
768 p_time_building_block_id OUT NOCOPY hxc_time_building_blocks.time_building_block_id%TYPE
769 );
770
771 PROCEDURE auto_create_timecard (
772 p_resource_id IN hxc_time_building_blocks.resource_id%TYPE,
773 p_resource_type IN hxc_time_building_blocks.resource_type%TYPE,
774 p_day IN hxc_time_building_blocks.start_time%TYPE,
775 p_deposit_process IN hxc_deposit_processes.NAME%TYPE
776 DEFAULT g_otl_deposit_process,
777 p_app_blocks IN OUT NOCOPY hxc_self_service_time_deposit.timecard_info,
778 p_app_attributes IN OUT NOCOPY hxc_self_service_time_deposit.app_attributes_info,
779 p_time_building_block_id OUT NOCOPY hxc_time_building_blocks.time_building_block_id%TYPE
780 ); */
781
782
783 --
784 -- ----------------------------------------------------------------------------
785 -- |-----------------------------< create_detail_bb >-------------------------|
786 -- ----------------------------------------------------------------------------
787 --
788 -- {Start Of Comments}
789 /*#
790 * Procedure that creates Time Building Blocks of type DETAIL and adds them to
791 * the Time Building Block SQL Type Nested Table.
792 *
793 * Note that this procedure does not manipulate any of the database table
794 * contents. Only the PL/SQL nested table parameters passed into this procedure
795 * will be modified. The execute_deposit_process API will need to be used to
796 * actually update the database.
797 *
798 * <p><b>Licensing</b><br>
799 * This API version is licensed for use with Time and Labor.
800 *
801 * <p><b>Prerequisites</b><br>
802 * A Time Building Block of type DAY should have been added already to the SQL
803 * Type Nested Table.
804 *
805 * <p><b>Post Success</b><br>
806 * Time Building Block of type DETAIL will have been added to the Time Building
807 * Block SQL Type Nested Table.
808 *
809 * <p><b>Post Failure</b><br>
810 * Time Building Block of type DETAIL will not get added to the Time Building
811 * Block SQL Type Nested Table.
812 *
813 * @param p_type Type of the Time Building Block: 'MEASURE' or 'RANGE'.
814 * @param p_measure The actual time recorded, only provide when type is
815 * 'MEASURE'.
816 * @param p_start_time The IN time: only provide when type is 'RANGE'.
817 * @param p_stop_time The OUT time: only provide when type is 'RANGE'.
818 * @param p_parent_building_block_id Identifies the parent (Detail) Time
819 * Building Block
820 * @param p_comment_text Comment to be stored with the DETAIL Time Building
821 * Block
822 * @param p_parent_building_block_ovn Object Version Number of the parent Time
823 * Building Block.
824 * @param p_deposit_process Deposit process indicates which attribute to
825 * application mapping should be used to retrieve the Timecard attributes.
826 * @param p_unit_of_measure Units of measure for p_measure, the default value
827 * is recommended for most scenarios.
828 * @param p_app_blocks Pass in the Time Building Block SQL Type Nested Table to
829 * attach the DETAIL Time Building Block to. On success, the Time Building
830 * Block created will be added to this SQL Type Nested Table.
831 * @param p_app_attributes Pass in the Time Attribute PL/SQL Type Nested Table
832 * containing the Time Building Blocks attributes which have already been
833 * created. This procedure will not modify the table contents.
834 * @param p_time_building_block_id Uniquely identifies the Time Building Block
835 * created.
836 * @rep:displayname Create Detail Time Building Block
837 * @rep:category BUSINESS_ENTITY HXC_TIMECARD
838 * @rep:lifecycle active
839 * @rep:primaryinstance
840 * @rep:scope public
841 * @rep:metalink 223987.1 OTL HXC TimeStore Deposit
842 */
843 --
844 -- {End Of Comments}
845 --
846 PROCEDURE create_detail_bb (
847 p_type IN hxc_time_building_blocks.TYPE%TYPE,
848 p_measure IN hxc_time_building_blocks.measure%TYPE
849 DEFAULT NULL,
850 p_start_time IN hxc_time_building_blocks.start_time%TYPE
851 DEFAULT NULL,
852 p_stop_time IN hxc_time_building_blocks.stop_time%TYPE
853 DEFAULT NULL,
854 p_parent_building_block_id IN hxc_time_building_blocks.parent_building_block_id%TYPE,
855 -- For now, these need to be the same as the parent BB (the TIMECARD BB). We set this in the code,
856 -- the user cannot manipulate this.
857 -- p_approval_status IN hxc_time_building_blocks.approval_status%TYPE,
858 -- p_resource_id IN hxc_time_building_blocks.resource_id%TYPE,
859 -- p_resource_type IN hxc_time_building_blocks.resource_type%TYPE,
860 -- p_approval_style_id IN hxc_time_building_blocks.approval_style_id%TYPE,
861 p_comment_text IN hxc_time_building_blocks.comment_text%TYPE
862 DEFAULT NULL,
863 p_parent_building_block_ovn IN hxc_time_building_blocks.parent_building_block_ovn%TYPE
864 DEFAULT 1,
865 p_deposit_process IN hxc_deposit_processes.NAME%TYPE
866 DEFAULT g_otl_deposit_process,
867 p_unit_of_measure IN hxc_time_building_blocks.unit_of_measure%TYPE
868 DEFAULT NULL,
869 p_app_blocks IN OUT NOCOPY hxc_block_table_type,
870 p_app_attributes IN OUT NOCOPY hxc_self_service_time_deposit.app_attributes_info,
871 p_time_building_block_id OUT NOCOPY hxc_time_building_blocks.time_building_block_id%TYPE
872 );
873
874 --
875 -- ----------------------------------------------------------------------------
876 -- |-----------------------------< create_detail_bb >-------------------------|
877 -- ----------------------------------------------------------------------------
878 --
879 -- {Start Of Comments}
880 /*#
881 * Procedure that creates Time Building Blocks of type DETAIL and adds them to
882 * the Time Building Block PL/SQL Type Nested Table.
883 *
884 * Note that this procedure does not manipulate any of the database table
885 * contents. Only the PL/SQL nested table parameters passed into this procedure
886 * will be modified. The execute_deposit_process API will need to be used to
887 * actually update the database.
888 *
889 * <p><b>Licensing</b><br>
890 * This API version is licensed for use with Time and Labor.
891 *
892 * <p><b>Prerequisites</b><br>
893 * A Time Building Block of type DAY should have been added already to the
894 * PL/SQL Type Nested Table.
895 *
896 * <p><b>Post Success</b><br>
897 * Time Building Block of type DETAIL will have been added to the Time Building
898 * Block PL/SQL Type Nested Table.
899 *
900 * <p><b>Post Failure</b><br>
901 * Time Building Block of type DETAIL will not get added to the Time Building
902 * Block PL/SQL Type Nested Table.
903 *
904 * @param p_type Type of the Time Building Block: 'MEASURE' or 'RANGE'.
905 * @param p_measure The actual time recorded, only provide when type is
906 * 'MEASURE'.
907 * @param p_start_time The IN time: only provide when type is 'RANGE'.
908 * @param p_stop_time The OUT time: only provide when type is 'RANGE'.
909 * @param p_parent_building_block_id Identifies the parent (Detail) Time
910 * Building Block.
911 * @param p_comment_text Comment to be stored with the DETAIL Time Building
912 * Block.
913 * @param p_parent_building_block_ovn Object Version Number of the parent Time
914 * Building Block.
915 * @param p_deposit_process Deposit process indicates which attribute to
916 * application mapping should be used to retrieve the Timecard attributes.
917 * @param p_unit_of_measure Units of measure for p_measure, the default value
918 * is recommended for most scenarios.
919 * @param p_app_blocks Pass in the Time Building Block PL/SQL Type Nested Table
920 * to attach the DETAIL Time Building Block to. On success, the Time Building
921 * Block created will be added to this PL/SQL Type Nested Table.
922 * @param p_app_attributes Pass in the Time Attribute PL/SQL Type Nested Table
923 * containing the Time Building Blocks attributes which have already been
924 * created. This procedure will not modify the table contents.
925 * @param p_time_building_block_id Uniquely identifies the Time Building Block
926 * created.
927 * @rep:displayname Create Detail Time Building Block
928 * @rep:category BUSINESS_ENTITY HXC_TIMECARD
929 * @rep:lifecycle active
930 * @rep:scope public
931 * @rep:metalink 223987.1 OTL HXC TimeStore Deposit
932 */
933 --
934 -- {End Of Comments}
935 --
936 PROCEDURE create_detail_bb (
937 p_type IN hxc_time_building_blocks.TYPE%TYPE,
938 p_measure IN hxc_time_building_blocks.measure%TYPE
939 DEFAULT NULL,
940 p_start_time IN hxc_time_building_blocks.start_time%TYPE
941 DEFAULT NULL,
942 p_stop_time IN hxc_time_building_blocks.stop_time%TYPE
943 DEFAULT NULL,
944 p_parent_building_block_id IN hxc_time_building_blocks.parent_building_block_id%TYPE,
945 -- For now, these need to be the same as the parent BB (the TIMECARD BB). We set this in the code,
946 -- the user cannot manipulate this.
947 -- p_approval_status IN hxc_time_building_blocks.approval_status%TYPE,
948 -- p_resource_id IN hxc_time_building_blocks.resource_id%TYPE,
949 -- p_resource_type IN hxc_time_building_blocks.resource_type%TYPE,
950 -- p_approval_style_id IN hxc_time_building_blocks.approval_style_id%TYPE,
951 p_comment_text IN hxc_time_building_blocks.comment_text%TYPE
952 DEFAULT NULL,
953 p_parent_building_block_ovn IN hxc_time_building_blocks.parent_building_block_ovn%TYPE
954 DEFAULT 1,
955 p_deposit_process IN hxc_deposit_processes.NAME%TYPE
956 DEFAULT g_otl_deposit_process,
957 p_unit_of_measure IN hxc_time_building_blocks.unit_of_measure%TYPE
958 DEFAULT NULL,
959 p_app_blocks IN OUT NOCOPY hxc_self_service_time_deposit.timecard_info,
960 p_app_attributes IN OUT NOCOPY hxc_self_service_time_deposit.app_attributes_info,
961 p_time_building_block_id OUT NOCOPY hxc_time_building_blocks.time_building_block_id%TYPE
962 );
963
964 --
965 -- ----------------------------------------------------------------------------
966 -- |----------------------------< create_time_entry >-------------------------|
967 -- ----------------------------------------------------------------------------
968 --
969 -- {Start Of Comments}
970 /*#
971 * Allows a "measure" Time Entry to be created, using the Timecard
972 * SQL Type Nested Table.
973 *
974 * This is a specialised procedure that allows creation of a Time Entry.This
975 * procedure will take care of creating the corresponding Timecard if it
976 * doesn't exist yet. Note that this procedure does not manipulate any of the
977 * database table contents. Only the PL/SQL nested table parameters passed into
978 * this procedure will be modified.The execute_deposit_process API will need to
979 * be used to actually update the database.
980 *
981 * <p><b>Licensing</b><br>
982 * This API version is licensed for use with Time and Labor.
983 *
984 * <p><b>Prerequisites</b><br>
985 * The resource must exist.
986 *
987 * <p><b>Post Success</b><br>
988 * Time Entry (i.e. Time Building Block of type DETAIL) will have been added to
989 * the Time Building Block SQL Type Nested Table.
990 *
991 * <p><b>Post Failure</b><br>
992 * Time Entry (i.e. Time Building Block of type DETAIL) will not get added to
993 * the Time Building Block SQL Type Nested Table and an error will be raised.
994 *
995 * @param p_measure The actual time recorded in hours.
996 * @param p_day Day to create the Time Entry.
997 * @param p_resource_id Resource to which the Time Building Block belongs.
998 * @param p_resource_type Type of resource, currently we only support 'PERSON'.
999 * @param p_comment_text Comment to be stored with the Time Entry.
1000 * @param p_deposit_process Deposit process indicates which attribute to
1001 * application mapping should be used to retrieve the Timecard attributes.
1002 * @param p_app_blocks Pass in the Time Building Block SQL Type Nested Table to
1003 * attach the Time Entry to. On success, the Time Building Block created will
1004 * be added to this SQL Type Nested Table.
1005 * @param p_app_attributes Pass in the Time Attribute PL/SQL Type Nested Table
1006 * containing the Time Building Blocks attributes which have already been
1007 * created. This procedure will not modify the table contents.
1008 * @param p_time_building_block_id Uniquely identifies the Time Building Block
1009 * created.
1010 * @rep:displayname Create Measure Time Entry
1011 * @rep:category BUSINESS_ENTITY HXC_TIMECARD
1012 * @rep:lifecycle active
1013 * @rep:primaryinstance
1014 * @rep:scope public
1015 * @rep:metalink 223987.1 OTL HXC TimeStore Deposit
1016 */
1017 --
1018 -- {End Of Comments}
1019 --
1020 PROCEDURE create_time_entry (
1021 p_measure IN hxc_time_building_blocks.measure%TYPE,
1022 p_day IN hxc_time_building_blocks.start_time%TYPE,
1023 p_resource_id IN hxc_time_building_blocks.resource_id%TYPE,
1024 p_resource_type IN hxc_time_building_blocks.resource_type%TYPE
1025 DEFAULT hxc_timecard.c_person_resource,
1026 p_comment_text IN hxc_time_building_blocks.comment_text%TYPE
1027 DEFAULT NULL,
1028 p_deposit_process IN hxc_deposit_processes.NAME%TYPE
1029 DEFAULT g_otl_deposit_process,
1030 p_app_blocks IN OUT NOCOPY hxc_block_table_type,
1031 p_app_attributes IN OUT NOCOPY hxc_self_service_time_deposit.app_attributes_info,
1032 p_time_building_block_id OUT NOCOPY hxc_time_building_blocks.time_building_block_id%TYPE
1033 );
1034
1035 --
1036 -- ----------------------------------------------------------------------------
1037 -- |----------------------------< create_time_entry >-------------------------|
1038 -- ----------------------------------------------------------------------------
1039 --
1040 -- {Start Of Comments}
1041 /*#
1042 * Allows creation of a "measure" Time Entry, using the Timecard
1043 * PL/SQL Type Nested Table.
1044 *
1045 * This procedure will take care of creating the corresponding Timecard
1046 * Structure if it doesn't exist yet. Note that this procedure does not
1047 * manipulate any of the database table contents. Only the PL/SQL nested table
1048 * parameters passed into this procedure will be modified. The
1049 * execute_deposit_process API will need to be used to actually update the
1050 * database.
1051 *
1052 * <p><b>Licensing</b><br>
1053 * This API version is licensed for use with Time and Labor.
1054 *
1055 * <p><b>Prerequisites</b><br>
1056 * The resource must exist.
1057 *
1058 * <p><b>Post Success</b><br>
1059 * Time Entry (i.e. Time Building Block of type DETAIL) will have been added to
1060 * the Time Building Block PL/SQL Type Nested Table.
1061 *
1062 * <p><b>Post Failure</b><br>
1063 * Time Entry (i.e. Time Building Block of type DETAIL) will not get added to
1064 * the Time Building Block PL/SQL Type Nested Table and an error will be
1065 * raised.
1066 *
1067 * @param p_measure The actual time recorded in hours.
1068 * @param p_day Day to create the Time Entry.
1069 * @param p_resource_id Resource to which the Time Building Block belongs.
1070 * @param p_resource_type Type of resource, currently we only support 'PERSON'.
1071 * @param p_comment_text Comment to be stored with the Time Entry.
1072 * @param p_deposit_process Deposit process indicates which attribute to
1073 * application mapping should be used to retrieve the Timecard attributes.
1074 * @param p_app_blocks Pass in the Time Building Block PL/SQL Type Nested Table
1075 * to attach the Time Entry to. On success, the Time Building Block created
1076 * will be added to this SQL Type Nested Table.
1077 * @param p_app_attributes Pass in the Time Attribute PL/SQL Type Nested Table
1078 * containing the Time Building Blocks attributes which have already been
1079 * created. This procedure will not modify the table contents.
1080 * @param p_time_building_block_id Uniquely identifies the Time Building Block
1081 * created.
1082 * @rep:displayname Create Measure Time Entry
1083 * @rep:category BUSINESS_ENTITY HXC_TIMECARD
1084 * @rep:lifecycle active
1085 * @rep:scope public
1086 * @rep:metalink 223987.1 OTL HXC TimeStore Deposit
1087 */
1088 --
1089 -- {End Of Comments}
1090 --
1091 PROCEDURE create_time_entry (
1092 p_measure IN hxc_time_building_blocks.measure%TYPE,
1093 p_day IN hxc_time_building_blocks.start_time%TYPE,
1094 p_resource_id IN hxc_time_building_blocks.resource_id%TYPE,
1095 p_resource_type IN hxc_time_building_blocks.resource_type%TYPE
1096 DEFAULT hxc_timecard.c_person_resource,
1097 p_comment_text IN hxc_time_building_blocks.comment_text%TYPE
1098 DEFAULT NULL,
1099 p_deposit_process IN hxc_deposit_processes.NAME%TYPE
1100 DEFAULT g_otl_deposit_process,
1101 p_app_blocks IN OUT NOCOPY hxc_self_service_time_deposit.timecard_info,
1102 p_app_attributes IN OUT NOCOPY hxc_self_service_time_deposit.app_attributes_info,
1103 p_time_building_block_id OUT NOCOPY hxc_time_building_blocks.time_building_block_id%TYPE
1104 );
1105
1106 --
1107 -- ----------------------------------------------------------------------------
1108 -- |----------------------------< create_time_entry >-------------------------|
1109 -- ----------------------------------------------------------------------------
1110 --
1111 -- {Start Of Comments}
1112 /*#
1113 * Allows creation of a "range" Time Entry, using the Timecard SQL
1114 * Type Nested Table.
1115 *
1116 * This is a specialised procedure that allows creation of a Time Entry. This
1117 * procedure will take care of creating the corresponding Timecard Structure if
1118 * it doesn't exist yet. Note that this procedure does not manipulate any of
1119 * the database table contents. Only the PL/SQL nested table parameters passed
1120 * into this procedure will be modified.The execute_deposit_process API will
1121 * need to be used to actually update the database.
1122 *
1123 * <p><b>Licensing</b><br>
1124 * This API version is licensed for use with Time and Labor.
1125 *
1126 * <p><b>Prerequisites</b><br>
1127 * The resource must exist.
1128 *
1129 * <p><b>Post Success</b><br>
1130 * Time Entry (i.e. Time Building Block of type DETAIL) will have been added to
1131 * the Time Building Block SQL Type Nested Table.
1132 *
1133 * <p><b>Post Failure</b><br>
1134 * Time Entry (i.e. Time Building Block of type DETAIL) will not get added to
1135 * the Time Building Block SQL Type Nested Table and an error will be raised.
1136 *
1137 * @param p_start_time The IN time.
1138 * @param p_stop_time The OUT time.
1139 * @param p_resource_id Resource to which the Time Building Block belongs.
1140 * @param p_resource_type Type of resource, currently we only support 'PERSON'.
1141 * @param p_comment_text Comment to be stored with the Time Entry.
1142 * @param p_deposit_process Deposit process indicates which attribute to
1143 * application mapping should be used to retrieve the Timecard attributes.
1144 * @param p_app_blocks Pass in the Time Building Block PL/SQL Type Nested Table
1145 * to attach the Time Entry to. On success, the Time Building Block created
1146 * will be added to this SQL Type Nested Table.
1147 * @param p_app_attributes Pass in the Time Attribute PL/SQL Type Nested Table
1148 * containing the Time Building Blocks attributes which have already been
1149 * created. This procedure will not modify the table contents.
1150 * @param p_time_building_block_id Uniquely identifies the Time Building Block
1151 * created.
1152 * @rep:displayname Create Range Time Entry
1153 * @rep:category BUSINESS_ENTITY HXC_TIMECARD
1154 * @rep:lifecycle active
1155 * @rep:scope public
1156 * @rep:metalink 223987.1 OTL HXC TimeStore Deposit
1157 */
1158 --
1159 -- {End Of Comments}
1160 --
1161 PROCEDURE create_time_entry (
1162 p_start_time IN hxc_time_building_blocks.start_time%TYPE,
1163 p_stop_time IN hxc_time_building_blocks.start_time%TYPE,
1164 p_resource_id IN hxc_time_building_blocks.resource_id%TYPE,
1165 p_resource_type IN hxc_time_building_blocks.resource_type%TYPE
1166 DEFAULT hxc_timecard.c_person_resource,
1167 p_comment_text IN hxc_time_building_blocks.comment_text%TYPE
1168 DEFAULT NULL,
1169 p_deposit_process IN hxc_deposit_processes.NAME%TYPE
1170 DEFAULT g_otl_deposit_process,
1171 p_app_blocks IN OUT NOCOPY hxc_block_table_type,
1172 p_app_attributes IN OUT NOCOPY hxc_self_service_time_deposit.app_attributes_info,
1173 p_time_building_block_id OUT NOCOPY hxc_time_building_blocks.time_building_block_id%TYPE
1174 );
1175
1176 --
1177 -- ----------------------------------------------------------------------------
1178 -- |----------------------------< create_time_entry >-------------------------|
1179 -- ----------------------------------------------------------------------------
1180 --
1181 -- {Start Of Comments}
1182 /*#
1183 * Allows creation of a "range" Time Entry, using the Timecard PL/SQL
1184 * Type Nested Table.
1185 *
1186 * Allows creations of a Time Entry. This procedure will take care of creating
1187 * the corresponding Timecard Structure if it doesn't exist yet. Note that this
1188 * procedure does not manipulate any of the database table contents. Only the
1189 * PL/SQL nested table parameters passed into this procedure will be modified.
1190 * The execute_deposit_process API will need to be used to actually update the
1191 * database.
1192 *
1193 * <p><b>Licensing</b><br>
1194 * This API version is licensed for use with Time and Labor.
1195 *
1196 * <p><b>Prerequisites</b><br>
1197 * The resource must exist.
1198 *
1199 * <p><b>Post Success</b><br>
1200 * Time Entry (i.e. Time Building Block of type DETAIL) will have been added to
1201 * the Time Building Block PL/SQL Type Nested Table.
1202 *
1203 * <p><b>Post Failure</b><br>
1204 * Time Entry (i.e. Time Building Block of type DETAIL) will not get added to
1205 * the Time Building Block PL/SQL Type Nested Table and an error will be
1206 * raised.
1207 *
1208 * @param p_start_time The IN time.
1209 * @param p_stop_time The OUT time.
1210 * @param p_resource_id Resource to which the Time Building Block belongs.
1211 * @param p_resource_type Type of resource, currently we only support 'PERSON'.
1212 * @param p_comment_text Comment to be stored with the Time Entry.
1213 * @param p_deposit_process Deposit process indicates which attribute to
1214 * application mapping should be used to retrieve the Timecard attributes.
1215 * @param p_app_blocks Pass in the Time Building Block PL/SQL Type Nested Table
1216 * to attach the Time Entry to. On success, the Time Building Block created
1217 * will be added to this SQL Type Nested Table.
1218 * @param p_app_attributes Pass in the Time Attribute PL/SQL Type Nested Table
1219 * containing the Time Building Blocks attributes which have already been
1220 * created. This procedure will not modify the table contents.
1221 * @param p_time_building_block_id Uniquely identifies the Time Building Block
1222 * created.
1223 * @rep:displayname Create Range Time Entry
1224 * @rep:category BUSINESS_ENTITY HXC_TIMECARD
1225 * @rep:lifecycle active
1226 * @rep:scope public
1227 * @rep:metalink 223987.1 OTL HXC TimeStore Deposit
1228 */
1229 --
1230 -- {End Of Comments}
1231 --
1232 PROCEDURE create_time_entry (
1233 p_start_time IN hxc_time_building_blocks.start_time%TYPE,
1234 p_stop_time IN hxc_time_building_blocks.start_time%TYPE,
1235 p_resource_id IN hxc_time_building_blocks.resource_id%TYPE,
1236 p_resource_type IN hxc_time_building_blocks.resource_type%TYPE
1237 DEFAULT hxc_timecard.c_person_resource,
1238 p_comment_text IN hxc_time_building_blocks.comment_text%TYPE
1239 DEFAULT NULL,
1240 p_deposit_process IN hxc_deposit_processes.NAME%TYPE
1241 DEFAULT g_otl_deposit_process,
1242 p_app_blocks IN OUT NOCOPY hxc_self_service_time_deposit.timecard_info,
1243 p_app_attributes IN OUT NOCOPY hxc_self_service_time_deposit.app_attributes_info,
1244 p_time_building_block_id OUT NOCOPY hxc_time_building_blocks.time_building_block_id%TYPE
1245 );
1246
1247 --
1248 -- ----------------------------------------------------------------------------
1249 -- |-----------------------------< create_attribute >-------------------------|
1250 -- ----------------------------------------------------------------------------
1251 --
1252 -- {Start Of Comments}
1253 /*#
1254 * Allows a Time Attribute to be created, using the Time Attribute PL/SQL Type
1255 * Nested Table. Note that this procedure does not manipulate any of the
1256 * database table contents. Only the PL/SQL nested table parameters passed into
1257 * this procedure will be modified. The execute_deposit_process API will need
1258 * to be used to actually update the database.
1259 *
1260 *
1261 * <p><b>Licensing</b><br>
1262 * This API is licensed for use with Time and Labor.
1263 *
1264 * <p><b>Prerequisites</b><br>
1265 * The Time Building Block should already be present in the Timecard PL/SQL
1266 * Table.
1267 *
1268 * <p><b>Post Success</b><br>
1269 * Time Attribute will have been added to the Time Attribute PL/SQL Type Nested
1270 * Table.
1271 *
1272 * <p><b>Post Failure</b><br>
1273 * Time Attribute will not get added to the Time Attribute PL/SQL Type Nested
1274 * Table.
1275 *
1276 * @param p_building_block_id Identifies the Time Building Block to attach the
1277 * Time Attribute too.
1278 * @param p_attribute_name Name of the attribute to be created.
1279 * @param p_attribute_value Value of the attribute to be created.
1280 * @param p_deposit_process Deposit process indicates which attribute to
1281 * application mapping should be used to retrieve the Timecard attributes.
1282 * @param p_attribute_id Uniquely identifies the Time Attribute created.
1283 * @param p_app_attributes Pass in the Time Attribute PL/SQL Type Nested Table
1284 * to attach the Time Attribute to. On success, the Time Attribute created will
1285 * be added to this PL/SQL Type Nested Table.
1286 * @rep:displayname Create Time Attribute
1287 * @rep:category BUSINESS_ENTITY HXC_TIMECARD
1288 * @rep:lifecycle active
1289 * @rep:scope public
1290 * @rep:metalink 223987.1 OTL HXC TimeStore Deposit
1291 */
1292 --
1293 -- {End Of Comments}
1294 --
1295 PROCEDURE create_attribute (
1296 p_building_block_id IN hxc_time_building_blocks.time_building_block_id%TYPE,
1297 p_attribute_name IN hxc_mapping_components.field_name%TYPE,
1298 p_attribute_value IN hxc_time_attributes.attribute1%TYPE,
1299 -- p_category IN hxc_bld_blk_info_type_usages.building_block_category%TYPE,
1300 p_deposit_process IN hxc_deposit_processes.NAME%TYPE
1301 DEFAULT g_otl_deposit_process,
1302 p_attribute_id IN hxc_time_attributes.time_attribute_id%TYPE
1303 DEFAULT NULL,
1304 p_app_attributes IN OUT NOCOPY hxc_self_service_time_deposit.app_attributes_info
1305 );
1306
1307 --
1308 -- ----------------------------------------------------------------------------
1309 -- |--------------------------< update_building_block >-----------------------|
1310 -- ----------------------------------------------------------------------------
1311 --
1312 -- {Start Of Comments}
1313 /*#
1314 * Allows a Time Building Block to be updated, using the Time Building Block
1315 * SQL Type Nested Table.
1316 *
1317 * Note that this procedure does not manipulate any of the database table
1318 * contents. Only the PL/SQL nested table parameters passed into this procedure
1319 * will be modified. The execute_deposit_process API will need to be used to
1320 * actually update the database.
1321 *
1322 * <p><b>Licensing</b><br>
1323 * This API version is licensed for use with Time and Labor.
1324 *
1325 * <p><b>Prerequisites</b><br>
1326 * The Time Building Block to be updated should exist.
1327 *
1328 * <p><b>Post Success</b><br>
1329 * Time Building Block is updated.
1330 *
1331 * <p><b>Post Failure</b><br>
1332 * Time Building Block is not updated.
1333 *
1334 * @param p_building_block_id Identifies the Time Building Block to modify.
1335 * @param p_measure The actual time recorded, only provide when the Time
1336 * Building Block type is 'MEASURE'.
1337 * @param p_unit_of_measure Units of measure for p_measure.
1338 * @param p_start_time The IN time, only required when the Time Building Block
1339 * type is 'RANGE'.
1340 * @param p_stop_time The OUT time, only required when the Time Building Block
1341 * type is 'RANGE'.
1342 * @param p_comment_text Comment to be stored with the Time Building Block.
1343 * @param p_deposit_process Deposit process indicates which attribute to
1344 * application mapping should be used to retrieve the Timecard attributes.
1345 * @param p_app_blocks Pass in the Time Building Block SQL Type Nested Table to
1346 * attach the Time Entry to. On success, the Time Building Block updated will
1347 * be updated in this SQL Type Nested Table.
1348 * @param p_app_attributes Pass in the Time Attribute PL/SQL Type Nested Table
1349 * containing the Time Building Blocks attributes which have already been
1350 * created. This procedure will not modify the table contents.
1351 * @rep:displayname Update Time Building Block
1352 * @rep:category BUSINESS_ENTITY HXC_TIMECARD
1353 * @rep:lifecycle active
1354 * @rep:primaryinstance
1355 * @rep:scope public
1356 * @rep:metalink 223987.1 OTL HXC TimeStore Deposit
1357 */
1358 --
1359 -- {End Of Comments}
1360 --
1361 PROCEDURE update_building_block (
1362 p_building_block_id IN hxc_time_building_blocks.time_building_block_id%TYPE,
1363 p_measure IN hxc_time_building_blocks.measure%TYPE
1364 DEFAULT hr_api.g_number,
1365 p_unit_of_measure IN hxc_time_building_blocks.unit_of_measure%TYPE
1366 DEFAULT hr_api.g_varchar2,
1367 p_start_time IN hxc_time_building_blocks.start_time%TYPE
1368 DEFAULT hr_api.g_date,
1369 p_stop_time IN hxc_time_building_blocks.stop_time%TYPE
1370 DEFAULT hr_api.g_date,
1371 p_comment_text IN hxc_time_building_blocks.comment_text%TYPE
1372 DEFAULT hr_api.g_varchar2,
1373 -- p_time_recipient_id IN NUMBER,
1374 p_deposit_process IN hxc_deposit_processes.NAME%TYPE
1375 DEFAULT g_otl_deposit_process,
1376 p_app_blocks IN OUT NOCOPY hxc_block_table_type,
1377 p_app_attributes IN OUT NOCOPY hxc_self_service_time_deposit.app_attributes_info
1378 );
1379
1380 --
1381 -- ----------------------------------------------------------------------------
1382 -- |--------------------------< update_building_block >-----------------------|
1383 -- ----------------------------------------------------------------------------
1384 --
1385 -- {Start Of Comments}
1386 /*#
1387 * Allows update of a Time Building Block, using the Time Building Block PL/SQL
1388 * Type Nested Table.
1389 *
1390 * Note that this procedure does not manipulate any of the database table
1391 * contents. Only the PL/SQL nested table parameters passed into this procedure
1392 * will be modified. The execute_deposit_process API will need to be used to
1393 * actually update the database.
1394 *
1395 * <p><b>Licensing</b><br>
1396 * This API version is licensed for use with Time and Labor.
1397 *
1398 * <p><b>Prerequisites</b><br>
1399 * The Time Building Block being updated should exist.
1400 *
1401 * <p><b>Post Success</b><br>
1402 * Time Building Block gets updated
1403 *
1404 * <p><b>Post Failure</b><br>
1405 * Time Building Block does not get updated
1406 *
1407 * @param p_building_block_id Identifies the Time Building Block to modify.
1408 * @param p_measure The actual time recorded, only provide when type is
1409 * 'MEASURE'.
1410 * @param p_unit_of_measure Units of measure for p_measure, the default value
1411 * is recommended for most scenarios.
1412 * @param p_start_time The IN time: only provide when type is 'RANGE'.
1413 * @param p_stop_time The OUT time: only provide when type is 'RANGE'.
1414 * @param p_comment_text Comment to be stored with the Time Building Block.
1415 * @param p_deposit_process Deposit process indicates which attribute to
1416 * application mapping should be used to retrieve the Timecard attributes.
1417 * @param p_app_blocks Pass in the Time Building Block PL/SQL Type Nested Table
1418 * to attach the Time Entry to. On success, the Time Building Block updated
1419 * will be in this PL/SQL Type Nested Table.
1420 * @param p_app_attributes Pass in the Time Attribute PL/SQL Type Nested Table
1421 * containing the Time Building Blocks attributes which have already been
1422 * created. This procedure will not modify the table contents.
1423 * @rep:displayname Update Time Building Block
1424 * @rep:category BUSINESS_ENTITY HXC_TIMECARD
1425 * @rep:lifecycle active
1426 * @rep:scope public
1427 * @rep:metalink 223987.1 OTL HXC TimeStore Deposit
1428 */
1429 --
1430 -- {End Of Comments}
1431 --
1432 PROCEDURE update_building_block (
1433 p_building_block_id IN hxc_time_building_blocks.time_building_block_id%TYPE,
1434 p_measure IN hxc_time_building_blocks.measure%TYPE
1435 DEFAULT hr_api.g_number,
1436 p_unit_of_measure IN hxc_time_building_blocks.unit_of_measure%TYPE
1437 DEFAULT hr_api.g_varchar2,
1438 p_start_time IN hxc_time_building_blocks.start_time%TYPE
1439 DEFAULT hr_api.g_date,
1440 p_stop_time IN hxc_time_building_blocks.stop_time%TYPE
1441 DEFAULT hr_api.g_date,
1442 p_comment_text IN hxc_time_building_blocks.comment_text%TYPE
1443 DEFAULT hr_api.g_varchar2,
1444 -- p_time_recipient_id IN NUMBER,
1445 p_deposit_process IN hxc_deposit_processes.NAME%TYPE
1446 DEFAULT g_otl_deposit_process,
1447 p_app_blocks IN OUT NOCOPY hxc_self_service_time_deposit.timecard_info,
1448 p_app_attributes IN OUT NOCOPY hxc_self_service_time_deposit.app_attributes_info
1449 );
1450
1451 --
1452 -- ----------------------------------------------------------------------------
1453 -- |-----------------------------< update_attribute >-------------------------|
1454 -- ----------------------------------------------------------------------------
1455 --
1456 -- {Start Of Comments}
1457 /*#
1458 * Allows a Time Attribute to be updated, using the Time Attribute SQL Type
1459 * Nested Table.
1460 *
1461 * Note that this procedure does not manipulate any of the database table
1462 * contents. Only the PL/SQL nested table parameters passed into this procedure
1463 * will be modified. The execute_deposit_process API will need to be used to
1464 * actually update the database.
1465 *
1466 * <p><b>Licensing</b><br>
1467 * This API version is licensed for use with Time and Labor.
1468 *
1469 * <p><b>Prerequisites</b><br>
1470 * The Time Attribute being updated should already exist.
1471 *
1472 * <p><b>Post Success</b><br>
1473 * Time Attribute is updated.
1474 *
1475 * <p><b>Post Failure</b><br>
1476 * Time Attribute is not updated.
1477 *
1478 * @param p_time_attribute_id Identifies the Time Attribute to modify.
1479 * @param p_attribute_name Name of the attribute.
1480 * @param p_attribute_value Value of the attribute.
1481 * @param p_deposit_process Deposit process indicates which attribute to
1482 * application mapping should be used to retrieve the Timecard attributes.
1483 * @param p_app_blocks Pass in the Time Building Block SQL Type Nested Table.
1484 * This procedure does not update the table.
1485 * @param p_app_attributes Pass in the Attribute PL/SQL Nested Table containing
1486 * the attribute to be updated. On success, the Time Attribute updated will be
1487 * updated in this PL/SQL Nested Table.
1488 * @rep:displayname Update Time Attribute
1489 * @rep:category BUSINESS_ENTITY HXC_TIMECARD
1490 * @rep:lifecycle active
1491 * @rep:primaryinstance
1492 * @rep:scope public
1493 * @rep:metalink 223987.1 OTL HXC TimeStore Deposit
1494 */
1495 --
1496 -- {End Of Comments}
1497 --
1498 PROCEDURE update_attribute (
1499 p_time_attribute_id IN hxc_time_attributes.time_attribute_id%TYPE,
1500 p_attribute_name IN hxc_mapping_components.field_name%TYPE,
1501 p_attribute_value IN hxc_time_attributes.attribute1%TYPE
1502 DEFAULT hr_api.g_varchar2,
1503 -- p_category IN hxc_bld_blk_info_type_usages.building_block_category%TYPE,
1504 -- p_time_recipient_id IN NUMBER,
1505 p_deposit_process IN hxc_deposit_processes.NAME%TYPE
1506 DEFAULT g_otl_deposit_process,
1507 p_app_blocks IN OUT NOCOPY hxc_block_table_type,
1508 p_app_attributes IN OUT NOCOPY hxc_self_service_time_deposit.app_attributes_info
1509 );
1510
1511 --
1512 -- ----------------------------------------------------------------------------
1513 -- |-----------------------------< update_attribute >-------------------------|
1514 -- ----------------------------------------------------------------------------
1515 --
1516 -- {Start Of Comments}
1517 /*#
1518 * Allows a Time Attribute to be updated, using the Time Attribute PL/SQL Type
1519 * Nested Table.
1520 *
1521 * Note that this procedure does not manipulate any of the database table
1522 * contents. Only the PL/SQL nested table parameters passed into this procedure
1523 * will be modified. The execute_deposit_process API will need to be used to
1524 * actually update the database.
1525 *
1526 * <p><b>Licensing</b><br>
1527 * This API version is licensed for use with Time and Labor.
1528 *
1529 * <p><b>Prerequisites</b><br>
1530 * The Time Attribute being updated should already exist.
1531 *
1532 * <p><b>Post Success</b><br>
1533 * Time Attribute is updated.
1534 *
1535 * <p><b>Post Failure</b><br>
1536 * Time Attribute is not updated.
1537 *
1538 * @param p_time_attribute_id Identifies the Time Attribute to modify.
1539 * @param p_attribute_name Name of the attribute.
1540 * @param p_attribute_value Value of the attribute.
1541 * @param p_deposit_process Deposit process indicates which attribute to
1542 * application mapping should be used to retrieve the Timecard attributes.
1543 * @param p_app_blocks Pass in the Time Building Block PL/SQL Type Nested
1544 * Table. This procedure will not update the table.
1545 * @param p_app_attributes Pass in the Attribute PL/SQL Nested Table containing
1546 * the attribute to update. On success, the Time Attribute updated will be in
1547 * this PL/SQL Nested Table.
1548 * @rep:displayname Update Time Attribute
1549 * @rep:category BUSINESS_ENTITY HXC_TIMECARD
1550 * @rep:lifecycle active
1551 * @rep:scope public
1552 * @rep:metalink 223987.1 OTL HXC TimeStore Deposit
1553 */
1554 --
1555 -- {End Of Comments}
1556 --
1557 PROCEDURE update_attribute (
1558 p_time_attribute_id IN hxc_time_attributes.time_attribute_id%TYPE,
1559 p_attribute_name IN hxc_mapping_components.field_name%TYPE,
1560 p_attribute_value IN hxc_time_attributes.attribute1%TYPE
1561 DEFAULT hr_api.g_varchar2,
1562 -- p_category IN hxc_bld_blk_info_type_usages.building_block_category%TYPE,
1563 -- p_time_recipient_id IN NUMBER,
1564 p_deposit_process IN hxc_deposit_processes.NAME%TYPE
1565 DEFAULT g_otl_deposit_process,
1566 p_app_blocks IN OUT NOCOPY hxc_self_service_time_deposit.timecard_info,
1567 p_app_attributes IN OUT NOCOPY hxc_self_service_time_deposit.app_attributes_info
1568 );
1569
1570 --
1571 -- ----------------------------------------------------------------------------
1572 -- |-----------------------------< delete_detail_bb >-------------------------|
1573 -- ----------------------------------------------------------------------------
1574 --
1575 -- {Start Of Comments}
1576 /*#
1577 * Allows a Detail Time Building Block to be deleted, using the Time Building
1578 * Block SQL Type Nested Table.
1579 *
1580 * Note that this procedure does not manipulate any of the database table
1581 * contents. Only the PL/SQL nested table parameters passed into this procedure
1582 * will be modified. The execute_deposit_process API will need to be used to
1583 * actually update the database.
1584 *
1585 * <p><b>Licensing</b><br>
1586 * This API version is licensed for use with Time and Labor.
1587 *
1588 * <p><b>Prerequisites</b><br>
1589 * None
1590 *
1591 * <p><b>Post Success</b><br>
1592 * The Time Building Block is deleted from the Timecard.
1593 *
1594 * <p><b>Post Failure</b><br>
1595 * The Time Building Block is not deleted from the Timecard.
1596 *
1597 * @param p_building_block_id Identifies the Time Building Block to delete.
1598 * @param p_deposit_process Deposit process indicates which attribute to
1599 * application mapping should be used to retrieve the Timecard attributes.
1600 * @param p_effective_date Date at which the delete becomes effective, the
1601 * default value is recommended for most scenarios.
1602 * @param p_app_blocks Pass in the Time Building Block SQL Type Nested Table to
1603 * attach the Time Entry to. On success, the Time Building Block deleted will
1604 * be removed from this SQL Type Nested Table.
1605 * @param p_app_attributes Pass in the Time Attribute PL/SQL Type Nested Table
1606 * containing the Time Building Blocks attributes which have already been
1607 * created. This procedure will not modify the table contents.
1608 * @rep:displayname Delete Detail Time Building Block
1609 * @rep:category BUSINESS_ENTITY HXC_TIMECARD
1610 * @rep:lifecycle active
1611 * @rep:primaryinstance
1612 * @rep:scope public
1613 * @rep:metalink 223987.1 OTL HXC TimeStore Deposit
1614 */
1615 --
1616 -- {End Of Comments}
1617 --
1618 PROCEDURE delete_detail_bb (
1619 p_building_block_id IN hxc_time_building_blocks.time_building_block_id%TYPE,
1620 -- p_time_recipient_id IN NUMBER,
1621 p_deposit_process IN hxc_deposit_processes.NAME%TYPE
1622 DEFAULT g_otl_deposit_process,
1623 p_effective_date IN hxc_time_building_blocks.stop_time%TYPE
1624 DEFAULT SYSDATE,
1625 p_app_blocks IN OUT NOCOPY hxc_block_table_type,
1626 p_app_attributes IN OUT NOCOPY hxc_self_service_time_deposit.app_attributes_info
1627 );
1628
1629 --
1630 -- ----------------------------------------------------------------------------
1631 -- |-----------------------------< delete_detail_bb >-------------------------|
1632 -- ----------------------------------------------------------------------------
1633 --
1634 -- {Start Of Comments}
1635 /*#
1636 * Allows a Detail Time Building Block to be deleted, using the Time Building
1637 * Block PL/SQL Type Nested Table.
1638 *
1639 * Note that this procedure does not manipulate any of the database table
1640 * contents. Only the PL/SQL nested table parameters passed into this procedure
1641 * will be modified. The execute_deposit_process API will need to be used to
1642 * actually update the database.
1643 *
1644 * <p><b>Licensing</b><br>
1645 * This API version is licensed for use with Time and Labor.
1646 *
1647 * <p><b>Prerequisites</b><br>
1648 * None
1649 *
1650 * <p><b>Post Success</b><br>
1651 * The Time Building Block is deleted from the Timecard.
1652 *
1653 * <p><b>Post Failure</b><br>
1654 * The Time Building Block is not deleted from the Timecard.
1655 *
1656 * @param p_building_block_id Identifies the Time Building Block to delete.
1657 * @param p_deposit_process Deposit process indicates which attribute to
1658 * application mapping should be used to retrieve the Timecard attributes.
1659 * @param p_effective_date Date at which the delete becomes effective, the
1660 * default value is recommended for most scenarios.
1661 * @param p_app_blocks Pass in the Time Building Block PL/SQL Type Nested Table
1662 * to attach the Time Entry to. On success, the Time Building Block deleted
1663 * will be removed from this PL/SQL Type Nested Table.
1664 * @param p_app_attributes Pass in the Time Attribute PL/SQL Type Nested Table
1665 * containing the Time Building Blocks attributes which have already been
1666 * created. This procedure will not modify the table contents.
1667 * @rep:displayname Delete Detail Time Building Block
1668 * @rep:category BUSINESS_ENTITY HXC_TIMECARD
1669 * @rep:lifecycle active
1670 * @rep:scope public
1671 * @rep:metalink 223987.1 OTL HXC TimeStore Deposit
1672 */
1673 --
1674 -- {End Of Comments}
1675 --
1676 PROCEDURE delete_detail_bb (
1677 p_building_block_id IN hxc_time_building_blocks.time_building_block_id%TYPE,
1678 -- p_time_recipient_id IN NUMBER,
1679 p_deposit_process IN hxc_deposit_processes.NAME%TYPE
1680 DEFAULT g_otl_deposit_process,
1681 p_effective_date IN hxc_time_building_blocks.stop_time%TYPE
1682 DEFAULT SYSDATE,
1683 p_app_blocks IN OUT NOCOPY hxc_self_service_time_deposit.timecard_info,
1684 p_app_attributes IN OUT NOCOPY hxc_self_service_time_deposit.app_attributes_info
1685 );
1686
1687 --
1688 -- ----------------------------------------------------------------------------
1689 -- |-----------------------------< delete_timecard >--------------------------|
1690 -- ----------------------------------------------------------------------------
1691 --
1692 -- {Start Of Comments}
1693 /*#
1694 * Deletes the entire Timecard.
1695 *
1696 *
1697 * <p><b>Licensing</b><br>
1698 * This API is licensed for use with Time and Labor.
1699 *
1700 * <p><b>Prerequisites</b><br>
1701 * None
1702 *
1703 * <p><b>Post Success</b><br>
1704 * Timecard is deleted.
1705 *
1706 * <p><b>Post Failure</b><br>
1707 * Timecard is not deleted.
1708 *
1709 * @param p_building_block_id Identifies the Timecard to deleted.
1710 * @param p_mode Delete mode, the default value is recommended for most
1711 * scenarios.
1712 * @param p_deposit_process Obsolete parameter, do not use.
1713 * @param p_retrieval_process Obsolete parameter, do not use.
1714 * @param p_effective_date Date at which the delete becomes effective, the
1715 * default value is recommended for most scenarios.
1716 * @param p_template Set to 'Y' if deleting a template, else use 'N'
1717 * (=Default).
1718 * @rep:displayname Delete Timecard
1719 * @rep:category BUSINESS_ENTITY HXC_TIMECARD
1720 * @rep:lifecycle active
1721 * @rep:scope public
1722 * @rep:metalink 223987.1 OTL HXC TimeStore Deposit
1723 */
1724 --
1725 -- {End Of Comments}
1726 --
1727 PROCEDURE delete_timecard (
1728 p_building_block_id IN hxc_time_building_blocks.time_building_block_id%TYPE,
1729 p_mode IN VARCHAR2 DEFAULT hxc_timecard.c_delete,
1730 p_deposit_process IN hxc_deposit_processes.NAME%TYPE
1731 DEFAULT g_otl_deposit_process,
1732 p_retrieval_process IN VARCHAR2 DEFAULT NULL,
1733 p_effective_date IN hxc_time_building_blocks.stop_time%TYPE
1734 DEFAULT SYSDATE,
1735 p_template IN VARCHAR2 DEFAULT hxc_timecard.c_no
1736 );
1737
1738 --
1739 -- ----------------------------------------------------------------------------
1740 -- |-------------------------< execute_deposit_process >----------------------|
1741 -- ----------------------------------------------------------------------------
1742 --
1743 -- {Start Of Comments}
1744 /*#
1745 * Deposits the Timecard in the TimeStore, using the Timecard SQL Type Nested
1746 * Table.
1747 *
1748 *
1749 * <p><b>Licensing</b><br>
1750 * This API version is licensed for use with Time and Labor.
1751 *
1752 * <p><b>Prerequisites</b><br>
1753 * None
1754 *
1755 * <p><b>Post Success</b><br>
1756 * The Timecard will be deposited into the TimeStore.
1757 *
1758 * <p><b>Post Failure</b><br>
1759 * The Timecard will not be deposited in the TimeStore, error messages will be
1760 * logged in the message table out parameter.
1761 *
1762 * @param p_validate If true, then validation alone will be performed and the
1763 * database will remain unchanged. If false and all validation checks pass,
1764 * then the database will be modified.
1765 * @param p_mode Mode must be set to 'SUBMIT', 'SAVE', 'MIGRATION',
1766 * 'FORCE_SAVE' or 'FORCE_SUBMIT'.
1767 * @param p_deposit_process Process to be used for deposit.
1768 * @param p_retrieval_process Process to be used for retrieval, only use if
1769 * mode = 'MIGRATION'.
1770 * @param p_app_attributes Attributes to deposit.
1771 * @param p_app_blocks Time Building Blocks to deposit.
1772 * @param p_messages Contains all the messages raised during the execution of
1773 * this procedure.
1774 * @param p_timecard_id Uniquely identifies the created Timecard.
1775 * @param p_timecard_ovn Set to the object version number of the created
1776 * Timecard.
1777 * @param p_template Set to 'Y' if creating a template, else set to 'N'
1778 * (default).
1779 * @param p_item_type Workflow item type which contains the timecard approval
1780 * process, the default value is recommended for most scenarios.
1781 * @param p_approval_prc Workflow process name that corresponds to the timecard
1782 * approval process, the default value is recommended for most scenarios.
1783 * @param p_process_terminated_employees Flag that can be used to indicate
1784 * whether you are also trying to upload timecard for terminated employees.
1785 * @param p_approve_term_emps_on_submit Flag that can be used to indicate
1786 * whether you want to approve the timecards of terminated employees when
1787 * submitting. This parameter is ignored when p_process_terminated_employees is
1788 * FALSE.
1789 * @rep:displayname Execute Deposit Process
1790 * @rep:category BUSINESS_ENTITY HXC_TIMECARD
1791 * @rep:lifecycle active
1792 * @rep:primaryinstance
1793 * @rep:scope public
1794 * @rep:metalink 223987.1 OTL HXC TimeStore Deposit
1795 */
1796 --
1797 -- {End Of Comments}
1798 --
1799 PROCEDURE execute_deposit_process (
1800 p_validate IN BOOLEAN DEFAULT FALSE,
1801 p_mode IN VARCHAR2,
1802 p_deposit_process IN VARCHAR2,
1803 p_retrieval_process IN VARCHAR2 DEFAULT NULL,
1804 -- p_add_security IN BOOLEAN DEFAULT TRUE,
1805 p_app_attributes IN OUT NOCOPY hxc_self_service_time_deposit.app_attributes_info,
1806 p_app_blocks IN OUT NOCOPY hxc_block_table_type,
1807 -- hxc_self_service_time_deposit.timecard_info,
1808 p_messages OUT NOCOPY hxc_message_table_type,
1809 -- hxc_self_service_time_deposit.message_table,
1810 p_timecard_id OUT NOCOPY hxc_time_building_blocks.time_building_block_id%TYPE,
1811 p_timecard_ovn OUT NOCOPY hxc_time_building_blocks.object_version_number%TYPE,
1812 p_template IN VARCHAR2
1813 DEFAULT hxc_timecard.c_no,
1814 p_item_type IN wf_items.item_type%TYPE
1815 DEFAULT 'HXCEMP',
1816 p_approval_prc IN wf_process_activities.process_name%TYPE
1817 DEFAULT 'HXC_APPROVAL',
1818 p_process_terminated_employees IN BOOLEAN DEFAULT FALSE,
1819 p_approve_term_emps_on_submit IN BOOLEAN DEFAULT FALSE
1820 );
1821
1822 --
1823 -- ----------------------------------------------------------------------------
1824 -- |-------------------------< execute_deposit_process >----------------------|
1825 -- ----------------------------------------------------------------------------
1826 --
1827 -- {Start Of Comments}
1828 /*#
1829 * Allow a Timecard to be deposited in the TimeStore, using the Timecard PL/SQL
1830 * Type Nested Table.
1831 *
1832 *
1833 * <p><b>Licensing</b><br>
1834 * This API version is licensed for use with Time and Labor.
1835 *
1836 * <p><b>Prerequisites</b><br>
1837 * None
1838 *
1839 * <p><b>Post Success</b><br>
1840 * The Timecard will be deposited into the TimeStore.
1841 *
1842 * <p><b>Post Failure</b><br>
1843 * The Timecard will not be deposited into the TimeStore, error messages will
1844 * be logged in the message table out parameter.
1845 *
1846 * @param p_validate If true, then validation alone will be performed and the
1847 * database will remain unchanged. If false and all validation checks pass,
1848 * then the database will be modified.
1849 * @param p_mode Mode must be set to 'SUBMIT', 'SAVE', 'MIGRATION',
1850 * 'FORCE_SAVE' or 'FORCE_SUBMIT'.
1851 * @param p_deposit_process Process to be used for deposit.
1852 * @param p_retrieval_process Process to be used for retrieval, only use if
1853 * mode = 'MIGRATION'.
1854 * @param p_app_attributes Attributes to deposit.
1855 * @param p_app_blocks Time Building Blocks to deposit.
1856 * @param p_messages Contains all the messages raised during the execution of
1857 * this procedure.
1858 * @param p_timecard_id Uniquely identifies the created Timecard.
1859 * @param p_timecard_ovn Set to the object version number of the created
1860 * Timecard.
1861 * @param p_template Set to 'Y' if creating a template, else set to 'N'
1862 * (default).
1863 * @param p_item_type Workflow item type which contains the timecard approval
1864 * process, the default value is recommended for most scenarios.
1865 * @param p_approval_prc Workflow process name that corresponds to the timecard
1866 * approval process, the default value is recommended for most scenarios.
1867 * @param p_process_terminated_employees Flag that can be used to indicate
1868 * whether you are also trying to upload timecard for terminated employees.
1869 * @param p_approve_term_emps_on_submit Flag that can be used to indicate
1870 * whether you want to approve the timecards of terminated employees when
1871 * submitting. This parameter is ignored when p_process_terminated_employees is
1872 * FALSE.
1873 * @rep:displayname Execute Deposit Process
1874 * @rep:category BUSINESS_ENTITY HXC_TIMECARD
1875 * @rep:lifecycle active
1876 * @rep:scope public
1877 * @rep:metalink 223987.1 OTL HXC TimeStore Deposit
1878 */
1879 --
1880 -- {End Of Comments}
1881 --
1882 PROCEDURE execute_deposit_process (
1883 p_validate IN BOOLEAN DEFAULT FALSE,
1884 p_mode IN VARCHAR2,
1885 p_deposit_process IN VARCHAR2,
1886 p_retrieval_process IN VARCHAR2 DEFAULT NULL,
1887 -- p_add_security IN BOOLEAN DEFAULT TRUE,
1888 p_app_attributes IN OUT NOCOPY hxc_self_service_time_deposit.app_attributes_info,
1889 p_app_blocks IN OUT NOCOPY hxc_self_service_time_deposit.timecard_info,
1890 p_messages OUT NOCOPY hxc_self_service_time_deposit.message_table,
1891 p_timecard_id OUT NOCOPY hxc_time_building_blocks.time_building_block_id%TYPE,
1892 p_timecard_ovn OUT NOCOPY hxc_time_building_blocks.object_version_number%TYPE,
1893 p_template IN VARCHAR2
1894 DEFAULT hxc_timecard.c_no,
1895 p_item_type IN wf_items.item_type%TYPE
1896 DEFAULT 'HXCEMP',
1897 p_approval_prc IN wf_process_activities.process_name%TYPE
1898 DEFAULT 'HXC_APPROVAL',
1899 p_process_terminated_employees IN BOOLEAN DEFAULT FALSE,
1900 p_approve_term_emps_on_submit IN BOOLEAN DEFAULT FALSE
1901 );
1902
1903 --
1904 -- ----------------------------------------------------------------------------
1905 -- |------------------------< clear_building_block_table >--------------------|
1906 -- ----------------------------------------------------------------------------
1907 --
1908 -- {Start Of Comments}
1909 /*#
1910 * Clears the Time Building Block SQL Type Nested Table.
1911 *
1912 * Note that this procedure does not manipulate any of the database table
1913 * contents. Only the PL/SQL nested table parameters passed into this procedure
1914 * will be cleared.
1915 *
1916 * <p><b>Licensing</b><br>
1917 * This API is licensed for use with Time and Labor.
1918 *
1919 * <p><b>Prerequisites</b><br>
1920 * None
1921 *
1922 * <p><b>Post Success</b><br>
1923 * The Nested Table is cleared.
1924 *
1925 * <p><b>Post Failure</b><br>
1926 * The Nested Table is not cleared.
1927 *
1928 * @param p_app_blocks Timecard SQL Type Nested Table to be cleared.
1929 * @rep:displayname Clear Time Building Block Table
1930 * @rep:category BUSINESS_ENTITY HXC_TIMECARD
1931 * @rep:lifecycle active
1932 * @rep:scope public
1933 * @rep:metalink 223987.1 OTL HXC TimeStore Deposit
1934 */
1935 --
1936 -- {End Of Comments}
1937 --
1938 PROCEDURE clear_building_block_table (
1939 p_app_blocks IN OUT NOCOPY hxc_block_table_type
1940 );
1941
1942 --
1943 -- ----------------------------------------------------------------------------
1944 -- |--------------------------< clear_attribute_table >-----------------------|
1945 -- ----------------------------------------------------------------------------
1946 --
1947 -- {Start Of Comments}
1948 /*#
1949 * Clears a Time Attribute PL/SQL Type Nested Table.
1950 *
1951 * Note that this procedure does not manipulate any of the database table
1952 * contents. Only the PL/SQL nested table parameters passed into this procedure
1953 * will be cleared.
1954 *
1955 * <p><b>Licensing</b><br>
1956 * This API is licensed for use with Time and Labor.
1957 *
1958 * <p><b>Prerequisites</b><br>
1959 * None
1960 *
1961 * <p><b>Post Success</b><br>
1962 * The Nested Table is cleared.
1963 *
1964 * <p><b>Post Failure</b><br>
1965 * The Nested Table is not cleared.
1966 *
1967 * @param p_app_attributes Time Atrribute PL/SQL Table to be cleared.
1968 * @rep:displayname Clear Time Attribute Table
1969 * @rep:category BUSINESS_ENTITY HXC_TIMECARD
1970 * @rep:lifecycle active
1971 * @rep:scope public
1972 * @rep:metalink 223987.1 OTL HXC TimeStore Deposit
1973 */
1974 --
1975 -- {End Of Comments}
1976 --
1977 PROCEDURE clear_attribute_table (
1978 p_app_attributes IN OUT NOCOPY hxc_self_service_time_deposit.app_attributes_info
1979 );
1980
1981 --
1982 -- ----------------------------------------------------------------------------
1983 -- |---------------------------< clear_message_table >------------------------|
1984 -- ----------------------------------------------------------------------------
1985 --
1986 -- {Start Of Comments}
1987 /*#
1988 * Clears a Message PL/SQL Type Nested Table.
1989 *
1990 * Note that this procedure does not manipulate any of the database table
1991 * contents. Only the PL/SQL nested table parameters passed into this procedure
1992 * will be cleared.
1993 *
1994 * <p><b>Licensing</b><br>
1995 * This API is licensed for use with Time and Labor.
1996 *
1997 * <p><b>Prerequisites</b><br>
1998 * None
1999 *
2000 * <p><b>Post Success</b><br>
2001 * The Nested Table is cleared.
2002 *
2003 * <p><b>Post Failure</b><br>
2004 * The Nested Table is not cleared.
2005 *
2006 * @param p_messages Message PL/SQL Table to be cleared.
2007 * @rep:displayname Clear Message Table
2008 * @rep:category BUSINESS_ENTITY HXC_TIMECARD
2009 * @rep:lifecycle active
2010 * @rep:scope public
2011 * @rep:metalink 223987.1 OTL HXC TimeStore Deposit
2012 */
2013 --
2014 -- {End Of Comments}
2015 --
2016 PROCEDURE clear_message_table (
2017 p_messages IN OUT NOCOPY hxc_message_table_type
2018 );
2019
2020 --
2021 -- ----------------------------------------------------------------------------
2022 -- |-------------------------------< log_timecard >---------------------------|
2023 -- ----------------------------------------------------------------------------
2024 --
2025 -- {Start Of Comments}
2026 /*#
2027 * A debug helper procedure for logging a Timecard SQL Type Nested Table.
2028 *
2029 * Use this procedure when you need to verify the content of the Timecard SQL
2030 * Type Nested Table and the corresponding Timecard Attributes.When you use
2031 * this procedure it will write the content of the passed in Timecard and
2032 * Attributes into the fnd_log_messages table.
2033 *
2034 * <p><b>Licensing</b><br>
2035 * This API version is licensed for use with Time and Labor.
2036 *
2037 * <p><b>Prerequisites</b><br>
2038 * None
2039 *
2040 * <p><b>Post Success</b><br>
2041 * The Timecard will be logged.
2042 *
2043 * <p><b>Post Failure</b><br>
2044 * The Timecard will not be logged.
2045 *
2046 * @param p_app_blocks Timecard SQL Type Nested Table to log.
2047 * @param p_app_attributes Corresponding Time Attributes to log.
2048 * @rep:displayname Log Timecard
2049 * @rep:category BUSINESS_ENTITY HXC_TIMECARD
2050 * @rep:lifecycle active
2051 * @rep:primaryinstance
2052 * @rep:scope public
2053 * @rep:metalink 223987.1 OTL HXC TimeStore Deposit
2054 */
2055 --
2056 -- {End Of Comments}
2057 --
2058 PROCEDURE log_timecard (
2059 p_app_blocks IN hxc_block_table_type,
2060 p_app_attributes IN hxc_self_service_time_deposit.app_attributes_info
2061 );
2062
2063 --
2064 -- ----------------------------------------------------------------------------
2065 -- |-------------------------------< log_timecard >---------------------------|
2066 -- ----------------------------------------------------------------------------
2067 --
2068 -- {Start Of Comments}
2069 /*#
2070 * A debug helper procedure for logging a Timecard PL/SQL Type Nested Table.
2071 *
2072 * Use this procedure when you need to verify the content of the Timecard
2073 * PL/SQL Type Nested Table and the corresponding Timecard Attributes.When you
2074 * use this procedure it will write the content of the passed in Timecard and
2075 * Attributes into the fnd_log_messages table.
2076 *
2077 * <p><b>Licensing</b><br>
2078 * This API version is licensed for use with Time and Labor.
2079 *
2080 * <p><b>Prerequisites</b><br>
2081 * None
2082 *
2083 * <p><b>Post Success</b><br>
2084 * The Timecard will be logged.
2085 *
2086 * <p><b>Post Failure</b><br>
2087 * The Timecard will not be logged.
2088 *
2089 * @param p_app_blocks Timecard PL/SQL Type Nested Table to log.
2090 * @param p_app_attributes Corresponding Time Attributes to log.
2091 * @rep:displayname Log Timecard
2092 * @rep:category BUSINESS_ENTITY HXC_TIMECARD
2093 * @rep:lifecycle active
2094 * @rep:scope public
2095 * @rep:metalink 223987.1 OTL HXC TimeStore Deposit
2096 */
2097 --
2098 -- {End Of Comments}
2099 --
2100 PROCEDURE log_timecard (
2101 p_app_blocks IN hxc_self_service_time_deposit.timecard_info,
2102 p_app_attributes IN hxc_self_service_time_deposit.app_attributes_info
2103 );
2104
2105 --
2106 -- ----------------------------------------------------------------------------
2107 -- |-------------------------------< log_messages >---------------------------|
2108 -- ----------------------------------------------------------------------------
2109 --
2110 -- {Start Of Comments}
2111 /*#
2112 * A debug helper procedure for logging a Message SQL Type Nested Table.
2113 *
2114 * Use this procedure when you need to verify the content of the Message SQL
2115 * Type Nested Table. When you use this procedure it will write the content of
2116 * the passed in Message SQL Type Nested Table into the fnd_log_messages table.
2117 *
2118 * <p><b>Licensing</b><br>
2119 * This API version is licensed for use with Time and Labor.
2120 *
2121 * <p><b>Prerequisites</b><br>
2122 * None
2123 *
2124 * <p><b>Post Success</b><br>
2125 * The Messages will be logged.
2126 *
2127 * <p><b>Post Failure</b><br>
2128 * The Messages will not be logged.
2129 *
2130 * @param p_messages Message SQL Type Nested Table to log.
2131 * @rep:displayname Log Messages
2132 * @rep:category BUSINESS_ENTITY HXC_TIMECARD
2133 * @rep:lifecycle active
2134 * @rep:primaryinstance
2135 * @rep:scope public
2136 * @rep:metalink 223987.1 OTL HXC TimeStore Deposit
2137 */
2138 --
2139 -- {End Of Comments}
2140 --
2141 PROCEDURE log_messages (p_messages IN hxc_message_table_type);
2142
2143 --
2144 -- ----------------------------------------------------------------------------
2145 -- |-------------------------------< log_messages >---------------------------|
2146 -- ----------------------------------------------------------------------------
2147 --
2148 -- {Start Of Comments}
2149 /*#
2150 * A debug helper procedure for logging a Message PL/SQL Type Nested Table.
2151 *
2152 * Use this procedure when you need to verify the content of the Message PL/SQL
2153 * Type Nested Table. When you use this procedure it will write the content of
2154 * the passed in Message PL/SQL Type Nested Table into the fnd_log_messages
2155 * table.
2156 *
2157 * <p><b>Licensing</b><br>
2158 * This API version is licensed for use with Time and Labor.
2159 *
2160 * <p><b>Prerequisites</b><br>
2161 * None
2162 *
2163 * <p><b>Post Success</b><br>
2164 * The Messages will be logged.
2165 *
2166 * <p><b>Post Failure</b><br>
2167 * The Messages will not be logged.
2168 *
2169 * @param p_messages Message PL/SQL Type Nested Table to log.
2170 * @rep:displayname Log Messages
2171 * @rep:category BUSINESS_ENTITY HXC_TIMECARD
2172 * @rep:lifecycle active
2173 * @rep:scope public
2174 * @rep:metalink 223987.1 OTL HXC TimeStore Deposit
2175 */
2176 --
2177 -- {End Of Comments}
2178 --
2179 PROCEDURE log_messages (
2180 p_messages IN hxc_self_service_time_deposit.message_table
2181 );
2182 END hxc_timestore_deposit;
[Home] [Help]