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