1 PACKAGE hxc_self_service_timecard_api AUTHID CURRENT_USER AS
2 /* $Header: hxctcmapi.pkh 115.8 2002/11/27 20:05:24 jdupont noship $ */
3
4 --
5 -- ----------------------------------------------------------------------------
6 -- |------------------------< execute_deposit_process >-----------------------|
7 -- ----------------------------------------------------------------------------
8 --
9 -- Description: Allows the user to enter timecards into the OTL time store
10 -- The user must have an understanding of the TIMECARD_INFO and
11 -- ATTRIBUTE_INFO PL/SQL data structures
12 --
13 -- It is suggested that the timecard deposit be called once per
14 -- timecard.
15 --
16 -- Timecards can be deposited, deleted or migrated (see P_MODE
17 -- for further details).
18 --
19 --
20 -- Prerequisites: OTL
21 --
22 --
23 -- In Parameters:
24 -- Name Reqd Type Description
25 --
26 -- p_validate No boolean Validation mode switch
27 --
28 -- p_app_blocks Yes HXC_SELF_SERVICE_TIME_DEPOSIT.TIMECARD_INFO
29 -- PL/SQL Table of time bld blk info
30 -- The time_building_block_id, parent
31 -- building_block_id and object_version
32 -- number columns must be set appropriately
33 -- and the NEW flag set to 'Y'
34 --
35 -- p_app_attributes HXC_SELF_SERVICE_TIME_DEPOSIT.APP_ATTRIBUTES_INFO
36 -- PL/SQL table of time attributes.
37 -- The time_attribute_id and time_building_
38 -- block_id must also be set appropriately.
39 --
40 -- p_mode Yes varchar2 Controls what happens to the timecards.
41 --
42 -- 'MIGRATION' - timecards are deposited
43 -- as 'Approved' and as though they have
44 -- been retrieved by the retrieval process
45 -- specified in the paramter of the same name.
46 --
47 -- 'DELETE' - deletes the timecard.
48 -- NOTE: the date_to for all bld blks must be
49 -- set to a date other than 31-DEC-4712
50 --
51 -- 'SUBMIT' - fires all validation (time entry
52 -- rules, recipient application, OTL ), creates
53 -- the timecard and initiates approval process.
54 -- In other words the same as submitting the
55 -- timecard through self service.
56 --
57 -- 'WORKING' - creates the timecard with status
58 -- of working.
59 -- In other words the same as saving the
60 -- timecard for later through self service.
61 --
62 -- p_deposit_process Yes varchar2 The name of the recipient application
63 -- deposit process
64 --
65 -- p_retrieval_process Yes varchar2 The name of the recipient application
66 -- retrieval process
67 --
68 -- Post Success:
69 -- Name Reqd Type Description
70 --
71 -- p_app_blocks Yes HXC_SELF_SERVICE_TIME_DEPOSIT.TIMECARD_INFO
72 --
73 -- On successful deposit of the timecard
74 -- the actual values of time_building_block_id,
75 -- parent_time_building_block_id and object_
76 -- version_number will be set.
77 -- NOTE: the corresponding attribute table
78 -- values are not available
79 --
80 -- p_messages Yes HXC_SELF_SERVICE_TIME_DEPOSIT.MESSAGE_TABLE
81 --
82 -- PL/SQL table containing any application messages
83 -- which were raised during deposit
84 --
85 -- p_timecard_id Yes HXC_TIME_BUILDING_BLOCKS.TIME_BUILDING_BLOCK_ID%TYPE
86 --
87 -- The time_building_block_id of the 'TIMECARD'
88 -- scope time building block
89 --
90 -- p_timecard_ovn Yes HXC_TIME_BUILDING_BLOCKS.OBJECT_VERSION_NUMBER%TYPE
91 --
92 -- The object_version_number of the 'TIMECARD'
93 -- scope time building block
94 -- Post Failure:
95 -- Messages will be written to the p_messages table for interogation post
96 -- failure.
97 --
98 -- Access Status:
99 -- Public.
100 --
101
102 procedure execute_deposit_process --AI9
103 (p_validate in boolean default FALSE
104 ,p_app_blocks in out NOCOPY HXC_SELF_SERVICE_TIME_DEPOSIT.TIMECARD_INFO
105 ,p_app_attributes in HXC_SELF_SERVICE_TIME_DEPOSIT.APP_ATTRIBUTES_INFO
106 ,p_messages out nocopy Hxc_Self_Service_Time_Deposit.Message_Table
107 ,p_mode varchar2
108 ,p_deposit_process varchar2
109 ,p_retrieval_process varchar2 default null
110 ,p_timecard_id out nocopy HXC_TIME_BUILDING_BLOCKS.TIME_BUILDING_BLOCK_ID%TYPE
111 ,p_timecard_ovn out nocopy HXC_TIME_BUILDING_BLOCKS.OBJECT_VERSION_NUMBER%TYPE
112 );
113
114 procedure timecard_pump
115 (p_validate in boolean default FALSE
116 ,p_app_blocks in out NOCOPY HXC_SELF_SERVICE_TIME_DEPOSIT.TIMECARD_INFO
117 ,p_app_attributes in HXC_SELF_SERVICE_TIME_DEPOSIT.APP_ATTRIBUTES_INFO
118 ,p_messages out nocopy Hxc_Self_Service_Time_Deposit.Message_Table
119 ,p_mode in varchar2
120 ,p_deposit_process varchar2
121 ,p_retrieval_process varchar2 default null
122 ,p_timecard_id out nocopy HXC_TIME_BUILDING_BLOCKS.TIME_BUILDING_BLOCK_ID%TYPE
123 ,p_timecard_ovn out nocopy HXC_TIME_BUILDING_BLOCKS.OBJECT_VERSION_NUMBER%TYPE
124 );
125
126 END hxc_self_service_timecard_api;
[Home] [Help]