1 Package ame_aty_shd as
2 /* $Header: amatyrhi.pkh 120.0 2005/09/02 03:52 mbocutt noship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- | Global Record Type Specification |
6 -- ----------------------------------------------------------------------------
7 --
8 Type g_rec_type Is Record
9 (action_type_id number
10 ,name varchar2(50)
11 ,procedure_name varchar2(50)
12 ,start_date date
13 ,end_date date
14 ,description varchar2(100)
15 ,security_group_id number(15)
16 ,dynamic_description varchar2(9) -- Increased length
17 ,description_query varchar2(4000)
18 ,object_version_number number(9)
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_ACTION_TYPES';
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_action_type_id in number
125 ,p_object_version_number in number
126 ) Return Boolean;
127 --
128 -- ----------------------------------------------------------------------------
129 -- |-----------------------< upd_end_date >-------------------------|
130 -- ----------------------------------------------------------------------------
131 -- {Start Of Comments}
132 --
133 -- Description:
134 -- This procedure will update the specified datetrack row with the
135 -- specified new effective end date. The object version number is also
136 -- set to the next object version number. DateTrack modes which call
137 -- this procedure are: UPDATE, UPDATE_CHANGE_INSERT,
138 -- UPDATE_OVERRIDE, DELETE, FUTURE_CHANGE and DELETE_NEXT_CHANGE.
139 -- This is an internal datetrack maintenance procedure which should
140 -- not be modified in anyway.
141 --
142 -- Prerequisites:
143 -- None.
144 --
145 -- In Parameters:
146 -- p_new_end_date
147 -- Specifies the new end date which will be set for the
148 -- row as of the effective date.
149 -- p_base_key_value
150 -- Specifies the primary key value for this datetrack entity.
151 -- (E.g. For this entity the assignment of the argument would be:
152 -- p_base_key_value = :action_type_id).
153 --
154 -- Post Success:
155 -- The specified row will be updated with the new effective end date and
156 -- object_version_number.
157 --
158 -- Post Failure:
159 -- Failure might occur if for the specified effective date and primary key
160 -- value a row doesn't exist.
161 --
162 -- Developer Implementation Notes:
163 -- This is an internal datetrack maintenance procedure which should
164 -- not be modified in anyway.
165 --
166 -- Access Status:
167 -- Internal Row Handler Use Only.
168 --
169 -- {End Of Comments}
170 -- ----------------------------------------------------------------------------
171 Procedure upd_end_date
172 (p_effective_date in date
173 ,p_action_type_id in number
174 ,p_new_end_date in date
175 ,p_validation_start_date in date
176 ,p_validation_end_date in date
177 ,p_object_version_number out nocopy number
178 );
179 --
180 -- ----------------------------------------------------------------------------
181 -- |---------------------------------< lck >----------------------------------|
182 -- ----------------------------------------------------------------------------
183 -- {Start Of Comments}
184 --
185 -- Description:
186 -- The Lck process for datetrack is complicated and comprises of the
187 -- following processing
188 -- The processing steps are as follows:
189 -- 1) The row to be updated or deleted must be locked.
190 -- By locking this row, the g_old_rec record data type is populated.
191 -- 2) If a comment exists the text is selected from hr_comments.
192 -- 3) The datetrack mode is then validated to ensure the operation is
193 -- valid. If the mode is valid the validation start and end dates for
194 -- the mode will be derived and returned. Any required locking is
195 -- completed when the datetrack mode is validated.
196 --
197 -- Prerequisites:
198 -- When attempting to call the lck procedure the object version number,
199 -- primary key, effective date and datetrack mode must be specified.
200 --
201 -- In Parameters:
202 -- p_effective_date
203 -- Specifies the date of the datetrack update operation.
204 -- p_datetrack_mode
205 -- Determines the datetrack update or delete mode.
206 --
207 -- Post Success:
208 -- On successful completion of the Lck process the row to be updated or
209 -- deleted will be locked and selected into the global data structure
210 -- g_old_rec.
211 --
212 -- Post Failure:
213 -- The Lck process can fail for three reasons:
214 -- 1) When attempting to lock the row the row could already be locked by
215 -- another user. This will raise the HR_Api.Object_Locked exception.
216 -- 2) The row which is required to be locked doesn't exist in the HR Schema.
217 -- This error is trapped and reported using the message name
218 -- 'HR_7220_INVALID_PRIMARY_KEY'.
219 -- 3) The row although existing in the HR Schema has a different object
220 -- version number than the object version number specified.
221 -- This error is trapped and reported using the message name
222 -- 'HR_7155_OBJECT_INVALID'.
223 --
224 -- Developer Implementation Notes:
225 -- None.
226 --
227 -- Access Status:
228 -- Internal Development Use Only.
229 --
230 -- {End Of Comments}
231 -- ----------------------------------------------------------------------------
232 Procedure lck
233 (p_effective_date in date
234 ,p_datetrack_mode in varchar2
235 ,p_action_type_id in number
236 ,p_object_version_number in number
237 ,p_validation_start_date out nocopy date
238 ,p_validation_end_date out nocopy date
239 );
240 --
241 -- ----------------------------------------------------------------------------
242 -- |-----------------------------< convert_args >-----------------------------|
243 -- ----------------------------------------------------------------------------
244 -- {Start Of Comments}
245 --
246 -- Description:
247 -- This function is used to turn attribute parameters into the record
248 -- structure parameter g_rec_type.
249 --
250 -- Prerequisites:
251 -- This is a private function and can only be called from the ins or upd
252 -- attribute processes.
253 --
254 -- In Parameters:
255 --
256 -- Post Success:
257 -- A returning record structure will be returned.
258 --
259 -- Post Failure:
260 -- No direct error handling is required within this function. Any possible
261 -- errors within this function will be a PL/SQL value error due to
262 -- conversion of datatypes or data lengths.
263 --
264 -- Developer Implementation Notes:
265 -- None.
266 --
267 -- Access Status:
268 -- Internal Row Handler Use Only.
269 --
270 -- {End Of Comments}
271 -- ----------------------------------------------------------------------------
272 Function convert_args
273 (p_action_type_id in number
274 ,p_name in varchar2
275 ,p_procedure_name in varchar2
276 ,p_start_date in date
277 ,p_end_date in date
278 ,p_description in varchar2
279 ,p_security_group_id in number
280 ,p_dynamic_description in varchar2
281 ,p_description_query in varchar2
282 ,p_object_version_number in number
283 )
284 Return g_rec_type;
285 --
286 -- ----------------------------------------------------------------------------
287 -- |-----------------------------< get_object_version_number >----------------|
288 -- ----------------------------------------------------------------------------
289 -- {Start Of Comments}
290 --
291 -- Description:
292 -- This function is used to get the next object version number to be used
293 -- within datetrack for an insert or update dml operation. The returned
294 -- object version number will be determined by taking the maximum
295 -- object version number for the datetracked rows and then incrementing by 1.
296 --
297 --
298 -- Prerequisites:
299 -- This is a private function and can only be called from the ins or upd
300 -- attribute processes.
301 --
302 -- In Parameters:
303 --
304 --
305 -- Post Success:
306 --
307 --
308 -- Post Failure:
309 --
310 --
311 --
312 --
313 -- Developer Implementation Notes:
314 -- None.
315 --
316 -- Access Status:
317 -- Internal Row Handler Use Only.
318 --
319 -- {End Of Comments}
320 -- ----------------------------------------------------------------------------
321 Function get_object_version_number
322 (p_action_type_id in number
323 )
324 Return number;
325 --
326 -- ----------------------------------------------------------------------------
327 -- |-----------------------------< child_rows_exist >-------------------------|
328 -- ----------------------------------------------------------------------------
329 Procedure child_rows_exist
330 (p_action_type_id in number
331 ,p_start_date in date
332 ,p_end_date in date
333 );
334 --
335 end ame_aty_shd;
[Home] [Help]