1 Package per_bpr_shd AUTHID CURRENT_USER as
2 /* $Header: pebprrhi.pkh 120.1 2010/08/10 17:38:35 vboggava ship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- | Global Record Type Specification |
6 -- ----------------------------------------------------------------------------
7 --
8 Type g_rec_type Is Record
9 (
10 payroll_run_id number(15),
11 payroll_id number(9),
12 business_group_id number(15),
13 payroll_identifier varchar2(30),
14 period_start_date date,
15 period_end_date date,
16 processing_date date,
17 object_version_number number(9),
18 bpr_attribute_category varchar2(30),
19 bpr_attribute1 varchar2(150),
20 bpr_attribute2 varchar2(150),
21 bpr_attribute3 varchar2(150),
22 bpr_attribute4 varchar2(150),
23 bpr_attribute5 varchar2(150),
24 bpr_attribute6 varchar2(150),
25 bpr_attribute7 varchar2(150),
26 bpr_attribute8 varchar2(150),
27 bpr_attribute9 varchar2(150),
28 bpr_attribute10 varchar2(150),
29 bpr_attribute11 varchar2(150),
30 bpr_attribute12 varchar2(150),
31 bpr_attribute13 varchar2(150),
32 bpr_attribute14 varchar2(150),
33 bpr_attribute15 varchar2(150),
34 bpr_attribute16 varchar2(150),
35 bpr_attribute17 varchar2(150),
36 bpr_attribute18 varchar2(150),
37 bpr_attribute19 varchar2(150),
38 bpr_attribute20 varchar2(150),
39 bpr_attribute21 varchar2(150),
40 bpr_attribute22 varchar2(150),
41 bpr_attribute23 varchar2(150),
42 bpr_attribute24 varchar2(150),
43 bpr_attribute25 varchar2(150),
44 bpr_attribute26 varchar2(150),
45 bpr_attribute27 varchar2(150),
46 bpr_attribute28 varchar2(150),
47 bpr_attribute29 varchar2(150),
48 bpr_attribute30 varchar2(150)
49 );
50 --
51 -- ----------------------------------------------------------------------------
52 -- | Global Definitions - Internal Development Use Only |
53 -- ----------------------------------------------------------------------------
54 --
55 g_old_rec g_rec_type; -- Global record definition
56 --
57 -- ----------------------------------------------------------------------------
58 -- |---------------------------< constraint_error >---------------------------|
59 -- ----------------------------------------------------------------------------
60 -- {Start Of Comments}
61 --
62 -- Description:
63 -- This procedure is called when a constraint has been violated (i.e.
64 -- The exception hr_api.check_integrity_violated,
65 -- hr_api.parent_integrity_violated, hr_api.child_integrity_violated or
66 -- hr_api.unique_integrity_violated has been raised).
67 -- The exceptions can only be raised as follows:
68 -- 1) A check constraint can only be violated during an INSERT or UPDATE
69 -- dml operation.
70 -- 2) A parent integrity constraint can only be violated during an
71 -- INSERT or UPDATE dml operation.
72 -- 3) A child integrity constraint can only be violated during an
73 -- DELETE dml operation.
74 -- 4) A unique integrity constraint can only be violated during INSERT or
75 -- UPDATE dml operation.
76 --
77 -- Prerequisites:
78 -- 1) Either hr_api.check_integrity_violated,
79 -- hr_api.parent_integrity_violated, hr_api.child_integrity_violated or
80 -- hr_api.unique_integrity_violated has been raised with the subsequent
81 -- stripping of the constraint name from the generated error message
82 -- text.
83 -- 2) Standalone validation test which corresponds with a constraint error.
84 --
85 -- In Parameter:
86 -- p_constraint_name is in upper format and is just the constraint name
87 -- (e.g. not prefixed by brackets, schema owner etc).
88 --
89 -- Post Success:
90 -- Development dependant.
91 --
92 -- Post Failure:
93 -- Developement dependant.
94 --
95 -- Developer Implementation Notes:
96 -- For each constraint being checked the hr system package failure message
97 -- has been generated as a template only. These system error messages should
98 -- be modified as required (i.e. change the system failure message to a user
99 -- friendly defined error message).
100 --
101 -- Access Status:
102 -- Internal Development Use Only.
103 --
104 -- {End Of Comments}
105 -- ----------------------------------------------------------------------------
106 Procedure constraint_error
107 (p_constraint_name in all_constraints.constraint_name%TYPE);
108 --
109 -- ----------------------------------------------------------------------------
110 -- |-----------------------------< api_updating >-----------------------------|
111 -- ----------------------------------------------------------------------------
112 -- {Start Of Comments}
113 --
114 -- Description:
115 -- This function is used to populate the g_old_rec record with the
116 -- current row from the database for the specified primary key
117 -- provided that the primary key exists and is valid and does not
118 -- already match the current g_old_rec. The function will always return
119 -- a TRUE value if the g_old_rec is populated with the current row.
120 -- A FALSE value will be returned if all of the primary key arguments
121 -- are null.
122 --
123 -- Prerequisites:
124 -- None.
125 --
126 -- In Parameters:
127 --
128 -- Post Success:
129 -- A value of TRUE will be returned indiciating that the g_old_rec
130 -- is current.
131 -- A value of FALSE will be returned if all of the primary key arguments
132 -- have a null value (this indicates that the row has not be inserted into
133 -- the Schema), and therefore could never have a corresponding row.
134 --
135 -- Post Failure:
136 -- A failure can only occur under two circumstances:
137 -- 1) The primary key is invalid (i.e. a row does not exist for the
138 -- specified primary key values).
139 -- 2) If an object_version_number exists but is NOT the same as the current
140 -- g_old_rec value.
141 --
142 -- Developer Implementation Notes:
143 -- None.
144 --
145 -- Access Status:
146 -- Internal Development Use Only.
147 --
148 -- {End Of Comments}
149 -- ----------------------------------------------------------------------------
150 Function api_updating
151 (
152 p_payroll_run_id in number,
153 p_object_version_number in number
154 ) Return Boolean;
155 --
156 -- ----------------------------------------------------------------------------
157 -- |---------------------------------< lck >----------------------------------|
158 -- ----------------------------------------------------------------------------
159 -- {Start of comments}
160 --
161 -- Description:
162 -- The Lck process has two main functions to perform. Firstly, the row to be
163 -- updated or deleted must be locked. The locking of the row will only be
164 -- successful if the row is not currently locked by another user.
165 -- Secondly, during the locking of the row, the row is selected into
166 -- the g_old_rec data structure which enables the current row values from the
167 -- server to be available to the api.
168 --
169 -- Prerequisites:
170 -- When attempting to call the lock the object version number (if defined)
171 -- is mandatory.
172 --
173 -- In Parameters:
174 -- The arguments to the Lck process are the primary key(s) which uniquely
175 -- identify the row and the object version number of row.
176 --
177 -- Post Success:
178 -- On successful completion of the Lck process the row to be updated or
179 -- deleted will be locked and selected into the global data structure
180 -- g_old_rec.
181 --
182 -- Post Failure:
183 -- The Lck process can fail for three reasons:
184 -- 1) When attempting to lock the row the row could already be locked by
185 -- another user. This will raise the HR_Api.Object_Locked exception.
186 -- 2) The row which is required to be locked doesn't exist in the HR Schema.
187 -- This error is trapped and reported using the message name
188 -- 'HR_7220_INVALID_PRIMARY_KEY'.
189 -- 3) The row although existing in the HR Schema has a different object
190 -- version number than the object version number specified.
191 -- This error is trapped and reported using the message name
192 -- 'HR_7155_OBJECT_INVALID'.
193 --
194 -- Developer Implementation Notes:
195 -- For each primary key and the object version number arguments add a
196 -- call to hr_api.mandatory_arg_error procedure to ensure that these
197 -- argument values are not null.
198 --
199 -- Access Status:
200 -- Internal Development Use Only.
201 --
202 -- {End of comments}
203 -- ----------------------------------------------------------------------------
204 Procedure lck
205 (
206 p_payroll_run_id in number,
207 p_object_version_number in number
208 );
209 --
210 -- ----------------------------------------------------------------------------
211 -- |-----------------------------< convert_args >-----------------------------|
212 -- ----------------------------------------------------------------------------
213 -- {Start Of Comments}
214 --
215 -- Description:
216 -- This function is used to turn attribute parameters into the record
217 -- structure parameter g_rec_type.
218 --
219 -- Prerequisites:
220 -- This is a private function and can only be called from the ins or upd
221 -- attribute processes.
222 --
223 -- In Parameters:
224 --
225 -- Post Success:
226 -- A returning record structure will be returned.
227 --
228 -- Post Failure:
229 -- No direct error handling is required within this function. Any possible
230 -- errors within this function will be a PL/SQL value error due to conversion
231 -- of datatypes or data lengths.
232 --
233 -- Developer Implementation Notes:
234 -- None.
235 --
236 -- Access Status:
237 -- Internal Row Handler Use Only.
238 --
239 -- {End Of Comments}
240 -- -----------------------------------------------------------------------------
241 Function convert_args
242 (
243 p_payroll_run_id in number,
244 p_payroll_id in number,
245 p_business_group_id in number,
246 p_payroll_identifier in varchar2,
247 p_period_start_date in date,
248 p_period_end_date in date,
249 p_processing_date in date,
250 p_object_version_number in number,
251 p_bpr_attribute_category in varchar2,
252 p_bpr_attribute1 in varchar2,
253 p_bpr_attribute2 in varchar2,
254 p_bpr_attribute3 in varchar2,
255 p_bpr_attribute4 in varchar2,
256 p_bpr_attribute5 in varchar2,
257 p_bpr_attribute6 in varchar2,
258 p_bpr_attribute7 in varchar2,
259 p_bpr_attribute8 in varchar2,
260 p_bpr_attribute9 in varchar2,
261 p_bpr_attribute10 in varchar2,
262 p_bpr_attribute11 in varchar2,
263 p_bpr_attribute12 in varchar2,
264 p_bpr_attribute13 in varchar2,
265 p_bpr_attribute14 in varchar2,
266 p_bpr_attribute15 in varchar2,
267 p_bpr_attribute16 in varchar2,
268 p_bpr_attribute17 in varchar2,
269 p_bpr_attribute18 in varchar2,
270 p_bpr_attribute19 in varchar2,
271 p_bpr_attribute20 in varchar2,
272 p_bpr_attribute21 in varchar2,
273 p_bpr_attribute22 in varchar2,
274 p_bpr_attribute23 in varchar2,
275 p_bpr_attribute24 in varchar2,
276 p_bpr_attribute25 in varchar2,
277 p_bpr_attribute26 in varchar2,
278 p_bpr_attribute27 in varchar2,
279 p_bpr_attribute28 in varchar2,
280 p_bpr_attribute29 in varchar2,
281 p_bpr_attribute30 in varchar2
282 )
283 Return g_rec_type;
284 --
285 end per_bpr_shd;
[Home] [Help]