[Home] [Help]
PACKAGE: APPS.GL_JE_BATCHES_PKG
Source
1 PACKAGE gl_je_batches_pkg AS
2 /* $Header: glijebas.pls 120.11.12000000.2 2007/07/25 17:22:15 aktelang ship $ */
3 --
4 -- Package
5 -- gl_je_batches_pkg
6 -- Purpose
7 -- To contain validation and insertion routines for gl_je_batches
8 -- History
9 -- 12-30-93 D. J. Ogg Created
10 --
11 -- Procedure
12 -- check_unique
13 -- Purpose
14 -- Checks to make sure that the name of the batch
15 -- is unique within the batch period for that ledger.
16 -- History
17 -- 12-30-93 D. J. Ogg Created
18 -- Arguments
19 -- batch_name The name of the batch
20 -- period_name The name of the batch period
21 -- coa_id The chart of accounts id of the batch
22 -- cal_name The calendar of the batch
23 -- per_type The period type of the batch
24 -- row_id The current rowid
25 -- Example
26 -- gl_je_batches_pkg.check_unique(2, 'Testing', 'JAN-90', 123,
27 -- 'Accounting', 'Month', 'ABD02334');
28 -- Notes
29 --
30 PROCEDURE check_unique(batch_name VARCHAR2,
31 period_name VARCHAR2,
32 coa_id NUMBER,
33 cal_name VARCHAR2,
34 per_type VARCHAR2,
35 row_id VARCHAR2);
36
37 --
38 -- Procedure
39 -- get_unique_id
40 -- Purpose
41 -- Gets a unique batch id
42 -- History
43 -- 12-30-93 D. J. Ogg Created
44 -- Arguments
45 -- none
46 -- Example
47 -- bid := gl_je_batches_pkg.get_unique_id;
48 -- Notes
49 --
50 FUNCTION get_unique_id RETURN NUMBER;
51
52 --
53 -- Procedure
54 -- needs_approval
55 -- Purpose
56 -- Returns true if the batch contains at least one journal that
57 -- needs approval and false otherwise.
58 -- History
59 -- 11=NOV-03 D. J. Ogg Created
60 -- Arguments
61 -- batch_id The id of the batch
62 -- Example
63 -- if (gl_je_batches_pkg.needs_approval(1002)) THEN
64 -- Notes
65 --
66 FUNCTION needs_approval(batch_id NUMBER) RETURN BOOLEAN;
67
68 --
69 -- Procedure
70 -- needs_tax
71 -- Purpose
72 -- Returns true if the batch contains at least one journal that
73 -- needs tax and false otherwise.
74 -- History
75 -- 14-APR-04 D. J. Ogg Created
76 -- Arguments
77 -- batch_id The id of the batch
78 -- Example
79 -- if (gl_je_batches_pkg.needs_tax(1002)) THEN
80 -- Notes
81 --
82 FUNCTION needs_tax(batch_id NUMBER) RETURN BOOLEAN;
83
84 --
85 -- Procedure
86 -- has_lines
87 -- Purpose
88 -- Returns true if the batch contains at least one line, and false
89 -- otherwise.
90 -- History
91 -- 01-11-94 D. J. Ogg Created
92 -- Arguments
93 -- batch_id The id of the batch
94 -- Example
95 -- if (gl_je_batches_pkg.has_lines(1002)) THEN
96 -- Notes
97 --
98 FUNCTION has_lines(batch_id NUMBER) RETURN BOOLEAN;
99
100 --
101 -- Procedure
102 -- all_stat_headers
103 -- Purpose
104 -- Returns TRUE if the batch contains only STAT journal entries,
105 -- FALSE otherwise.
106 -- History
107 -- 02-16-95 R Ng Created
108 -- Arguments
109 -- X_je_batch_id ID of journal batch
110 -- Example
111 -- gl_je_batches_pkg.all_stat_headers(:BATCHES.je_batch_id)
112 -- Notes
113 --
114 FUNCTION all_stat_headers( X_je_batch_id NUMBER ) RETURN BOOLEAN;
115
116 --
117 -- Procedure
118 -- bc_ledger
119 -- Purpose
120 -- Returns the ledger to be used for budgetary control purposes
121 -- History
122 -- 03-23-04 D J Ogg Created
123 -- Arguments
124 -- X_je_batch_id ID of journal batch
125 -- Example
126 -- lgr_id := gl_je_batches_pkg.bc_ledger(:BATCHES.je_batch_id)
127 -- Notes
128 --
129 FUNCTION bc_ledger( X_je_batch_id NUMBER ) RETURN NUMBER;
130
131 --
132 -- Procedure
133 -- populate_fields
134 -- Purpose
135 -- Gets all of the data necessary post-query
136 -- History
137 -- 27-JAN-04 D. J. Ogg Created
138 -- Arguments
139 -- x_je_batch_id Journal batch id
140 -- x_je_source_name Source Name of journals in batch
141 -- frozen_source_flag Freeze flag for journals in batch
142 -- one_of_ledgers_in_batch Ledger id of one of ledgers in the batch
143 -- reversal_flag Indicated whether this is a reversing journal
144 PROCEDURE populate_fields(x_je_batch_id NUMBER,
145 x_je_source_name IN OUT NOCOPY VARCHAR2,
146 frozen_source_flag IN OUT NOCOPY VARCHAR2,
147 one_of_ledgers_in_batch IN OUT NOCOPY NUMBER,
148 reversal_flag IN OUT NOCOPY VARCHAR2);
149
150 --
151 -- Procedure
152 -- Insert_Row
153 -- Purpose
154 -- Insert a row in gl_je_batches
155 -- History
156 -- 10-MAR-95 D. J. Ogg Created
157 -- Notes
158 --
159 PROCEDURE Insert_Row(X_Rowid IN OUT NOCOPY VARCHAR2,
160 X_Je_Batch_Id IN OUT NOCOPY NUMBER,
161 X_Name VARCHAR2,
162 X_Chart_of_Accounts_ID NUMBER,
163 X_Period_Set_Name VARCHAR2,
164 X_Accounted_Period_Type VARCHAR2,
165 X_Status VARCHAR2,
166 X_Budgetary_Control_Status VARCHAR2,
167 X_Approval_Status_Code VARCHAR2,
168 X_Status_Verified VARCHAR2,
169 X_Actual_Flag VARCHAR2,
170 X_Default_Period_Name VARCHAR2,
171 X_Default_Effective_Date DATE,
172 X_Posted_Date DATE,
173 X_Date_Created DATE,
174 X_Control_Total IN OUT NOCOPY NUMBER,
175 X_Running_Total_Dr IN OUT NOCOPY NUMBER,
176 X_Running_Total_Cr IN OUT NOCOPY NUMBER,
177 X_Running_Total_Accounted_Dr NUMBER,
178 X_Running_Total_Accounted_Cr NUMBER,
179 X_Average_Journal_Flag VARCHAR2,
180 X_Org_Id NUMBER,
181 X_Posting_Run_Id NUMBER,
182 X_Request_Id NUMBER,
183 X_Packet_Id NUMBER,
184 X_Unreservation_Packet_Id NUMBER,
185 X_Creation_Date DATE,
186 X_Created_By NUMBER,
187 X_Last_Update_Date DATE,
188 X_Last_Updated_By NUMBER,
189 X_Last_Update_Login NUMBER);
190
191
192 --
193 -- Procedure
194 -- Update_Row
195 -- Purpose
196 -- Update a row in gl_je_batches
197 -- History
198 -- 10-MAR-95 D. J. Ogg Created
199 -- Notes
200 --
201 PROCEDURE Update_Row(X_Rowid VARCHAR2,
202 X_Je_Batch_Id NUMBER,
203 X_Name VARCHAR2,
204 X_Chart_of_Accounts_ID NUMBER,
205 X_Period_Set_Name VARCHAR2,
206 X_Accounted_Period_Type VARCHAR2,
207 X_Status VARCHAR2,
208 X_Budgetary_Control_Status VARCHAR2,
209 X_Approval_Status_Code IN OUT NOCOPY VARCHAR2,
210 X_Status_Verified VARCHAR2,
211 X_Actual_Flag VARCHAR2,
212 X_Default_Period_Name VARCHAR2,
213 X_Default_Effective_Date DATE,
214 X_Posted_Date DATE,
215 X_Date_Created DATE,
216 X_Control_Total IN OUT NOCOPY NUMBER,
217 X_Running_Total_Dr IN OUT NOCOPY NUMBER,
218 X_Running_Total_Cr IN OUT NOCOPY NUMBER,
219 X_Average_Journal_Flag VARCHAR2,
220 X_Posting_Run_Id NUMBER,
221 X_Request_Id NUMBER,
222 X_Packet_Id NUMBER,
223 X_Unreservation_Packet_Id NUMBER,
224 X_Last_Update_Date DATE,
225 X_Last_Updated_By NUMBER,
226 X_Last_Update_Login NUMBER,
227 Update_Effective_Date_Flag VARCHAR2,
228 Update_Approval_Stat_Flag VARCHAR2);
229
230
231 --
232 -- Procedure
233 -- Lock_Row
234 -- Purpose
235 -- Locks a row in gl_je_batches
236 -- History
237 -- 13-JUL-94 D. J. Ogg Created
238 -- Notes
239 --
240 PROCEDURE Lock_Row(X_Rowid VARCHAR2,
241 X_Je_Batch_Id NUMBER,
242 X_Name VARCHAR2,
243 X_Chart_of_Accounts_ID NUMBER,
244 X_Period_Set_Name VARCHAR2,
245 X_Accounted_Period_Type VARCHAR2,
246 X_Status VARCHAR2,
247 X_Budgetary_Control_Status VARCHAR2,
248 X_Approval_Status_Code VARCHAR2,
249 X_Status_Verified VARCHAR2,
250 X_Actual_Flag VARCHAR2,
251 X_Default_Period_Name VARCHAR2,
252 X_Default_Effective_Date DATE,
253 X_Posted_Date DATE,
254 X_Date_Created DATE,
255 X_Control_Total NUMBER,
256 X_Running_Total_Dr NUMBER,
257 X_Running_Total_Cr NUMBER,
258 X_Average_Journal_Flag VARCHAR2,
259 X_Posting_Run_Id NUMBER,
260 X_Request_Id NUMBER,
261 X_Packet_Id NUMBER,
262 X_Unreservation_Packet_Id NUMBER,
263 X_Verify_Request_Completed VARCHAR2);
264
265
266 PROCEDURE Insert_Row(X_Rowid IN OUT NOCOPY VARCHAR2,
267
268 X_Je_Batch_Id IN OUT NOCOPY NUMBER,
269 X_Last_Update_Date DATE,
270 X_Last_Updated_By NUMBER,
271 X_Name VARCHAR2,
272 X_Chart_of_Accounts_ID NUMBER,
273 X_Period_Set_Name VARCHAR2,
274 X_Accounted_Period_Type VARCHAR2,
275 X_Status VARCHAR2,
276 X_Status_Verified VARCHAR2,
277 X_Actual_Flag VARCHAR2,
278 X_Default_Effective_Date DATE,
279 X_Creation_Date DATE,
280 X_Created_By NUMBER,
281 X_Last_Update_Login NUMBER,
282 X_Status_Reset_Flag VARCHAR2,
283 X_Default_Period_Name VARCHAR2,
284 X_Unique_Date VARCHAR2,
285 X_Earliest_Postable_Date DATE,
286 X_Posted_Date DATE,
287 X_Date_Created DATE,
288 X_Description VARCHAR2,
289 X_Control_Total NUMBER,
290 X_Running_Total_Dr NUMBER,
291 X_Running_Total_Cr NUMBER,
292 X_Running_Total_Accounted_Dr NUMBER,
293 X_Running_Total_Accounted_Cr NUMBER,
294 X_Average_Journal_Flag VARCHAR2,
295 X_Org_Id NUMBER,
296 X_Attribute1 VARCHAR2,
297 X_Attribute2 VARCHAR2,
298 X_Attribute3 VARCHAR2,
299 X_Attribute4 VARCHAR2,
300 X_Attribute5 VARCHAR2,
301 X_Attribute6 VARCHAR2,
302 X_Attribute7 VARCHAR2,
303 X_Attribute8 VARCHAR2,
304 X_Attribute9 VARCHAR2,
305 X_Attribute10 VARCHAR2,
306 X_Context VARCHAR2,
307 X_Budgetary_Control_Status VARCHAR2,
308 X_Approval_Status_Code VARCHAR2,
309 X_Posting_Run_Id NUMBER,
310 X_Request_Id NUMBER,
311 X_Packet_Id NUMBER,
312 X_Ussgl_Transaction_Code VARCHAR2,
313 X_Context2 VARCHAR2,
314 X_Unreservation_Packet_Id NUMBER,
315 X_Global_Attribute_Category VARCHAR2,
316 X_Global_Attribute1 VARCHAR2,
317 X_Global_Attribute2 VARCHAR2,
318 X_Global_Attribute3 VARCHAR2,
319 X_Global_Attribute4 VARCHAR2,
320 X_Global_Attribute5 VARCHAR2,
321 X_Global_Attribute6 VARCHAR2,
322 X_Global_Attribute7 VARCHAR2,
323 X_Global_Attribute8 VARCHAR2,
324 X_Global_Attribute9 VARCHAR2,
325 X_Global_Attribute10 VARCHAR2,
326 X_Global_Attribute11 VARCHAR2,
327 X_Global_Attribute12 VARCHAR2,
328 X_Global_Attribute13 VARCHAR2,
329 X_Global_Attribute14 VARCHAR2,
330 X_Global_Attribute15 VARCHAR2,
331 X_Global_Attribute16 VARCHAR2,
332 X_Global_Attribute17 VARCHAR2,
333 X_Global_Attribute18 VARCHAR2,
334 X_Global_Attribute19 VARCHAR2,
338 PROCEDURE Lock_Row(X_Rowid VARCHAR2,
335 X_Global_Attribute20 VARCHAR2
336 );
337
339 X_Je_Batch_Id NUMBER,
340 X_Name VARCHAR2,
341 X_Chart_of_Accounts_ID NUMBER,
342 X_Period_Set_Name VARCHAR2,
343 X_Accounted_Period_Type VARCHAR2,
344 X_Status VARCHAR2,
345 X_Status_Verified VARCHAR2,
346 X_Actual_Flag VARCHAR2,
347 X_Default_Effective_Date DATE,
348 X_Status_Reset_Flag VARCHAR2,
349 X_Default_Period_Name VARCHAR2,
350 X_Unique_Date VARCHAR2,
351 X_Earliest_Postable_Date DATE,
352 X_Posted_Date DATE,
353 X_Date_Created DATE,
354 X_Description VARCHAR2,
355 X_Control_Total NUMBER,
356 X_Running_Total_Dr NUMBER,
357 X_Running_Total_Cr NUMBER,
358 X_Running_Total_Accounted_Dr NUMBER,
359 X_Running_Total_Accounted_Cr NUMBER,
360 X_Average_Journal_Flag VARCHAR2,
361 X_Attribute1 VARCHAR2,
362 X_Attribute2 VARCHAR2,
363 X_Attribute3 VARCHAR2,
364 X_Attribute4 VARCHAR2,
365 X_Attribute5 VARCHAR2,
366 X_Attribute6 VARCHAR2,
367 X_Attribute7 VARCHAR2,
368 X_Attribute8 VARCHAR2,
369 X_Attribute9 VARCHAR2,
370 X_Attribute10 VARCHAR2,
371 X_Context VARCHAR2,
372 X_Budgetary_Control_Status VARCHAR2,
373 X_Approval_Status_Code VARCHAR2,
374 X_Posting_Run_Id NUMBER,
375 X_Request_Id NUMBER,
376 X_Packet_Id NUMBER,
377 X_Ussgl_Transaction_Code VARCHAR2,
378 X_Context2 VARCHAR2,
379 X_Unreservation_Packet_Id NUMBER,
380 X_Verify_Request_Completed VARCHAR2,
381 X_Global_Attribute_Category VARCHAR2,
382 X_Global_Attribute1 VARCHAR2,
383 X_Global_Attribute2 VARCHAR2,
384 X_Global_Attribute3 VARCHAR2,
385 X_Global_Attribute4 VARCHAR2,
386 X_Global_Attribute5 VARCHAR2,
387 X_Global_Attribute6 VARCHAR2,
388 X_Global_Attribute7 VARCHAR2,
389 X_Global_Attribute8 VARCHAR2,
390 X_Global_Attribute9 VARCHAR2,
391 X_Global_Attribute10 VARCHAR2,
392 X_Global_Attribute11 VARCHAR2,
393 X_Global_Attribute12 VARCHAR2,
394 X_Global_Attribute13 VARCHAR2,
395 X_Global_Attribute14 VARCHAR2,
396 X_Global_Attribute15 VARCHAR2,
397 X_Global_Attribute16 VARCHAR2,
398 X_Global_Attribute17 VARCHAR2,
399 X_Global_Attribute18 VARCHAR2,
400 X_Global_Attribute19 VARCHAR2,
401 X_Global_Attribute20 VARCHAR2
402 );
403
404 PROCEDURE Update_Row(X_Rowid VARCHAR2,
405 X_Je_Batch_Id NUMBER,
406 X_Last_Update_Date DATE,
407 X_Last_Updated_By NUMBER,
408 X_Name VARCHAR2,
409 X_Chart_of_Accounts_ID NUMBER,
410 X_Period_Set_Name VARCHAR2,
411 X_Accounted_Period_Type VARCHAR2,
412 X_Status VARCHAR2,
413 X_Status_Verified VARCHAR2,
414 X_Actual_Flag VARCHAR2,
415 X_Default_Effective_Date DATE,
416 X_Last_Update_Login NUMBER,
417 X_Status_Reset_Flag VARCHAR2,
421 X_Posted_Date DATE,
418 X_Default_Period_Name VARCHAR2,
419 X_Unique_Date VARCHAR2,
420 X_Earliest_Postable_Date DATE,
422 X_Date_Created DATE,
423 X_Description VARCHAR2,
424 X_Control_Total NUMBER,
425 X_Running_Total_Dr NUMBER,
426 X_Running_Total_Cr NUMBER,
427 X_Running_Total_Accounted_Dr NUMBER,
428 X_Running_Total_Accounted_Cr NUMBER,
429 X_Average_Journal_Flag VARCHAR2,
430 X_Attribute1 VARCHAR2,
431 X_Attribute2 VARCHAR2,
432 X_Attribute3 VARCHAR2,
433 X_Attribute4 VARCHAR2,
434 X_Attribute5 VARCHAR2,
435 X_Attribute6 VARCHAR2,
436 X_Attribute7 VARCHAR2,
437 X_Attribute8 VARCHAR2,
438 X_Attribute9 VARCHAR2,
439 X_Attribute10 VARCHAR2,
440 X_Context VARCHAR2,
441 X_Budgetary_Control_Status VARCHAR2,
442 X_Approval_Status_Code IN OUT NOCOPY VARCHAR2,
443 X_Posting_Run_Id NUMBER,
444 X_Request_Id NUMBER,
445 X_Packet_Id NUMBER,
446 X_Ussgl_Transaction_Code VARCHAR2,
447 X_Context2 VARCHAR2,
448 X_Unreservation_Packet_Id NUMBER,
449 Update_Effective_Date_Flag VARCHAR2,
450 Update_Approval_Stat_Flag VARCHAR2,
451 X_Global_Attribute_Category VARCHAR2,
452 X_Global_Attribute1 VARCHAR2,
453 X_Global_Attribute2 VARCHAR2,
454 X_Global_Attribute3 VARCHAR2,
455 X_Global_Attribute4 VARCHAR2,
456 X_Global_Attribute5 VARCHAR2,
457 X_Global_Attribute6 VARCHAR2,
458 X_Global_Attribute7 VARCHAR2,
459 X_Global_Attribute8 VARCHAR2,
460 X_Global_Attribute9 VARCHAR2,
461 X_Global_Attribute10 VARCHAR2,
462 X_Global_Attribute11 VARCHAR2,
463 X_Global_Attribute12 VARCHAR2,
464 X_Global_Attribute13 VARCHAR2,
465 X_Global_Attribute14 VARCHAR2,
466 X_Global_Attribute15 VARCHAR2,
467 X_Global_Attribute16 VARCHAR2,
468 X_Global_Attribute17 VARCHAR2,
469 X_Global_Attribute18 VARCHAR2,
470 X_Global_Attribute19 VARCHAR2,
471 X_Global_Attribute20 VARCHAR2
472 );
473
474 -- This exception occurs when you try to delete
475 -- a batch for which funds are currently being
476 -- reserved.
477 GL_MJE_RESERVING_FUNDS EXCEPTION;
478
479 -- This exception occurs when you try to delete
480 -- a batch for which funds have been reserved
481 GL_MJE_RESERVED_FUNDS EXCEPTION;
482
483 -- This exception occurs when you try to delete
484 -- a batch that is currently being approved.
485 GL_MJE_APPROVING EXCEPTION;
486
487 -- This exception occurs when you try to delete
488 -- a batch that has been posted.
489 GL_MJE_POSTED EXCEPTION;
490
491 -- This exception occurs when you try to delete
492 -- a batch that is in the process of being
493 -- posted.
494 GL_MJE_POSTING EXCEPTION;
495
498 END gl_je_batches_pkg;
496 PROCEDURE Delete_Row(X_Rowid VARCHAR2, Je_Batch_Id NUMBER);
497