1 Package pay_pev_shd as
2 /* $Header: pypperhi.pkh 120.1.12010000.1 2008/07/27 23:25:21 appldev ship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- | Global Record Type Specification |
6 -- ----------------------------------------------------------------------------
7 --
8 Type g_rec_type Is Record
9 (process_event_id number(9)
10 ,assignment_id number(10)
11 ,effective_date date
12 ,change_type varchar2(30)
13 ,status varchar2(30)
14 ,description varchar2(240)
15 ,event_update_id number(15)
16 ,business_group_id number(15)
17 ,org_process_event_group_id number(15)
18 ,surrogate_key varchar2(60)
19 ,object_version_number number(9)
20 ,calculation_date date
21 ,retroactive_status varchar2(30)
22 ,noted_value varchar2(30)
23 );
24 --
25 -- ----------------------------------------------------------------------------
26 -- | Global Definitions - Internal Development Use Only |
27 -- ----------------------------------------------------------------------------
28 --
29 g_old_rec g_rec_type; -- Global record definition
30 g_api_dml boolean; -- Global api dml status
31 --
32 -- ----------------------------------------------------------------------------
33 -- |------------------------< return_api_dml_status >-------------------------|
34 -- ----------------------------------------------------------------------------
35 -- {Start Of Comments}
36 --
37 -- Description:
38 -- This function will return the current g_api_dml private global
39 -- boolean status.
40 -- The g_api_dml status determines if at the time of the function
41 -- being executed if a dml statement (i.e. INSERT, UPDATE or DELETE)
42 -- is being issued from within an api.
43 -- If the status is TRUE then a dml statement is being issued from
44 -- within this entity api.
45 -- This function is primarily to support database triggers which
46 -- need to maintain the object_version_number for non-supported
47 -- dml statements (i.e. dml statement issued outside of the api layer).
48 --
49 -- Prerequisites:
50 -- None.
51 --
52 -- In Parameters:
53 -- None.
54 --
55 -- Post Success:
56 -- Processing continues.
57 -- If the function returns a TRUE value then, dml is being executed from
58 -- within this api.
59 --
60 -- Post Failure:
61 -- None.
62 --
63 -- Access Status:
64 -- Internal Row Handler Use Only.
65 --
66 -- {End Of Comments}
67 -- ----------------------------------------------------------------------------
68 Function return_api_dml_status Return Boolean;
69 --
70 -- ----------------------------------------------------------------------------
71 -- |---------------------------< constraint_error >---------------------------|
72 -- ----------------------------------------------------------------------------
73 -- {Start Of Comments}
74 --
75 -- Description:
76 -- This procedure is called when a constraint has been violated (i.e.
77 -- The exception hr_api.check_integrity_violated,
78 -- hr_api.parent_integrity_violated, hr_api.child_integrity_violated or
79 -- hr_api.unique_integrity_violated has been raised).
80 -- The exceptions can only be raised as follows:
81 -- 1) A check constraint can only be violated during an INSERT or UPDATE
82 -- dml operation.
83 -- 2) A parent integrity constraint can only be violated during an
84 -- INSERT or UPDATE dml operation.
85 -- 3) A child integrity constraint can only be violated during an
86 -- DELETE dml operation.
87 -- 4) A unique integrity constraint can only be violated during INSERT or
88 -- UPDATE dml operation.
89 --
90 -- Prerequisites:
91 -- 1) Either hr_api.check_integrity_violated,
92 -- hr_api.parent_integrity_violated, hr_api.child_integrity_violated or
93 -- hr_api.unique_integrity_violated has been raised with the subsequent
94 -- stripping of the constraint name from the generated error message
95 -- text.
96 -- 2) Standalone validation test which corresponds with a constraint error.
97 --
98 -- In Parameter:
99 -- p_constraint_name is in upper format and is just the constraint name
100 -- (e.g. not prefixed by brackets, schema owner etc).
101 --
102 -- Post Success:
103 -- Development dependant.
104 --
105 -- Post Failure:
106 -- Developement dependant.
107 --
108 -- Developer Implementation Notes:
109 -- For each constraint being checked the hr system package failure message
110 -- has been generated as a template only. These system error messages should
111 -- be modified as required (i.e. change the system failure message to a user
112 -- friendly defined error message).
113 --
114 -- Access Status:
115 -- Internal Development Use Only.
116 --
117 -- {End Of Comments}
118 -- ----------------------------------------------------------------------------
119 Procedure constraint_error
120 (p_constraint_name in all_constraints.constraint_name%TYPE);
121 --
122 -- ----------------------------------------------------------------------------
123 -- |-----------------------------< api_updating >-----------------------------|
124 -- ----------------------------------------------------------------------------
125 -- {Start Of Comments}
126 --
127 -- Description:
128 -- This function is used to populate the g_old_rec record with the
129 -- current row from the database for the specified primary key
130 -- provided that the primary key exists and is valid and does not
131 -- already match the current g_old_rec. The function will always return
132 -- a TRUE value if the g_old_rec is populated with the current row.
133 -- A FALSE value will be returned if all of the primary key arguments
134 -- are null.
135 --
136 -- Prerequisites:
137 -- None.
138 --
139 -- In Parameters:
140 --
141 -- Post Success:
142 -- A value of TRUE will be returned indiciating that the g_old_rec
143 -- is current.
144 -- A value of FALSE will be returned if all of the primary key arguments
145 -- have a null value (this indicates that the row has not be inserted into
146 -- the Schema), and therefore could never have a corresponding row.
147 --
148 -- Post Failure:
149 -- A failure can only occur under two circumstances:
150 -- 1) The primary key is invalid (i.e. a row does not exist for the
151 -- specified primary key values).
152 -- 2) If an object_version_number exists but is NOT the same as the current
153 -- g_old_rec value.
154 --
155 -- Developer Implementation Notes:
156 -- None.
157 --
158 -- Access Status:
159 -- Internal Development Use Only.
160 --
161 -- {End Of Comments}
162 -- ----------------------------------------------------------------------------
163 Function api_updating
164 (p_process_event_id in number
165 ,p_object_version_number in number
166 ) Return Boolean;
167 --
168 -- ----------------------------------------------------------------------------
169 -- |---------------------------------< lck >----------------------------------|
170 -- ----------------------------------------------------------------------------
171 -- {Start of comments}
172 --
173 -- Description:
174 -- The Lck process has two main functions to perform. Firstly, the row to be
175 -- updated or deleted must be locked. The locking of the row will only be
176 -- successful if the row is not currently locked by another user.
177 -- Secondly, during the locking of the row, the row is selected into
178 -- the g_old_rec data structure which enables the current row values from the
179 -- server to be available to the api.
180 --
181 -- Prerequisites:
182 -- When attempting to call the lock the object version number (if defined)
183 -- is mandatory.
184 --
185 -- In Parameters:
186 -- The arguments to the Lck process are the primary key(s) which uniquely
187 -- identify the row and the object version number of row.
188 --
189 -- Post Success:
190 -- On successful completion of the Lck process the row to be updated or
191 -- deleted will be locked and selected into the global data structure
192 -- g_old_rec.
193 --
194 -- Post Failure:
195 -- The Lck process can fail for three reasons:
196 -- 1) When attempting to lock the row the row could already be locked by
197 -- another user. This will raise the HR_Api.Object_Locked exception.
198 -- 2) The row which is required to be locked doesn't exist in the HR Schema.
199 -- This error is trapped and reported using the message name
200 -- 'HR_7220_INVALID_PRIMARY_KEY'.
201 -- 3) The row although existing in the HR Schema has a different object
202 -- version number than the object version number specified.
203 -- This error is trapped and reported using the message name
204 -- 'HR_7155_OBJECT_INVALID'.
205 --
206 -- Developer Implementation Notes:
207 -- For each primary key and the object version number arguments add a
208 -- call to hr_api.mandatory_arg_error procedure to ensure that these
209 -- argument values are not null.
210 --
211 -- Access Status:
212 -- Internal Development Use Only.
213 --
214 -- {End of comments}
215 -- ----------------------------------------------------------------------------
216 Procedure lck
217 (p_process_event_id in number
218 ,p_object_version_number in number
219 );
220 --
221 -- ----------------------------------------------------------------------------
222 -- |-----------------------------< convert_args >-----------------------------|
223 -- ----------------------------------------------------------------------------
224 -- {Start Of Comments}
225 --
226 -- Description:
227 -- This function is used to turn attribute parameters into the record
228 -- structure parameter g_rec_type.
229 --
230 -- Prerequisites:
231 -- This is a private function and can only be called from the ins or upd
232 -- attribute processes.
233 --
234 -- In Parameters:
235 --
236 -- Post Success:
237 -- A returning record structure will be returned.
238 --
239 -- Post Failure:
240 -- No direct error handling is required within this function. Any possible
241 -- errors within this function will be a PL/SQL value error due to conversion
242 -- of datatypes or data lengths.
243 --
244 -- Developer Implementation Notes:
245 -- None.
246 --
247 -- Access Status:
248 -- Internal Row Handler Use Only.
249 --
250 -- {End Of Comments}
251 -- ----------------------------------------------------------------------------
252 Function convert_args
253 (p_process_event_id in number
254 ,p_assignment_id in number
255 ,p_effective_date in date
256 ,p_change_type in varchar2
257 ,p_status in varchar2
258 ,p_description in varchar2
259 ,p_event_update_id in number
260 ,p_business_group_id in number
261 ,p_org_process_event_group_id in number
262 ,p_surrogate_key in varchar2
263 ,p_object_version_number in number
264 ,p_calculation_date in date
265 ,p_retroactive_status in varchar2
266 ,p_noted_value in varchar2
267 )
268 Return g_rec_type;
269 --
270 end pay_pev_shd;
[Home] [Help]