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