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