1 Package ame_rlu_shd as
2 /* $Header: amrlurhi.pkh 120.0 2005/09/02 04:02 mbocutt noship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- | Global Record Type Specification |
6 -- ----------------------------------------------------------------------------
7 --
8 Type g_rec_type Is Record
9 (item_id number
10 ,usage_type varchar2(9) -- Increased length
11 ,rule_id number
12 ,start_date date
13 ,end_date date
14 ,security_group_id number(15)
15 ,priority number(38)
16 ,approver_category varchar2(9) -- Increased length
17 ,object_version_number number(9)
18 ,old_start_date date
19 );
20 --
21 -- ----------------------------------------------------------------------------
22 -- | Global Definitions - Internal Development Use Only |
23 -- ----------------------------------------------------------------------------
24 --
25 g_old_rec g_rec_type; -- Global record definition
26 -- Global table name
27 g_tab_nam constant varchar2(30) := 'AME_RULE_USAGES';
28 --
29 -- ----------------------------------------------------------------------------
30 -- |---------------------------< constraint_error >---------------------------|
31 -- ----------------------------------------------------------------------------
32 -- {Start Of Comments}
33 --
34 -- Description:
35 -- This procedure is called when a constraint has been violated (i.e.
36 -- The exception hr_api.check_integrity_violated,
37 -- hr_api.parent_integrity_violated, hr_api.child_integrity_violated or
38 -- hr_api.unique_integrity_violated has been raised).
39 -- The exceptions can only be raised as follows:
40 -- 1) A check constraint can only be violated during an INSERT or UPDATE
41 -- dml operation.
42 -- 2) A parent integrity constraint can only be violated during an
43 -- INSERT or UPDATE dml operation.
44 -- 3) A child integrity constraint can only be violated during an
45 -- DELETE dml operation.
46 -- 4) A unique integrity constraint can only be violated during INSERT or
47 -- UPDATE dml operation.
48 --
49 -- Prerequisites:
50 -- 1) Either hr_api.check_integrity_violated,
51 -- hr_api.parent_integrity_violated, hr_api.child_integrity_violated or
52 -- hr_api.unique_integrity_violated has been raised with the subsequent
53 -- stripping of the constraint name from the generated error message
54 -- text.
55 -- 2) Standalone validation test which corresponds with a constraint error.
56 --
57 -- In Parameter:
58 -- p_constraint_name is in upper format and is just the constraint name
59 -- (e.g. not prefixed by brackets, schema owner etc).
60 --
61 -- Post Success:
62 -- Development dependant.
63 --
64 -- Post Failure:
65 -- Developement dependant.
66 --
67 -- Developer Implementation Notes:
68 -- For each constraint being checked the hr system package failure message
69 -- has been generated as a template only. These system error messages should
70 -- be modified as required (i.e. change the system failure message to a user
71 -- friendly defined error message).
72 --
73 -- Access Status:
74 -- Internal Development Use Only.
75 --
76 -- {End Of Comments}
77 -- ----------------------------------------------------------------------------
78 Procedure constraint_error
79 (p_constraint_name in all_constraints.constraint_name%TYPE);
80 --
81 -- ----------------------------------------------------------------------------
82 -- |-----------------------------< api_updating >-----------------------------|
83 -- ----------------------------------------------------------------------------
84 -- {Start Of Comments}
85 --
86 -- Description:
87 -- This function is used to populate the g_old_rec record with the
88 -- current row from the database for the specified primary key
89 -- provided that the primary key exists and is valid and does not
90 -- already match the current g_old_rec. The function will always return
91 -- a TRUE value if the g_old_rec is populated with the current row.
92 -- A FALSE value will be returned if all of the primary key arguments
93 -- are null.
94 --
95 -- Prerequisites:
96 -- None.
97 --
98 -- In Parameters:
99 --
100 -- Post Success:
101 -- A value of TRUE will be returned indiciating that the g_old_rec
102 -- is current.
103 -- A value of FALSE will be returned if all of the primary key arguments
104 -- have a null value (this indicates that the row has not be inserted into
105 -- the Schema), and therefore could never have a corresponding row.
106 --
107 -- Post Failure:
108 -- A failure can only occur under two circumstances:
109 -- 1) The primary key is invalid (i.e. a row does not exist for the
110 -- specified primary key values).
111 -- 2) If an object_version_number exists but is NOT the same as the current
112 -- g_old_rec value.
113 --
114 -- Developer Implementation Notes:
115 -- None.
116 --
117 -- Access Status:
118 -- Internal Development Use Only.
119 --
120 -- {End Of Comments}
121 -- ----------------------------------------------------------------------------
122 Function api_updating
123 (p_effective_date in date
124 ,p_item_id in number
125 ,p_rule_id in number
126 ,p_object_version_number in number
127 ) Return Boolean;
128 --
129 -- ----------------------------------------------------------------------------
130 -- |----------------------------< upd_end_date >------------------------------|
131 -- ----------------------------------------------------------------------------
132 -- {Start Of Comments}
133 --
134 -- Description:
135 -- This procedure will update the specified datetrack row with the
136 -- specified new effective end date. The object version number is also
137 -- set to the next object version number. DateTrack modes which call
138 -- this procedure are: UPDATE, UPDATE_CHANGE_INSERT,
139 -- UPDATE_OVERRIDE, DELETE, FUTURE_CHANGE and DELETE_NEXT_CHANGE.
140 -- This is an internal datetrack maintenance procedure which should
141 -- not be modified in anyway.
142 --
143 -- Prerequisites:
144 -- None.
145 --
146 -- In Parameters:
147 -- p_new_effective_end_date
148 -- Specifies the new effective end date which will be set for the
149 -- row as of the effective date.
150 -- p_base_key_value
151 -- Specifies the primary key value for this datetrack entity.
152 -- (E.g. For this entity the assignment of the argument would be:
153 -- p_base_key_value = :rule_id).
154 --
155 -- Post Success:
156 -- The specified row will be updated with the new effective end date and
157 -- object_version_number.
158 --
159 -- Post Failure:
160 -- Failure might occur if for the specified effective date and primary key
161 -- value a row doesn't exist.
162 --
163 -- Developer Implementation Notes:
164 -- This is an internal datetrack maintenance procedure which should
165 -- not be modified in anyway.
166 --
167 -- Access Status:
168 -- Internal Row Handler Use Only.
169 --
170 -- {End Of Comments}
171 -- ----------------------------------------------------------------------------
172 Procedure upd_end_date
173 (p_effective_date in date
174 ,p_item_id in number
175 ,p_rule_id in number
176 ,p_old_start_date in date
177 ,p_new_end_date in date
178 ,p_object_version_number out nocopy number
179 );
180 --
181 -- ----------------------------------------------------------------------------
182 -- |---------------------------------< lck >----------------------------------|
183 -- ----------------------------------------------------------------------------
184 -- {Start Of Comments}
185 --
186 -- Description:
187 -- The Lck process for datetrack is complicated and comprises of the
188 -- following processing
189 -- The processing steps are as follows:
190 -- 1) The row to be updated or deleted must be locked.
191 -- By locking this row, the g_old_rec record data type is populated.
192 -- 2) If a comment exists the text is selected from hr_comments.
193 -- 3) The datetrack mode is then validated to ensure the operation is
194 -- valid. If the mode is valid the validation start and end dates for
195 -- the mode will be derived and returned. Any required locking is
196 -- completed when the datetrack mode is validated.
197 --
198 -- Prerequisites:
199 -- When attempting to call the lck procedure the object version number,
200 -- primary key, effective date and datetrack mode must be specified.
201 --
202 -- In Parameters:
203 -- p_effective_date
204 -- Specifies the date of the datetrack update operation.
205 -- p_datetrack_mode
206 -- Determines the datetrack update or delete mode.
207 --
208 -- Post Success:
209 -- On successful completion of the Lck process the row to be updated or
210 -- deleted will be locked and selected into the global data structure
211 -- g_old_rec.
212 --
213 -- Post Failure:
214 -- The Lck process can fail for three reasons:
215 -- 1) When attempting to lock the row the row could already be locked by
216 -- another user. This will raise the HR_Api.Object_Locked exception.
217 -- 2) The row which is required to be locked doesn't exist in the HR Schema.
218 -- This error is trapped and reported using the message name
219 -- 'HR_7220_INVALID_PRIMARY_KEY'.
220 -- 3) The row although existing in the HR Schema has a different object
221 -- version number than the object version number specified.
222 -- This error is trapped and reported using the message name
223 -- 'HR_7155_OBJECT_INVALID'.
224 --
225 -- Developer Implementation Notes:
226 -- None.
227 --
228 -- Access Status:
229 -- Internal Development Use Only.
230 --
231 -- {End Of Comments}
232 -- ----------------------------------------------------------------------------
233 Procedure lck
234 (p_effective_date in date
235 ,p_datetrack_mode in varchar2
236 ,p_item_id in number
237 ,p_rule_id in number
238 ,p_old_start_date in date
239 ,p_object_version_number in number
240 ,p_validation_start_date out nocopy date
241 ,p_validation_end_date out nocopy date
242 );
243 --
244 -- ----------------------------------------------------------------------------
245 -- |-----------------------------< convert_args >-----------------------------|
246 -- ----------------------------------------------------------------------------
247 -- {Start Of Comments}
248 --
249 -- Description:
250 -- This function is used to turn attribute parameters into the record
251 -- structure parameter g_rec_type.
252 --
253 -- Prerequisites:
254 -- This is a private function and can only be called from the ins or upd
255 -- attribute processes.
256 --
257 -- In Parameters:
258 --
259 -- Post Success:
260 -- A returning record structure will be returned.
261 --
262 -- Post Failure:
263 -- No direct error handling is required within this function. Any possible
264 -- errors within this function will be a PL/SQL value error due to
265 -- conversion of datatypes or data lengths.
269 --
266 --
267 -- Developer Implementation Notes:
268 -- None.
270 -- Access Status:
271 -- Internal Row Handler Use Only.
272 --
273 -- {End Of Comments}
274 -- ----------------------------------------------------------------------------
275 Function convert_args
276 (p_item_id in number
277 ,p_usage_type in varchar2
278 ,p_rule_id in number
279 ,p_start_date in date
280 ,p_end_date in date
281 ,p_security_group_id in number
282 ,p_priority in number
283 ,p_approver_category in varchar2
284 ,p_object_version_number in number
285 ,p_old_start_date in date
286 )
287 Return g_rec_type;
288 --
289 -- ----------------------------------------------------------------------------
290 -- |-----------------------------< get_object_version_number >----------------|
291 -- ----------------------------------------------------------------------------
292 -- {Start Of Comments}
293 --
294 -- Description:
295 -- This function is used to get the next object version number to be used
296 -- within datetrack for an insert or update dml operation. The returned
297 -- object version number will be determined by taking the maximum
298 -- object version number for the datetracked rows and then incrementing by 1.
299 --
300 --
301 -- Prerequisites:
302 -- This is a private function and can only be called from the ins or upd
303 -- attribute processes.
304 --
305 -- In Parameters:
306 --
307 --
308 -- Post Success:
309 --
310 --
311 -- Post Failure:
312 --
313 --
314 --
315 --
316 -- Developer Implementation Notes:
317 -- None.
318 --
319 -- Access Status:
320 -- Internal Row Handler Use Only.
321 --
322 -- {End Of Comments}
323 -- ----------------------------------------------------------------------------
324 Function get_object_version_number
325 (p_item_id in number
326 ,p_rule_id in number
327 ,p_old_start_date in date
328 )
329 Return number;
330 --
331 --
332 end ame_rlu_shd;