1 Package per_pea_shd AUTHID CURRENT_USER as
2 /* $Header: pepearhi.pkh 120.2 2011/11/17 09:26:15 sidsaxen ship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- | Global Record Type Specification |
6 -- ----------------------------------------------------------------------------
7 --
8 Type g_rec_type Is Record
9 (
10 person_analysis_id number(15),
11 business_group_id number(15),
12 analysis_criteria_id number(15),
13 person_id per_person_analyses.person_id%TYPE,
14 /* Fix for the bug 6895989 starts here*/
15 -- comments varchar2(2000),
16 comments clob,
17 /*Fix for the bug 6895989 ends here*/
18 date_from date,
19 date_to date,
20 id_flex_num number,
21 request_id number(15),
22 program_application_id number(15),
23 program_id number(15),
24 program_update_date date,
25 attribute_category varchar2(30),
26 attribute1 varchar2(150),
27 attribute2 varchar2(150),
28 attribute3 varchar2(150),
29 attribute4 varchar2(150),
30 attribute5 varchar2(150),
31 attribute6 varchar2(150),
32 attribute7 varchar2(150),
33 attribute8 varchar2(150),
34 attribute9 varchar2(150),
35 attribute10 varchar2(150),
36 attribute11 varchar2(150),
37 attribute12 varchar2(150),
38 attribute13 varchar2(150),
39 attribute14 varchar2(150),
40 attribute15 varchar2(150),
41 attribute16 varchar2(150),
42 attribute17 varchar2(150),
43 attribute18 varchar2(150),
44 attribute19 varchar2(150),
45 attribute20 varchar2(150),
46 object_version_number number(9)
47 );
48 --
49 -- ----------------------------------------------------------------------------
50 -- | Global Definitions - Internal Development Use Only |
51 -- ----------------------------------------------------------------------------
52 --
53 g_old_rec g_rec_type; -- Global record definition
54 g_api_dml boolean; -- Global api dml status
55 g_tab_nam constant varchar2(30) :='PER_PERSON_ANALYSES';
56 --
57 -- ----------------------------------------------------------------------------
58 -- |------------------------< return_api_dml_status >-------------------------|
59 -- ----------------------------------------------------------------------------
60 -- {Start Of Comments}
61 --
62 -- Description:
63 -- This function will return the current g_api_dml private global
64 -- boolean status.
65 -- The g_api_dml status determines if at the time of the function
66 -- being executed if a dml statement (i.e. INSERT, UPDATE or DELETE)
67 -- is being issued from within an api.
68 -- If the status is TRUE then a dml statement is being issued from
69 -- within this entity api.
70 -- This function is primarily to support database triggers which
71 -- need to maintain the object_version_number for non-supported
72 -- dml statements (i.e. dml statement issued outside of the api layer).
73 --
74 -- Pre Conditions:
75 -- None.
76 --
77 -- In Parameters:
78 -- None.
79 --
80 -- Post Success:
81 -- Processing continues.
82 -- If the function returns a TRUE value then, dml is being executed from
83 -- within this api.
84 --
85 -- Post Failure:
86 -- None.
87 --
88 -- Access Status:
89 -- Internal Table Handler Use Only.
90 --
91 -- {End Of Comments}
92 -- ----------------------------------------------------------------------------
93 Function return_api_dml_status Return Boolean;
94 --
95 -- ----------------------------------------------------------------------------
96 -- |---------------------------< constraint_error >---------------------------|
97 -- ----------------------------------------------------------------------------
98 -- {Start Of Comments}
99 --
100 -- Description:
101 -- This procedure is called when a constraint has been violated (i.e.
102 -- The exception hr_api.check_integrity_violated,
103 -- hr_api.parent_integrity_violated, hr_api.child_integrity_violated or
104 -- hr_api.unique_integrity_violated has been raised).
105 -- The exceptions can only be raised as follows:
106 -- 1) A check constraint can only be violated during an INSERT or UPDATE
107 -- dml operation.
108 -- 2) A parent integrity constraint can only be violated during an
109 -- INSERT or UPDATE dml operation.
110 -- 3) A child integrity constraint can only be violated during an
111 -- DELETE dml operation.
112 -- 4) A unique integrity constraint can only be violated during INSERT or
113 -- UPDATE dml operation.
114 --
115 -- Pre Conditions:
116 -- 1) Either hr_api.check_integrity_violated,
117 -- hr_api.parent_integrity_violated, hr_api.child_integrity_violated or
118 -- hr_api.unique_integrity_violated has been raised with the subsequent
119 -- stripping of the constraint name from the generated error message
120 -- text.
121 -- 2) Standalone validation test which corresponds with a constraint error.
122 --
123 -- In Parameter:
124 -- p_constraint_name is in upper format and is just the constraint name
125 -- (e.g. not prefixed by brackets, schema owner etc).
126 --
127 -- Post Success:
128 -- Development dependant.
129 --
130 -- Post Failure:
131 -- Developement dependant.
132 --
133 -- Developer Implementation Notes:
134 -- For each constraint being checked the hr system package failure message
135 -- has been generated as a template only. These system error messages should
136 -- be modified as required (i.e. change the system failure message to a user
137 -- friendly defined error message).
138 --
139 -- Access Status:
140 -- Internal Development Use Only.
141 --
142 -- {End Of Comments}
143 -- ----------------------------------------------------------------------------
144 Procedure constraint_error
145 (p_constraint_name in all_constraints.constraint_name%TYPE);
146 --
147 -- ----------------------------------------------------------------------------
148 -- |-----------------------------< api_updating >-----------------------------|
149 -- ----------------------------------------------------------------------------
150 -- {Start Of Comments}
151 --
152 -- Description:
153 -- This function is used to populate the g_old_rec record with the
154 -- current row from the database for the specified primary key
155 -- provided that the primary key exists and is valid and does not
156 -- already match the current g_old_rec. The function will always return
157 -- a TRUE value if the g_old_rec is populated with the current row.
158 -- A FALSE value will be returned if all of the primary key arguments
159 -- are null.
160 --
161 -- Pre Conditions:
162 -- None.
163 --
164 -- In Parameters:
165 --
166 -- Post Success:
167 -- A value of TRUE will be returned indiciating that the g_old_rec
168 -- is current.
169 -- A value of FALSE will be returned if all of the primary key arguments
170 -- have a null value (this indicates that the row has not be inserted into
171 -- the Schema), and therefore could never have a corresponding row.
172 --
173 -- Post Failure:
174 -- A failure can only occur under two circumstances:
175 -- 1) The primary key is invalid (i.e. a row does not exist for the
176 -- specified primary key values).
177 -- 2) If an object_version_number exists but is NOT the same as the current
178 -- g_old_rec value.
179 --
180 -- Developer Implementation Notes:
181 -- None.
182 --
183 -- Access Status:
184 -- Internal Development Use Only.
185 --
186 -- {End Of Comments}
187 -- ----------------------------------------------------------------------------
188 Function api_updating
189 (
190 p_person_analysis_id in number,
191 p_object_version_number in number
192 )
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 the
206 -- server to be available to the api.
207 --
208 -- Pre Conditions:
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 (
245 p_person_analysis_id in number,
246 p_object_version_number in number
247 );
248 --
249 -- ----------------------------------------------------------------------------
250 -- |-----------------------------< convert_args >-----------------------------|
251 -- ----------------------------------------------------------------------------
252 -- {Start Of Comments}
253 --
254 -- Description:
255 -- This function is used to turn attribute parameters into the record
256 -- structure parameter g_rec_type.
257 --
258 -- Pre Conditions:
259 -- This is a private function and can only be called from the ins or upd
260 -- attribute processes.
261 --
262 -- In Parameters:
263 --
264 -- Post Success:
265 -- A returning record structure will be returned.
266 --
267 -- Post Failure:
268 -- No direct error handling is required within this function. Any possible
269 -- errors within this function will be a PL/SQL value error due to conversion
270 -- of datatypes or data lengths.
271 --
272 -- Developer Implementation Notes:
273 -- None.
274 --
275 -- Access Status:
276 -- Internal Table Handler Use Only.
277 --
278 -- {End Of Comments}
279 -- ----------------------------------------------------------------------------
280 Function convert_args
281 (
282 p_person_analysis_id in number,
283 p_business_group_id in number,
284 p_analysis_criteria_id in number,
285 p_person_id in number,
286 p_comments in varchar2,
287 p_date_from in date,
288 p_date_to in date,
289 p_id_flex_num in number,
290 p_request_id in number,
291 p_program_application_id in number,
292 p_program_id in number,
293 p_program_update_date in date,
294 p_attribute_category in varchar2,
295 p_attribute1 in varchar2,
296 p_attribute2 in varchar2,
297 p_attribute3 in varchar2,
298 p_attribute4 in varchar2,
299 p_attribute5 in varchar2,
300 p_attribute6 in varchar2,
301 p_attribute7 in varchar2,
302 p_attribute8 in varchar2,
303 p_attribute9 in varchar2,
304 p_attribute10 in varchar2,
305 p_attribute11 in varchar2,
306 p_attribute12 in varchar2,
307 p_attribute13 in varchar2,
308 p_attribute14 in varchar2,
309 p_attribute15 in varchar2,
310 p_attribute16 in varchar2,
311 p_attribute17 in varchar2,
312 p_attribute18 in varchar2,
313 p_attribute19 in varchar2,
314 p_attribute20 in varchar2,
315 p_object_version_number in number
316 )
317 Return g_rec_type;
318 --
319 end per_pea_shd;
[Home] [Help]