1 Package psp_poa_shd as
2 /* $Header: PSPOARHS.pls 120.0 2005/11/20 23:57 dpaudel noship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- | Global Record Type Specification |
6 -- ----------------------------------------------------------------------------
7 --
8 Type g_rec_type Is Record
9 (organization_account_id number(9)
10 ,gl_code_combination_id number(15)
11 ,project_id number(15)
12 ,expenditure_organization_id number(15)
13 ,expenditure_type varchar2(30)
14 ,task_id number(15)
15 ,award_id number(15)
16 ,comments varchar2(255) -- pseudo column
17 ,attribute_category varchar2(30)
18 ,attribute1 varchar2(150)
19 ,attribute2 varchar2(150)
20 ,attribute3 varchar2(150)
21 ,attribute4 varchar2(150)
22 ,attribute5 varchar2(150)
23 ,attribute6 varchar2(150)
24 ,attribute7 varchar2(150)
25 ,attribute8 varchar2(150)
26 ,attribute9 varchar2(150)
27 ,attribute10 varchar2(150)
28 ,attribute11 varchar2(150)
29 ,attribute12 varchar2(150)
30 ,attribute13 varchar2(150)
31 ,attribute14 varchar2(150)
32 ,attribute15 varchar2(150)
33 ,set_of_books_id number(15)
34 ,account_type_code varchar2(30)
35 ,start_date_active date
36 ,business_group_id number(15)
37 ,end_date_active date
38 ,organization_id number(15)
39 ,poeta_start_date date
40 ,poeta_end_date date
41 ,object_version_number number(9)
42 ,funding_source_code varchar2(30)
43 );
44 --
45 -- ----------------------------------------------------------------------------
46 -- | Global Definitions - Internal Development Use Only |
47 -- ----------------------------------------------------------------------------
48 --
49 g_old_rec g_rec_type; -- Global record definition
50 -- Global table name
51 g_tab_nam constant varchar2(30) := 'PSP_ORGANIZATION_ACCOUNTS';
52 g_api_dml boolean; -- Global api dml status
53 --
54 -- ----------------------------------------------------------------------------
55 -- |------------------------< return_api_dml_status >-------------------------|
56 -- ----------------------------------------------------------------------------
57 -- {Start Of Comments}
58 --
59 -- Description:
60 -- This function will return the current g_api_dml private global
61 -- boolean status.
62 -- The g_api_dml status determines if at the time of the function
63 -- being executed if a dml statement (i.e. INSERT, UPDATE or DELETE)
64 -- is being issued from within an api.
65 -- If the status is TRUE then a dml statement is being issued from
66 -- within this entity api.
67 -- This function is primarily to support database triggers which
68 -- need to maintain the object_version_number for non-supported
69 -- dml statements (i.e. dml statement issued outside of the api layer).
70 --
71 -- Prerequisites:
72 -- None.
73 --
74 -- In Parameters:
75 -- None.
76 --
77 -- Post Success:
78 -- Processing continues.
79 -- If the function returns a TRUE value then, dml is being executed from
80 -- within this api.
81 --
82 -- Post Failure:
83 -- None.
84 --
85 -- Access Status:
86 -- Internal Row Handler Use Only.
87 --
88 -- {End Of Comments}
89 -- ----------------------------------------------------------------------------
90 Function return_api_dml_status Return Boolean;
91 --
92 -- ----------------------------------------------------------------------------
93 -- |---------------------------< constraint_error >---------------------------|
94 -- ----------------------------------------------------------------------------
95 -- {Start Of Comments}
96 --
97 -- Description:
98 -- This procedure is called when a constraint has been violated (i.e.
99 -- The exception hr_api.check_integrity_violated,
100 -- hr_api.parent_integrity_violated, hr_api.child_integrity_violated or
101 -- hr_api.unique_integrity_violated has been raised).
102 -- The exceptions can only be raised as follows:
103 -- 1) A check constraint can only be violated during an INSERT or UPDATE
104 -- dml operation.
105 -- 2) A parent integrity constraint can only be violated during an
106 -- INSERT or UPDATE dml operation.
107 -- 3) A child integrity constraint can only be violated during an
108 -- DELETE dml operation.
109 -- 4) A unique integrity constraint can only be violated during INSERT or
110 -- UPDATE dml operation.
111 --
112 -- Prerequisites:
113 -- 1) Either hr_api.check_integrity_violated,
114 -- hr_api.parent_integrity_violated, hr_api.child_integrity_violated or
115 -- hr_api.unique_integrity_violated has been raised with the subsequent
116 -- stripping of the constraint name from the generated error message
117 -- text.
118 -- 2) Standalone validation test which corresponds with a constraint error.
119 --
120 -- In Parameter:
121 -- p_constraint_name is in upper format and is just the constraint name
122 -- (e.g. not prefixed by brackets, schema owner etc).
123 --
124 -- Post Success:
125 -- Development dependant.
126 --
127 -- Post Failure:
128 -- Developement dependant.
129 --
130 -- Developer Implementation Notes:
131 -- For each constraint being checked the hr system package failure message
132 -- has been generated as a template only. These system error messages should
133 -- be modified as required (i.e. change the system failure message to a user
134 -- friendly defined error message).
135 --
136 -- Access Status:
137 -- Internal Development Use Only.
138 --
139 -- {End Of Comments}
140 -- ----------------------------------------------------------------------------
141 Procedure constraint_error
142 (p_constraint_name in all_constraints.constraint_name%TYPE);
143 --
144 -- ----------------------------------------------------------------------------
145 -- |-----------------------------< api_updating >-----------------------------|
146 -- ----------------------------------------------------------------------------
147 -- {Start Of Comments}
148 --
149 -- Description:
150 -- This function is used to populate the g_old_rec record with the
151 -- current row from the database for the specified primary key
152 -- provided that the primary key exists and is valid and does not
153 -- already match the current g_old_rec. The function will always return
154 -- a TRUE value if the g_old_rec is populated with the current row.
155 -- A FALSE value will be returned if all of the primary key arguments
156 -- are null.
157 --
158 -- Prerequisites:
159 -- None.
160 --
161 -- In Parameters:
162 --
163 -- Post Success:
164 -- A value of TRUE will be returned indiciating that the g_old_rec
165 -- is current.
166 -- A value of FALSE will be returned if all of the primary key arguments
167 -- have a null value (this indicates that the row has not be inserted into
168 -- the Schema), and therefore could never have a corresponding row.
169 --
170 -- Post Failure:
171 -- A failure can only occur under two circumstances:
172 -- 1) The primary key is invalid (i.e. a row does not exist for the
173 -- specified primary key values).
174 -- 2) If an object_version_number exists but is NOT the same as the current
175 -- g_old_rec value.
176 --
177 -- Developer Implementation Notes:
178 -- None.
179 --
180 -- Access Status:
181 -- Internal Development Use Only.
182 --
183 -- {End Of Comments}
184 -- ----------------------------------------------------------------------------
185 Function api_updating
186 (p_organization_account_id in number
187 ,p_object_version_number in number
188 ) Return Boolean;
189 --
190 -- ----------------------------------------------------------------------------
191 -- |---------------------------------< lck >----------------------------------|
192 -- ----------------------------------------------------------------------------
193 -- {Start of comments}
194 --
195 -- Description:
196 -- The Lck process has two main functions to perform. Firstly, the row to be
197 -- updated or deleted must be locked. The locking of the row will only be
198 -- successful if the row is not currently locked by another user.
199 -- Secondly, during the locking of the row, the row is selected into
200 -- the g_old_rec data structure which enables the current row values from
201 -- the server to be available to the api.
202 --
203 -- Prerequisites:
204 -- When attempting to call the lock the object version number (if defined)
205 -- is mandatory.
206 --
207 -- In Parameters:
208 -- The arguments to the Lck process are the primary key(s) which uniquely
209 -- identify the row and the object version number of row.
210 --
211 -- Post Success:
212 -- On successful completion of the Lck process the row to be updated or
213 -- deleted will be locked and selected into the global data structure
214 -- g_old_rec.
215 --
216 -- Post Failure:
217 -- The Lck process can fail for three reasons:
218 -- 1) When attempting to lock the row the row could already be locked by
219 -- another user. This will raise the HR_Api.Object_Locked exception.
220 -- 2) The row which is required to be locked doesn't exist in the HR Schema.
221 -- This error is trapped and reported using the message name
222 -- 'HR_7220_INVALID_PRIMARY_KEY'.
223 -- 3) The row although existing in the HR Schema has a different object
224 -- version number than the object version number specified.
225 -- This error is trapped and reported using the message name
226 -- 'HR_7155_OBJECT_INVALID'.
227 --
228 -- Developer Implementation Notes:
229 -- For each primary key and the object version number arguments add a
230 -- call to hr_api.mandatory_arg_error procedure to ensure that these
231 -- argument values are not null.
232 --
233 -- Access Status:
234 -- Internal Development Use Only.
235 --
236 -- {End of comments}
237 -- ----------------------------------------------------------------------------
238 Procedure lck
239 (p_organization_account_id in number
240 ,p_object_version_number in number
241 );
242 --
243 -- ----------------------------------------------------------------------------
244 -- |-----------------------------< convert_args >-----------------------------|
245 -- ----------------------------------------------------------------------------
246 -- {Start Of Comments}
247 --
248 -- Description:
249 -- This function is used to turn attribute parameters into the record
250 -- structure parameter g_rec_type.
251 --
252 -- Prerequisites:
253 -- This is a private function and can only be called from the ins or upd
254 -- attribute processes.
255 --
256 -- In Parameters:
257 --
258 -- Post Success:
259 -- A returning record structure will be returned.
260 --
261 -- Post Failure:
262 -- No direct error handling is required within this function. Any possible
263 -- errors within this function will be a PL/SQL value error due to
264 -- conversion of datatypes or data lengths.
265 --
266 -- Developer Implementation Notes:
267 -- None.
268 --
269 -- Access Status:
270 -- Internal Row Handler Use Only.
271 --
272 -- {End Of Comments}
273 -- ----------------------------------------------------------------------------
274 Function convert_args
275 (p_organization_account_id in number
276 ,p_gl_code_combination_id in number
277 ,p_project_id in number
278 ,p_expenditure_organization_id in number
279 ,p_expenditure_type in varchar2
280 ,p_task_id in number
281 ,p_award_id in number
282 ,p_comments in varchar2
283 ,p_attribute_category in varchar2
284 ,p_attribute1 in varchar2
285 ,p_attribute2 in varchar2
289 ,p_attribute6 in varchar2
286 ,p_attribute3 in varchar2
287 ,p_attribute4 in varchar2
288 ,p_attribute5 in varchar2
290 ,p_attribute7 in varchar2
291 ,p_attribute8 in varchar2
292 ,p_attribute9 in varchar2
293 ,p_attribute10 in varchar2
294 ,p_attribute11 in varchar2
295 ,p_attribute12 in varchar2
296 ,p_attribute13 in varchar2
297 ,p_attribute14 in varchar2
298 ,p_attribute15 in varchar2
299 ,p_set_of_books_id in number
300 ,p_account_type_code in varchar2
301 ,p_start_date_active in date
302 ,p_business_group_id in number
303 ,p_end_date_active in date
304 ,p_organization_id in number
305 ,p_poeta_start_date in date
306 ,p_poeta_end_date in date
307 ,p_object_version_number in number
308 ,p_funding_source_code in varchar2
309 )
310 Return g_rec_type;
311 --
312 end psp_poa_shd;
[Home] [Help]