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