1 Package ben_eiv_shd as
2 /* $Header: beeivrhi.pkh 120.0 2005/05/28 02:16:44 appldev noship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- | Global Record Type Specification |
6 -- ----------------------------------------------------------------------------
7 --
8 Type g_rec_type Is Record
9 (extra_input_value_id number(15)
10 ,acty_base_rt_id number(15)
11 ,input_value_id number(15)
12 ,input_text varchar2(240)
13 ,upd_when_ele_ended_cd varchar2(30)
14 ,return_var_name varchar2(240)
15 ,business_group_id number(15)
16 ,eiv_attribute_category varchar2(30)
17 ,eiv_attribute1 varchar2(150)
18 ,eiv_attribute2 varchar2(150)
19 ,eiv_attribute3 varchar2(150)
20 ,eiv_attribute4 varchar2(150)
21 ,eiv_attribute5 varchar2(150)
22 ,eiv_attribute6 varchar2(150)
23 ,eiv_attribute7 varchar2(150)
24 ,eiv_attribute8 varchar2(150)
25 ,eiv_attribute9 varchar2(150)
26 ,eiv_attribute10 varchar2(150)
27 ,eiv_attribute11 varchar2(150)
28 ,eiv_attribute12 varchar2(150)
29 ,eiv_attribute13 varchar2(150)
30 ,eiv_attribute14 varchar2(150)
31 ,eiv_attribute15 varchar2(150)
32 ,eiv_attribute16 varchar2(150)
33 ,eiv_attribute17 varchar2(150)
34 ,eiv_attribute18 varchar2(150)
35 ,eiv_attribute19 varchar2(150)
36 ,eiv_attribute20 varchar2(150)
37 ,eiv_attribute21 varchar2(150)
38 ,eiv_attribute22 varchar2(150)
39 ,eiv_attribute23 varchar2(150)
40 ,eiv_attribute24 varchar2(150)
41 ,eiv_attribute25 varchar2(150)
42 ,eiv_attribute26 varchar2(150)
43 ,eiv_attribute27 varchar2(150)
44 ,eiv_attribute28 varchar2(150)
45 ,eiv_attribute29 varchar2(150)
46 ,eiv_attribute30 varchar2(150)
47 ,object_version_number number(9)
48 );
49 --
50 -- ----------------------------------------------------------------------------
51 -- | Global Definitions - Internal Development Use Only |
52 -- ----------------------------------------------------------------------------
53 --
54 g_old_rec g_rec_type; -- Global record definition
55 -- Global table name
56 g_tab_nam constant varchar2(30) := 'BEN_EXTRA_INPUT_VALUES';
57 g_api_dml boolean; -- Global api dml status
58 --
59 -- ----------------------------------------------------------------------------
60 -- |------------------------< return_api_dml_status >-------------------------|
61 -- ----------------------------------------------------------------------------
62 -- {Start Of Comments}
63 --
64 -- Description:
65 -- This function will return the current g_api_dml private global
66 -- boolean status.
67 -- The g_api_dml status determines if at the time of the function
68 -- being executed if a dml statement (i.e. INSERT, UPDATE or DELETE)
69 -- is being issued from within an api.
70 -- If the status is TRUE then a dml statement is being issued from
71 -- within this entity api.
72 -- This function is primarily to support database triggers which
73 -- need to maintain the object_version_number for non-supported
74 -- dml statements (i.e. dml statement issued outside of the api layer).
75 --
76 -- Prerequisites:
77 -- None.
78 --
79 -- In Parameters:
80 -- None.
81 --
82 -- Post Success:
83 -- Processing continues.
84 -- If the function returns a TRUE value then, dml is being executed from
85 -- within this api.
86 --
87 -- Post Failure:
88 -- None.
89 --
90 -- Access Status:
91 -- Internal Row Handler Use Only.
92 --
93 -- {End Of Comments}
94 -- ----------------------------------------------------------------------------
95 Function return_api_dml_status Return Boolean;
96 --
97 -- ----------------------------------------------------------------------------
98 -- |---------------------------< constraint_error >---------------------------|
99 -- ----------------------------------------------------------------------------
100 -- {Start Of Comments}
101 --
102 -- Description:
103 -- This procedure is called when a constraint has been violated (i.e.
104 -- The exception hr_api.check_integrity_violated,
105 -- hr_api.parent_integrity_violated, hr_api.child_integrity_violated or
106 -- hr_api.unique_integrity_violated has been raised).
107 -- The exceptions can only be raised as follows:
108 -- 1) A check constraint can only be violated during an INSERT or UPDATE
109 -- dml operation.
110 -- 2) A parent integrity constraint can only be violated during an
111 -- INSERT or UPDATE dml operation.
112 -- 3) A child integrity constraint can only be violated during an
113 -- DELETE dml operation.
114 -- 4) A unique integrity constraint can only be violated during INSERT or
115 -- UPDATE dml operation.
116 --
117 -- Prerequisites:
118 -- 1) Either hr_api.check_integrity_violated,
119 -- hr_api.parent_integrity_violated, hr_api.child_integrity_violated or
120 -- hr_api.unique_integrity_violated has been raised with the subsequent
121 -- stripping of the constraint name from the generated error message
122 -- text.
123 -- 2) Standalone validation test which corresponds with a constraint error.
124 --
125 -- In Parameter:
126 -- p_constraint_name is in upper format and is just the constraint name
127 -- (e.g. not prefixed by brackets, schema owner etc).
128 --
129 -- Post Success:
130 -- Development dependant.
131 --
132 -- Post Failure:
133 -- Developement dependant.
134 --
135 -- Developer Implementation Notes:
136 -- For each constraint being checked the hr system package failure message
137 -- has been generated as a template only. These system error messages should
138 -- be modified as required (i.e. change the system failure message to a user
139 -- friendly defined error message).
140 --
141 -- Access Status:
142 -- Internal Development Use Only.
143 --
144 -- {End Of Comments}
145 -- ----------------------------------------------------------------------------
146 Procedure constraint_error
147 (p_constraint_name in all_constraints.constraint_name%TYPE);
148 --
149 -- ----------------------------------------------------------------------------
150 -- |-----------------------------< api_updating >-----------------------------|
151 -- ----------------------------------------------------------------------------
152 -- {Start Of Comments}
153 --
154 -- Description:
155 -- This function is used to populate the g_old_rec record with the
156 -- current row from the database for the specified primary key
157 -- provided that the primary key exists and is valid and does not
158 -- already match the current g_old_rec. The function will always return
159 -- a TRUE value if the g_old_rec is populated with the current row.
160 -- A FALSE value will be returned if all of the primary key arguments
161 -- are null.
162 --
163 -- Prerequisites:
164 -- None.
165 --
166 -- In Parameters:
167 --
168 -- Post Success:
169 -- A value of TRUE will be returned indiciating that the g_old_rec
170 -- is current.
171 -- A value of FALSE will be returned if all of the primary key arguments
172 -- have a null value (this indicates that the row has not be inserted into
173 -- the Schema), and therefore could never have a corresponding row.
174 --
175 -- Post Failure:
176 -- A failure can only occur under two circumstances:
177 -- 1) The primary key is invalid (i.e. a row does not exist for the
178 -- specified primary key values).
179 -- 2) If an object_version_number exists but is NOT the same as the current
180 -- g_old_rec value.
181 --
182 -- Developer Implementation Notes:
183 -- None.
184 --
185 -- Access Status:
186 -- Internal Development Use Only.
187 --
188 -- {End Of Comments}
189 -- ----------------------------------------------------------------------------
190 Function api_updating
191 (p_extra_input_value_id in number
192 ,p_object_version_number in number
193 ) Return Boolean;
194 --
195 -- ----------------------------------------------------------------------------
196 -- |---------------------------------< lck >----------------------------------|
197 -- ----------------------------------------------------------------------------
198 -- {Start of comments}
199 --
200 -- Description:
201 -- The Lck process has two main functions to perform. Firstly, the row to be
202 -- updated or deleted must be locked. The locking of the row will only be
203 -- successful if the row is not currently locked by another user.
204 -- Secondly, during the locking of the row, the row is selected into
205 -- the g_old_rec data structure which enables the current row values from
206 -- the server to be available to the api.
207 --
208 -- Prerequisites:
209 -- When attempting to call the lock the object version number (if defined)
210 -- is mandatory.
211 --
212 -- In Parameters:
213 -- The arguments to the Lck process are the primary key(s) which uniquely
214 -- identify the row and the object version number of row.
215 --
216 -- Post Success:
217 -- On successful completion of the Lck process the row to be updated or
218 -- deleted will be locked and selected into the global data structure
219 -- g_old_rec.
220 --
221 -- Post Failure:
222 -- The Lck process can fail for three reasons:
223 -- 1) When attempting to lock the row the row could already be locked by
224 -- another user. This will raise the HR_Api.Object_Locked exception.
225 -- 2) The row which is required to be locked doesn't exist in the HR Schema.
226 -- This error is trapped and reported using the message name
227 -- 'HR_7220_INVALID_PRIMARY_KEY'.
228 -- 3) The row although existing in the HR Schema has a different object
229 -- version number than the object version number specified.
230 -- This error is trapped and reported using the message name
231 -- 'HR_7155_OBJECT_INVALID'.
232 --
233 -- Developer Implementation Notes:
234 -- For each primary key and the object version number arguments add a
235 -- call to hr_api.mandatory_arg_error procedure to ensure that these
236 -- argument values are not null.
237 --
238 -- Access Status:
239 -- Internal Development Use Only.
240 --
241 -- {End of comments}
242 -- ----------------------------------------------------------------------------
243 Procedure lck
244 (p_extra_input_value_id in number
245 ,p_object_version_number in number
246 );
247 --
248 -- ----------------------------------------------------------------------------
249 -- |-----------------------------< convert_args >-----------------------------|
250 -- ----------------------------------------------------------------------------
251 -- {Start Of Comments}
252 --
253 -- Description:
254 -- This function is used to turn attribute parameters into the record
255 -- structure parameter g_rec_type.
256 --
257 -- Prerequisites:
258 -- This is a private function and can only be called from the ins or upd
259 -- attribute processes.
260 --
261 -- In Parameters:
262 --
263 -- Post Success:
264 -- A returning record structure will be returned.
265 --
266 -- Post Failure:
267 -- No direct error handling is required within this function. Any possible
268 -- errors within this function will be a PL/SQL value error due to
269 -- conversion of datatypes or data lengths.
270 --
271 -- Developer Implementation Notes:
272 -- None.
273 --
274 -- Access Status:
275 -- Internal Row Handler Use Only.
276 --
277 -- {End Of Comments}
278 -- ----------------------------------------------------------------------------
279 Function convert_args
280 (p_extra_input_value_id in number
281 ,p_acty_base_rt_id in number
282 ,p_input_value_id in number
283 ,p_input_text in varchar2
284 ,p_upd_when_ele_ended_cd in varchar2
285 ,p_return_var_name in varchar2
286 ,p_business_group_id in number
287 ,p_eiv_attribute_category in varchar2
288 ,p_eiv_attribute1 in varchar2
289 ,p_eiv_attribute2 in varchar2
290 ,p_eiv_attribute3 in varchar2
291 ,p_eiv_attribute4 in varchar2
292 ,p_eiv_attribute5 in varchar2
293 ,p_eiv_attribute6 in varchar2
294 ,p_eiv_attribute7 in varchar2
295 ,p_eiv_attribute8 in varchar2
296 ,p_eiv_attribute9 in varchar2
297 ,p_eiv_attribute10 in varchar2
298 ,p_eiv_attribute11 in varchar2
299 ,p_eiv_attribute12 in varchar2
300 ,p_eiv_attribute13 in varchar2
301 ,p_eiv_attribute14 in varchar2
302 ,p_eiv_attribute15 in varchar2
303 ,p_eiv_attribute16 in varchar2
304 ,p_eiv_attribute17 in varchar2
305 ,p_eiv_attribute18 in varchar2
306 ,p_eiv_attribute19 in varchar2
307 ,p_eiv_attribute20 in varchar2
308 ,p_eiv_attribute21 in varchar2
309 ,p_eiv_attribute22 in varchar2
310 ,p_eiv_attribute23 in varchar2
311 ,p_eiv_attribute24 in varchar2
312 ,p_eiv_attribute25 in varchar2
313 ,p_eiv_attribute26 in varchar2
314 ,p_eiv_attribute27 in varchar2
315 ,p_eiv_attribute28 in varchar2
316 ,p_eiv_attribute29 in varchar2
317 ,p_eiv_attribute30 in varchar2
318 ,p_object_version_number in number
319 )
320 Return g_rec_type;
321 --
322 end ben_eiv_shd;
[Home] [Help]