1 Package ben_ctk_shd AUTHID CURRENT_USER as
2 /* $Header: bectkrhi.pkh 120.0 2005/05/28 01:25:32 appldev noship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- | Global Record Type Specification |
6 -- ----------------------------------------------------------------------------
7 --
8 Type g_rec_type Is Record
9 (group_per_in_ler_id number(15)
10 ,task_id number(15)
11 ,group_pl_id number(15)
12 ,lf_evt_ocrd_dt date
13 ,status_cd varchar2(30)
14 ,access_cd varchar2(30)
15 ,task_last_update_date date
16 ,task_last_update_by number(15)
17 ,object_version_number number(9)
18 );
19 --
20 -- ----------------------------------------------------------------------------
21 -- | Global Definitions - Internal Development Use Only |
22 -- ----------------------------------------------------------------------------
23 --
24 g_old_rec g_rec_type; -- Global record definition
25 -- Global table name
26 g_tab_nam constant varchar2(30) := 'BEN_CWB_PERSON_TASKS';
27 g_api_dml boolean; -- Global api dml status
28 --
29 -- ----------------------------------------------------------------------------
30 -- |------------------------< return_api_dml_status >-------------------------|
31 -- ----------------------------------------------------------------------------
32 -- {Start Of Comments}
33 --
34 -- Description:
35 -- This function will return the current g_api_dml private global
36 -- boolean status.
37 -- The g_api_dml status determines if at the time of the function
38 -- being executed if a dml statement (i.e. INSERT, UPDATE or DELETE)
39 -- is being issued from within an api.
40 -- If the status is TRUE then a dml statement is being issued from
41 -- within this entity api.
42 -- This function is primarily to support database triggers which
43 -- need to maintain the object_version_number for non-supported
44 -- dml statements (i.e. dml statement issued outside of the api layer).
45 --
46 -- Prerequisites:
47 -- None.
48 --
49 -- In Parameters:
50 -- None.
51 --
52 -- Post Success:
53 -- Processing continues.
54 -- If the function returns a TRUE value then, dml is being executed from
55 -- within this api.
56 --
57 -- Post Failure:
58 -- None.
59 --
60 -- Access Status:
61 -- Internal Row Handler Use Only.
62 --
63 -- {End Of Comments}
64 -- ----------------------------------------------------------------------------
65 Function return_api_dml_status Return Boolean;
66 --
67 -- ----------------------------------------------------------------------------
68 -- |---------------------------< constraint_error >---------------------------|
69 -- ----------------------------------------------------------------------------
70 -- {Start Of Comments}
71 --
72 -- Description:
73 -- This procedure is called when a constraint has been violated (i.e.
74 -- The exception hr_api.check_integrity_violated,
75 -- hr_api.parent_integrity_violated, hr_api.child_integrity_violated or
76 -- hr_api.unique_integrity_violated has been raised).
77 -- The exceptions can only be raised as follows:
78 -- 1) A check constraint can only be violated during an INSERT or UPDATE
79 -- dml operation.
80 -- 2) A parent integrity constraint can only be violated during an
81 -- INSERT or UPDATE dml operation.
82 -- 3) A child integrity constraint can only be violated during an
83 -- DELETE dml operation.
84 -- 4) A unique integrity constraint can only be violated during INSERT or
85 -- UPDATE dml operation.
86 --
87 -- Prerequisites:
88 -- 1) Either hr_api.check_integrity_violated,
89 -- hr_api.parent_integrity_violated, hr_api.child_integrity_violated or
90 -- hr_api.unique_integrity_violated has been raised with the subsequent
91 -- stripping of the constraint name from the generated error message
92 -- text.
93 -- 2) Standalone validation test which corresponds with a constraint error.
94 --
95 -- In Parameter:
96 -- p_constraint_name is in upper format and is just the constraint name
97 -- (e.g. not prefixed by brackets, schema owner etc).
98 --
99 -- Post Success:
100 -- Development dependant.
101 --
102 -- Post Failure:
103 -- Developement dependant.
104 --
105 -- Developer Implementation Notes:
106 -- For each constraint being checked the hr system package failure message
107 -- has been generated as a template only. These system error messages should
108 -- be modified as required (i.e. change the system failure message to a user
109 -- friendly defined error message).
110 --
111 -- Access Status:
112 -- Internal Development Use Only.
113 --
114 -- {End Of Comments}
115 -- ----------------------------------------------------------------------------
116 Procedure constraint_error
117 (p_constraint_name in all_constraints.constraint_name%TYPE);
118 --
119 -- ----------------------------------------------------------------------------
120 -- |-----------------------------< api_updating >-----------------------------|
121 -- ----------------------------------------------------------------------------
122 -- {Start Of Comments}
123 --
124 -- Description:
125 -- This function is used to populate the g_old_rec record with the
126 -- current row from the database for the specified primary key
127 -- provided that the primary key exists and is valid and does not
128 -- already match the current g_old_rec. The function will always return
129 -- a TRUE value if the g_old_rec is populated with the current row.
130 -- A FALSE value will be returned if all of the primary key arguments
131 -- are null.
132 --
133 -- Prerequisites:
134 -- None.
135 --
136 -- In Parameters:
137 --
138 -- Post Success:
139 -- A value of TRUE will be returned indiciating that the g_old_rec
140 -- is current.
141 -- A value of FALSE will be returned if all of the primary key arguments
142 -- have a null value (this indicates that the row has not be inserted into
143 -- the Schema), and therefore could never have a corresponding row.
144 --
145 -- Post Failure:
146 -- A failure can only occur under two circumstances:
147 -- 1) The primary key is invalid (i.e. a row does not exist for the
148 -- specified primary key values).
149 -- 2) If an object_version_number exists but is NOT the same as the current
150 -- g_old_rec value.
151 --
152 -- Developer Implementation Notes:
153 -- None.
154 --
155 -- Access Status:
156 -- Internal Development Use Only.
157 --
158 -- {End Of Comments}
159 -- ----------------------------------------------------------------------------
160 Function api_updating
161 (p_group_per_in_ler_id in number
162 ,p_task_id in number
163 ,p_object_version_number in number
164 ) Return Boolean;
165 --
166 -- ----------------------------------------------------------------------------
167 -- |---------------------------------< lck >----------------------------------|
168 -- ----------------------------------------------------------------------------
169 -- {Start of comments}
170 --
171 -- Description:
172 -- The Lck process has two main functions to perform. Firstly, the row to be
173 -- updated or deleted must be locked. The locking of the row will only be
174 -- successful if the row is not currently locked by another user.
175 -- Secondly, during the locking of the row, the row is selected into
176 -- the g_old_rec data structure which enables the current row values from
177 -- the server to be available to the api.
178 --
179 -- Prerequisites:
180 -- When attempting to call the lock the object version number (if defined)
181 -- is mandatory.
182 --
183 -- In Parameters:
184 -- The arguments to the Lck process are the primary key(s) which uniquely
185 -- identify the row and the object version number of row.
186 --
187 -- Post Success:
188 -- On successful completion of the Lck process the row to be updated or
189 -- deleted will be locked and selected into the global data structure
190 -- g_old_rec.
191 --
192 -- Post Failure:
193 -- The Lck process can fail for three reasons:
194 -- 1) When attempting to lock the row the row could already be locked by
195 -- another user. This will raise the HR_Api.Object_Locked exception.
196 -- 2) The row which is required to be locked doesn't exist in the HR Schema.
197 -- This error is trapped and reported using the message name
198 -- 'HR_7220_INVALID_PRIMARY_KEY'.
199 -- 3) The row although existing in the HR Schema has a different object
200 -- version number than the object version number specified.
201 -- This error is trapped and reported using the message name
202 -- 'HR_7155_OBJECT_INVALID'.
203 --
204 -- Developer Implementation Notes:
205 -- For each primary key and the object version number arguments add a
206 -- call to hr_api.mandatory_arg_error procedure to ensure that these
207 -- argument values are not null.
208 --
209 -- Access Status:
210 -- Internal Development Use Only.
211 --
212 -- {End of comments}
213 -- ----------------------------------------------------------------------------
214 Procedure lck
215 (p_group_per_in_ler_id in number
216 ,p_task_id in number
217 ,p_object_version_number in number
218 );
219 --
220 -- ----------------------------------------------------------------------------
221 -- |-----------------------------< convert_args >-----------------------------|
222 -- ----------------------------------------------------------------------------
223 -- {Start Of Comments}
224 --
225 -- Description:
226 -- This function is used to turn attribute parameters into the record
227 -- structure parameter g_rec_type.
228 --
229 -- Prerequisites:
230 -- This is a private function and can only be called from the ins or upd
231 -- attribute processes.
232 --
233 -- In Parameters:
234 --
235 -- Post Success:
236 -- A returning record structure will be returned.
237 --
238 -- Post Failure:
239 -- No direct error handling is required within this function. Any possible
240 -- errors within this function will be a PL/SQL value error due to
241 -- conversion of datatypes or data lengths.
242 --
243 -- Developer Implementation Notes:
244 -- None.
245 --
246 -- Access Status:
247 -- Internal Row Handler Use Only.
248 --
249 -- {End Of Comments}
250 -- ----------------------------------------------------------------------------
251 Function convert_args
252 (p_group_per_in_ler_id in number
253 ,p_task_id in number
254 ,p_group_pl_id in number
255 ,p_lf_evt_ocrd_dt in date
256 ,p_status_cd in varchar2
257 ,p_access_cd in varchar2
258 ,p_task_last_update_date in date
259 ,p_task_last_update_by in number
260 ,p_object_version_number in number
261 )
262 Return g_rec_type;
263 --
264 end ben_ctk_shd;
[Home] [Help]