1 Package hr_cnp_shd as
2 /* $Header: hrcnprhi.pkh 120.0 2005/05/30 23:17:21 appldev noship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- | Global Record Type Specification |
6 -- ----------------------------------------------------------------------------
7 --
8 Type g_rec_type Is Record
9 (canvas_property_id number(15)
10 ,object_version_number number(9)
11 ,form_canvas_id number(15)
12 ,template_canvas_id number(15)
13 ,height number(12,2)
14 ,visible number(10)
15 ,width number(12,2)
16 ,x_position number(12,2)
17 ,y_position number(12,2)
18 ,information_category varchar2(150)
19 ,information1 varchar2(150)
20 ,information2 varchar2(150)
21 ,information3 varchar2(150)
22 ,information4 varchar2(150)
23 ,information5 varchar2(150)
24 ,information6 varchar2(150)
25 ,information7 varchar2(150)
26 ,information8 varchar2(150)
27 ,information9 varchar2(150)
28 ,information10 varchar2(150)
29 ,information11 varchar2(150)
30 ,information12 varchar2(150)
31 ,information13 varchar2(150)
32 ,information14 varchar2(150)
33 ,information15 varchar2(150)
34 ,information16 varchar2(150)
35 ,information17 varchar2(150)
36 ,information18 varchar2(150)
37 ,information19 varchar2(150)
38 ,information20 varchar2(150)
39 ,information21 varchar2(150)
40 ,information22 varchar2(150)
41 ,information23 varchar2(150)
42 ,information24 varchar2(150)
43 ,information25 varchar2(150)
44 ,information26 varchar2(150)
45 ,information27 varchar2(150)
46 ,information28 varchar2(150)
47 ,information29 varchar2(150)
48 ,information30 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 (p_canvas_property_id in number
152 ,p_object_version_number in number
153 ) Return Boolean;
154 --
155 -- ----------------------------------------------------------------------------
156 -- |---------------------------------< lck >----------------------------------|
157 -- ----------------------------------------------------------------------------
158 -- {Start of comments}
159 --
160 -- Description:
161 -- The Lck process has two main functions to perform. Firstly, the row to be
162 -- updated or deleted must be locked. The locking of the row will only be
163 -- successful if the row is not currently locked by another user.
164 -- Secondly, during the locking of the row, the row is selected into
165 -- the g_old_rec data structure which enables the current row values from the
166 -- server to be available to the api.
167 --
168 -- Prerequisites:
169 -- When attempting to call the lock the object version number (if defined)
170 -- is mandatory.
171 --
172 -- In Parameters:
173 -- The arguments to the Lck process are the primary key(s) which uniquely
174 -- identify the row and the object version number of row.
175 --
176 -- Post Success:
177 -- On successful completion of the Lck process the row to be updated or
178 -- deleted will be locked and selected into the global data structure
179 -- g_old_rec.
180 --
181 -- Post Failure:
182 -- The Lck process can fail for three reasons:
183 -- 1) When attempting to lock the row the row could already be locked by
184 -- another user. This will raise the HR_Api.Object_Locked exception.
185 -- 2) The row which is required to be locked doesn't exist in the HR Schema.
186 -- This error is trapped and reported using the message name
187 -- 'HR_7220_INVALID_PRIMARY_KEY'.
188 -- 3) The row although existing in the HR Schema has a different object
189 -- version number than the object version number specified.
190 -- This error is trapped and reported using the message name
191 -- 'HR_7155_OBJECT_INVALID'.
192 --
193 -- Developer Implementation Notes:
194 -- For each primary key and the object version number arguments add a
195 -- call to hr_api.mandatory_arg_error procedure to ensure that these
196 -- argument values are not null.
197 --
198 -- Access Status:
199 -- Internal Development Use Only.
200 --
201 -- {End of comments}
202 -- ----------------------------------------------------------------------------
203 Procedure lck
204 (p_canvas_property_id in number
205 ,p_object_version_number in number
206 );
207 --
208 -- ----------------------------------------------------------------------------
209 -- |-----------------------------< convert_args >-----------------------------|
210 -- ----------------------------------------------------------------------------
211 -- {Start Of Comments}
212 --
213 -- Description:
214 -- This function is used to turn attribute parameters into the record
215 -- structure parameter g_rec_type.
216 --
217 -- Prerequisites:
218 -- This is a private function and can only be called from the ins or upd
219 -- attribute processes.
220 --
221 -- In Parameters:
222 --
223 -- Post Success:
224 -- A returning record structure will be returned.
225 --
226 -- Post Failure:
227 -- No direct error handling is required within this function. Any possible
228 -- errors within this function will be a PL/SQL value error due to conversion
229 -- of datatypes or data lengths.
230 --
231 -- Developer Implementation Notes:
232 -- None.
233 --
234 -- Access Status:
235 -- Internal Row Handler Use Only.
236 --
237 -- {End Of Comments}
238 -- ----------------------------------------------------------------------------
239 Function convert_args
240 (p_canvas_property_id in number
241 ,p_object_version_number in number
242 ,p_form_canvas_id in number
243 ,p_template_canvas_id in number
244 ,p_height in number
245 ,p_visible in number
246 ,p_width in number
247 ,p_x_position in number
248 ,p_y_position in number
249 ,p_information_category in varchar2
250 ,p_information1 in varchar2
251 ,p_information2 in varchar2
252 ,p_information3 in varchar2
253 ,p_information4 in varchar2
254 ,p_information5 in varchar2
255 ,p_information6 in varchar2
256 ,p_information7 in varchar2
257 ,p_information8 in varchar2
258 ,p_information9 in varchar2
259 ,p_information10 in varchar2
260 ,p_information11 in varchar2
261 ,p_information12 in varchar2
262 ,p_information13 in varchar2
263 ,p_information14 in varchar2
264 ,p_information15 in varchar2
265 ,p_information16 in varchar2
266 ,p_information17 in varchar2
267 ,p_information18 in varchar2
268 ,p_information19 in varchar2
269 ,p_information20 in varchar2
270 ,p_information21 in varchar2
271 ,p_information22 in varchar2
272 ,p_information23 in varchar2
273 ,p_information24 in varchar2
274 ,p_information25 in varchar2
275 ,p_information26 in varchar2
276 ,p_information27 in varchar2
277 ,p_information28 in varchar2
278 ,p_information29 in varchar2
279 ,p_information30 in varchar2
280 )
281 Return g_rec_type;
282 --
283 end hr_cnp_shd;
[Home] [Help]