1 Package per_obj_shd as
2 /* $Header: peobjrhi.pkh 120.4.12010000.1 2008/07/28 05:04:18 appldev ship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- | Global Record Type Specification |
6 -- ----------------------------------------------------------------------------
7 --
8 Type g_rec_type Is Record
9 (
10 objective_id number(15),
11 name varchar2(400), -- Fix 5122263 (Prev fix 2462004)
12 target_date date,
13 start_date date,
14 business_group_id number(15),
15 object_version_number number(9),
16 owning_person_id number(15),
17 achievement_date date,
18 detail varchar2(4000),
19 comments varchar2(4000), -- pseudo column
20 success_criteria varchar2(4000),
21 appraisal_id number(15),
22 attribute_category varchar2(30),
23 attribute1 varchar2(150),
24 attribute2 varchar2(150),
25 attribute3 varchar2(150),
26 attribute4 varchar2(150),
27 attribute5 varchar2(150),
28 attribute6 varchar2(150),
29 attribute7 varchar2(150),
30 attribute8 varchar2(150),
31 attribute9 varchar2(150),
32 attribute10 varchar2(150),
33 attribute11 varchar2(150),
34 attribute12 varchar2(150),
35 attribute13 varchar2(150),
36 attribute14 varchar2(150),
37 attribute15 varchar2(150),
38 attribute16 varchar2(150),
39 attribute17 varchar2(150),
40 attribute18 varchar2(150),
41 attribute19 varchar2(150),
42
43 attribute20 varchar2(150),
44 attribute21 varchar2(150),
45 attribute22 varchar2(150),
46 attribute23 varchar2(150),
47 attribute24 varchar2(150),
48 attribute25 varchar2(150),
49 attribute26 varchar2(150),
50 attribute27 varchar2(150),
51 attribute28 varchar2(150),
52 attribute29 varchar2(150),
53 attribute30 varchar2(150),
54
55 scorecard_id number(15),
56 copied_from_library_id number(15),
57 copied_from_objective_id number(15),
58 aligned_with_objective_id number(15),
59
60 next_review_date date,
61 group_code varchar2(30),
62 priority_code varchar2(30),
63 appraise_flag varchar2(30),
64 verified_flag varchar2(30),
65
66 target_value number,
67 actual_value number,
68 weighting_percent number(15),
69 complete_percent number(15),
70 uom_code varchar2(30),
71
72 measurement_style_code varchar2(30),
73 measure_name varchar2(240),
74 measure_type_code varchar2(30),
75 measure_comments varchar2(4000),
76 sharing_access_code varchar2(30)
77
78 );
79 --
80 -- ----------------------------------------------------------------------------
81 -- | Global Definitions - Internal Development Use Only |
82 -- ----------------------------------------------------------------------------
83 --
84 g_old_rec g_rec_type; -- Global record definition
85 g_tab_nam constant varchar2(30) := 'PER_OBJECTIVES';
86
87 -- ----------------------------------------------------------------------------
88 -- |---------------------------< constraint_error >---------------------------|
89 -- ----------------------------------------------------------------------------
90 -- {Start Of Comments}
91 --
92 -- Description:
93 -- This procedure is called when a constraint has been violated (i.e.
94 -- The exception hr_api.check_integrity_violated,
95 -- hr_api.parent_integrity_violated, hr_api.child_integrity_violated or
96 -- hr_api.unique_integrity_violated has been raised).
97 -- The exceptions can only be raised as follows:
98 -- 1) A check constraint can only be violated during an INSERT or UPDATE
99 -- dml operation.
100 -- 2) A parent integrity constraint can only be violated during an
101 -- INSERT or UPDATE dml operation.
102 -- 3) A child integrity constraint can only be violated during an
103 -- DELETE dml operation.
104 -- 4) A unique integrity constraint can only be violated during INSERT or
105 -- UPDATE dml operation.
106 --
107 -- Pre Conditions:
108 -- 1) Either hr_api.check_integrity_violated,
109 -- hr_api.parent_integrity_violated, hr_api.child_integrity_violated or
110 -- hr_api.unique_integrity_violated has been raised with the subsequent
111 -- stripping of the constraint name from the generated error message
112 -- text.
113 -- 2) Standalone validation test which corresponds with a constraint error.
114 --
115 -- In Parameter:
116 -- p_constraint_name is in upper format and is just the constraint name
117 -- (e.g. not prefixed by brackets, schema owner etc).
118 --
119 -- Post Success:
120 -- Development dependant.
121 --
122 -- Post Failure:
123 -- Developement dependant.
124 --
125 -- Developer Implementation Notes:
126 -- For each constraint being checked the hr system package failure message
127 -- has been generated as a template only. These system error messages should
128 -- be modified as required (i.e. change the system failure message to a user
129 -- friendly defined error message).
130 --
131 -- Access Status:
132 -- Internal Development Use Only.
133 --
134 -- {End Of Comments}
135 -- ----------------------------------------------------------------------------
136 Procedure constraint_error
137 (p_constraint_name in all_constraints.constraint_name%TYPE);
138 --
139 -- ----------------------------------------------------------------------------
140 -- |-----------------------------< api_updating >-----------------------------|
141 -- ----------------------------------------------------------------------------
142 -- {Start Of Comments}
143 --
144 -- Description:
145 -- This function is used to populate the g_old_rec record with the
146 -- current row from the database for the specified primary key
147 -- provided that the primary key exists and is valid and does not
148 -- already match the current g_old_rec. The function will always return
149 -- a TRUE value if the g_old_rec is populated with the current row.
150 -- A FALSE value will be returned if all of the primary key arguments
151 -- are null.
152 --
153 -- Pre Conditions:
154 -- None.
155 --
156 -- In Parameters:
157 --
158 -- Post Success:
159 -- A value of TRUE will be returned indiciating that the g_old_rec
160 -- is current.
161 -- A value of FALSE will be returned if all of the primary key arguments
162 -- have a null value (this indicates that the row has not be inserted into
163 -- the Schema), and therefore could never have a corresponding row.
164 --
165 -- Post Failure:
166 -- A failure can only occur under two circumstances:
167 -- 1) The primary key is invalid (i.e. a row does not exist for the
168 -- specified primary key values).
169 -- 2) If an object_version_number exists but is NOT the same as the current
170 -- g_old_rec value.
171 --
172 -- Developer Implementation Notes:
173 -- None.
174 --
175 -- Access Status:
176 -- Internal Development Use Only.
177 --
178 -- {End Of Comments}
179 -- ----------------------------------------------------------------------------
180 Function api_updating
181 (
182 p_objective_id in number,
183 p_object_version_number in number
184 ) Return Boolean;
185 --
186 -- ----------------------------------------------------------------------------
187 -- |---------------------------------< lck >----------------------------------|
188 -- ----------------------------------------------------------------------------
189 -- {Start Of Comments}
190 --
191 -- Description:
192 -- The Lck process has two main functions to perform. Firstly, the row to be
193 -- updated or deleted must be locked. The locking of the row will only be
194 -- successful if the row is not currently locked by another user.
195 -- Secondly, during the locking of the row, the row is selected into
196 -- the g_old_rec data structure which enables the current row values from the
197 -- server to be available to the api.
198 --
199 -- Pre Conditions:
200 -- When attempting to call the lock the object version number (if defined)
201 -- is mandatory.
202 --
203 -- In Parameters:
204 -- The arguments to the Lck process are the primary key(s) which uniquely
205 -- identify the row and the object version number of row.
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 -- For each primary key and the object version number arguments add a
226 -- call to hr_api.mandatory_arg_error procedure to ensure that these
227 -- argument values are not null.
228 --
229 -- Access Status:
230 -- Internal Development Use Only.
231 --
232 -- {End Of Comments}
233 -- ----------------------------------------------------------------------------
234 Procedure lck
235 (
236 p_objective_id in number,
237 p_object_version_number in number
238 );
239 --
240 -- ----------------------------------------------------------------------------
241 -- |-----------------------------< convert_args >-----------------------------|
242 -- ----------------------------------------------------------------------------
243 -- {Start Of Comments}
244 --
245 -- Description:
246 -- This function is used to turn attribute parameters into the record
247 -- structure parameter g_rec_type.
248 --
249 -- Pre Conditions:
250 -- This is a private function and can only be called from the ins or upd
251 -- attribute processes.
252 --
253 -- In Parameters:
254 --
255 -- Post Success:
256 -- A returning record structure will be returned.
257 --
258 -- Post Failure: -- No direct error handling is required within this function. Any possible
259 -- errors within this function will be a PL/SQL value error due to conversion
260 -- of datatypes or data lengths.
261 --
262 -- Developer Implementation Notes:
263 -- None.
264 --
265 -- Access Status:
266 -- Internal Table Handler Use Only.
267 --
268 -- {End Of Comments}
269 -- ----------------------------------------------------------------------------
270 Function convert_args
271 (
272 p_objective_id in number,
273 p_name in varchar2,
274 p_target_date in date,
275 p_start_date in date,
276 p_business_group_id in number,
277 p_object_version_number in number,
278 p_owning_person_id in number,
279 p_achievement_date in date,
280 p_detail in varchar2,
281 p_comments in varchar2,
282 p_success_criteria in varchar2,
283 p_appraisal_id in number,
284 p_attribute_category in varchar2,
285 p_attribute1 in varchar2,
286 p_attribute2 in varchar2,
287 p_attribute3 in varchar2,
288 p_attribute4 in varchar2,
289 p_attribute5 in varchar2,
290 p_attribute6 in varchar2,
291 p_attribute7 in varchar2,
292 p_attribute8 in varchar2,
293 p_attribute9 in varchar2,
294 p_attribute10 in varchar2,
295 p_attribute11 in varchar2,
296 p_attribute12 in varchar2,
297 p_attribute13 in varchar2,
298 p_attribute14 in varchar2,
299 p_attribute15 in varchar2,
300 p_attribute16 in varchar2,
301 p_attribute17 in varchar2,
302 p_attribute18 in varchar2,
303 p_attribute19 in varchar2,
304 p_attribute20 in varchar2,
305
306 p_attribute21 in varchar2,
307 p_attribute22 in varchar2,
308 p_attribute23 in varchar2,
309 p_attribute24 in varchar2,
310 p_attribute25 in varchar2,
311 p_attribute26 in varchar2,
312 p_attribute27 in varchar2,
313 p_attribute28 in varchar2,
314 p_attribute29 in varchar2,
315 p_attribute30 in varchar2,
316
317 p_scorecard_id in number,
318 p_copied_from_library_id in number,
319 p_copied_from_objective_id in number,
320 p_aligned_with_objective_id in number,
321
322 p_next_review_date in date,
323 p_group_code in varchar2,
324 p_priority_code in varchar2,
325 p_appraise_flag in varchar2,
326 p_verified_flag in varchar2,
327
328 p_target_value in number,
329 p_actual_value in number,
330 p_weighting_percent in number,
331 p_complete_percent in number,
332 p_uom_code in varchar2,
333
334 p_measurement_style_code in varchar2,
335 p_measure_name in varchar2,
336 p_measure_type_code in varchar2,
337 p_measure_comments in varchar2,
338 p_sharing_access_code in varchar2
339
340 )
341 Return g_rec_type;
342 --
343 end per_obj_shd;