DBA Data[Home] [Help]

PACKAGE: APPS.HXC_LOCK_API

Source


1 PACKAGE HXC_LOCK_API AUTHID CURRENT_USER AS
2 /* $Header: hxclockapi.pkh 115.1 2003/08/14 17:31:23 jdupont noship $ */
3 
4 -- ----------------------------------------------------------------------------
5 -- |---------------------------< request_lock          > ----------------------|
6 -- ----------------------------------------------------------------------------
7 PROCEDURE request_lock
8          (p_process_locker_type        	IN VARCHAR2
9          ,p_resource_id			IN NUMBER DEFAULT NULL
10          ,p_start_time			IN DATE DEFAULT NULL
11          ,p_stop_time 			IN DATE DEFAULT NULL
12          ,p_time_building_block_id 	IN NUMBER
13          ,p_time_building_block_ovn 	IN NUMBER
14          ,p_transaction_lock_id		IN NUMBER DEFAULT NULL
15          ,p_expiration_time		IN NUMBER DEFAULT hxc_lock_util.c_ss_expiration_time
16          ,p_messages			IN OUT NOCOPY HXC_MESSAGE_TABLE_TYPE
17          ,p_row_lock_id			IN OUT NOCOPY ROWID
18          ,p_locked_success		OUT NOCOPY BOOLEAN
19          );
20 
21 -- ----------------------------------------------------------------------------
22 -- |---------------------------< request_lock          > ----------------------|
23 -- ----------------------------------------------------------------------------
24 -- this request lock is going to be used in SS
25 -- locked success is in varchar.
26 PROCEDURE request_lock
27          (p_process_locker_type        	IN VARCHAR2
28          ,p_resource_id			IN NUMBER DEFAULT NULL
29          ,p_start_time			IN DATE DEFAULT NULL
30          ,p_stop_time 			IN DATE DEFAULT NULL
31          ,p_time_building_block_id 	IN NUMBER
32          ,p_time_building_block_ovn 	IN NUMBER
33          ,p_transaction_lock_id		IN NUMBER DEFAULT NULL
34          ,p_expiration_time		IN NUMBER DEFAULT hxc_lock_util.c_ss_expiration_time
35          ,p_messages			IN OUT NOCOPY HXC_MESSAGE_TABLE_TYPE
36          ,p_row_lock_id			IN OUT NOCOPY ROWID
37          ,p_locked_success		OUT NOCOPY VARCHAR2
38          );
39 
40 -- ----------------------------------------------------------------------------
41 -- |---------------------------< request_lock          > ----------------------|
42 -- ----------------------------------------------------------------------------
43 -- this request lock is going to be used in timekeeper
44 -- forms since we cannot passed the HXC_MESSAGE_TABLE_TYPE
45 -- as a type
46 PROCEDURE request_lock
47          (p_process_locker_type        	IN VARCHAR2
48          ,p_resource_id			IN NUMBER DEFAULT NULL
49          ,p_start_time			IN DATE DEFAULT NULL
50          ,p_stop_time 			IN DATE DEFAULT NULL
51          ,p_time_building_block_id 	IN NUMBER
52          ,p_time_building_block_ovn 	IN NUMBER
53          ,p_transaction_lock_id		IN NUMBER DEFAULT NULL
54          ,p_expiration_time		IN NUMBER DEFAULT hxc_lock_util.c_ss_expiration_time
55          ,p_messages			IN OUT NOCOPY hxc_self_service_time_deposit.message_table
56          ,p_row_lock_id			IN OUT NOCOPY ROWID
57          ,p_locked_success		OUT NOCOPY BOOLEAN
58          );
59 
60 -- ----------------------------------------------------------------------------
61 -- |---------------------------< check_lock          > ----------------------|
62 -- ----------------------------------------------------------------------------
63 -- if p_row_id is not null then
64 -- the message table will be populated
65 PROCEDURE check_lock
66          (p_process_locker_type        	IN VARCHAR2
67          ,p_resource_id			IN OUT NOCOPY NUMBER
68          ,p_start_time			IN OUT NOCOPY DATE
69          ,p_stop_time 			IN OUT NOCOPY DATE
70          ,p_time_building_block_id 	IN NUMBER
71          ,p_time_building_block_ovn 	IN NUMBER
72          ,p_messages			IN OUT NOCOPY HXC_MESSAGE_TABLE_TYPE
73          ,p_timecard_locked		OUT NOCOPY BOOLEAN
74          ,p_time_building_block_scope   OUT NOCOPY VARCHAR2
75          ,p_process_locker_type_id      OUT NOCOPY NUMBER
76          );
77 
78 -- ----------------------------------------------------------------------------
79 -- |---------------------------< check_lock          > ----------------------|
80 -- ----------------------------------------------------------------------------
81 FUNCTION check_lock (p_row_lock_id	IN ROWID)
82 	 RETURN BOOLEAN;
83 
84 
85 -- ----------------------------------------------------------------------------
86 -- |---------------------------< check_lock          > ----------------------|
87 -- ----------------------------------------------------------------------------
88 FUNCTION check_lock
89          (p_process_locker_type        	IN VARCHAR2
90          ,p_transaction_lock_id         IN NUMBER
91          ,p_resource_id			IN NUMBER)
92          RETURN ROWID;
93 -- ----------------------------------------------------------------------------
94 -- |---------------------------< check_lock          > ----------------------|
95 -- ----------------------------------------------------------------------------
96 FUNCTION check_lock
97          (p_row_lock_id			IN ROWID
98          ,p_resource_id			IN NUMBER
99          ,p_start_time			IN DATE
100          ,p_stop_time 			IN DATE)
101          RETURN BOOLEAN;
102 -- ----------------------------------------------------------------------------
103 -- |---------------------------< release_lock          > ----------------------|
104 -- ----------------------------------------------------------------------------
105 PROCEDURE release_lock
106          (p_row_lock_id			IN ROWID
107          ,p_process_locker_type        	IN VARCHAR2
108          ,p_transaction_lock_id         IN NUMBER DEFAULT NULL
109          ,p_released_success		OUT NOCOPY BOOLEAN
110         );
111 
112 -- ----------------------------------------------------------------------------
113 -- |---------------------------< release_lock          > ----------------------|
114 -- ----------------------------------------------------------------------------
115 PROCEDURE release_lock
116          (p_row_lock_id			IN ROWID);
117 
118 
119 -- ----------------------------------------------------------------------------
120 -- |---------------------------< release_lock          > ----------------------|
121 -- ----------------------------------------------------------------------------
122 PROCEDURE release_lock
123          (p_row_lock_id			IN ROWID
124          ,p_process_locker_type        	IN VARCHAR2
125          ,p_transaction_lock_id         IN NUMBER DEFAULT NULL
126          ,p_resource_id			IN NUMBER DEFAULT NULL
127          ,p_start_time			IN DATE DEFAULT NULL
128          ,p_stop_time 			IN DATE DEFAULT NULL
129          ,p_time_building_block_id 	IN NUMBER DEFAULT NULL
130          ,p_time_building_block_ovn 	IN NUMBER DEFAULT NULL
131          ,p_messages			IN OUT NOCOPY HXC_MESSAGE_TABLE_TYPE
132          ,p_released_success		OUT NOCOPY BOOLEAN
133         );
134 
135 
136 END HXC_LOCK_API;