DBA Data[Home] [Help]

PACKAGE: APPS.GL_ARCH_PRG_FROM_PRD_PKG

Source


1 PACKAGE gl_arch_prg_from_prd_pkg AS
2 /* $Header: glfapfps.pls 120.5 2005/05/05 02:04:04 kvora ship $ */
3 --
4 -- Package
5 --   gl_arch_prg_from_period_pkg
6 -- Purpose
7 --   This package returns the From period, which is eligible
8 --   for Archive and/or Purge for a given ledger, data type
9 --   (Balances/Journals/Translated Balances), and actual flag (Actual/
10 --   Budget/Encumbrance).
11 --
12 -- History
13 --   04-16-96	U Thimmappa     Created
14 
15   --
16   -- Procedure
17   --   get_from_prd_bal_act_arch
18   -- Purpose
19   --   This procedure is used to retrieve the first non-never opened
20   --   beyond the latest archived period (if there is one). If the
21   --   closing_status of the returned row is not permanently closed or
22   --   if there is no row returned an appropriate message will be
23   --   displayed.
24   -- History
25   --   04-16-96 U Thimmappa     Created
26   -- Arguments
27   --   x_applid				Application ID
28   --   x_ledgerid			Ledger ID
29   --   x_data_type                      Data Type
30   --					   Balances
31   --					   Journals
32   --					   Translated Balances
33   --   x_actual_flag			Actual Flag -
34   --					   Actual
35   --					   Budget
36   --					   Encumbrance
37   --   x_from_period			From period
38   --   x_status			        Status
39   --   x_from_period_eff_num            From period effective number
40 
41   -- Example
42   --   gl_arch_prg_from_prd_pkg.get_from_prd_bal_act_arch
43   --				   (101, 2, data_type, actual_flag,
44   --				    from_period, closing_status,
45   --     			    x_from_period_eff_num);
46 
47   -- Notes
48   --
49 
50   PROCEDURE get_from_prd_bal_act_arch(
51 			x_appl_id 		IN NUMBER,
52 		        x_ledger_id 		IN NUMBER,
53 		 	x_data_type		IN VARCHAR2,
54 		 	x_actual_flag		IN VARCHAR2,
55 		 	x_from_period		IN OUT NOCOPY VARCHAR2,
56 		 	x_closing_status	IN OUT NOCOPY VARCHAR2,
57 			x_from_period_eff_num   IN OUT NOCOPY NUMBER
58 			);
59 
60   --
61   -- Procedure
62   --   get_from_prd_bal_act_purg
63   -- Purpose
64   --   This procedure is used to retrieve the earliest never purged period.
65   --   This period must have been archived before.
66   -- History
67   --   04-16-96 U Thimmappa     Created
68   -- Arguments
69   --   x_applid				Application ID
70   --   x_ledgerid			Ledger ID
71   --   x_data_type                      Data Type
72   --					   Balances
73   --					   Journals
74   --					   Translated Balances
75   --   x_actual_flag			Actual Flag -
76   --					   Actual
77   --					   Budget
78   --					   Encumbrance
79   --   x_from_period			From period
80   --   x_status			        Status
81   --   x_from_period_eff_num            From period effective number
82 
83   -- Example
84   --   gl_arch_prg_from_prd_pkg.get_from_prd_bal_act_purg
85   --				   (101, 2, data_type, actual_flag,
86   --				    from_period, closing_status,
87   --     			    x_from_period_eff_num);
88 
89   -- Notes
90   --
91 
92   PROCEDURE get_from_prd_bal_act_purg(
93 			x_appl_id 		IN NUMBER,
94 		        x_ledger_id 		IN NUMBER,
95 		 	x_data_type		IN VARCHAR2,
96 		 	x_actual_flag		IN VARCHAR2,
97 		 	x_from_period		IN OUT NOCOPY VARCHAR2,
98 		 	x_closing_status	IN OUT NOCOPY VARCHAR2,
99 			x_from_period_eff_num   IN OUT NOCOPY NUMBER
100 			);
101 
102   --
103   -- Procedure
104   --   get_from_prd_bal_act_both
105   -- Purpose
106   --   This procedure is used to retrieve the earliest never purged period.
107   -- History
108   --   04-16-96 U Thimmappa     Created
109   -- Arguments
110   --   x_applid				Application ID
111   --   x_ledgerid			Ledger ID
112   --   x_data_type                      Data Type
113   --					   Balances
114   --					   Journals
115   --					   Translated Balances
116   --   x_actual_flag			Actual Flag -
117   --					   Actual
118   --					   Budget
119   --					   Encumbrance
120   --   x_from_period			From period
121   --   x_status			        Status
122   --   x_from_period_eff_num            From period effective number
123 
124   -- Example
125   --   gl_arch_prg_from_prd_pkg.get_from_prd_bal_act_both
126   --				   (101, 2, data_type, actual_flag,
127   --				    from_period, closing_status,
128   --     			    x_from_period_eff_num);
129 
130   -- Notes
131   --
132 
133   PROCEDURE get_from_prd_bal_act_both(
134 			x_appl_id 		IN NUMBER,
135 		        x_ledger_id 		IN NUMBER,
136 		 	x_data_type		IN VARCHAR2,
137 		 	x_actual_flag		IN VARCHAR2,
138 		 	x_from_period		IN OUT NOCOPY VARCHAR2,
139 		 	x_closing_status	IN OUT NOCOPY VARCHAR2,
140 			x_from_period_eff_num   IN OUT NOCOPY NUMBER
141 			);
142 
143   --
144   -- Procedure
145   --   get_from_prd_bal_bud_arch
146   -- Purpose
147   --   This procedure is used to retrieve the earliest never archived period
148   --   for the chosen budget. The budget year must be open.
149   -- History
150   --   04-16-96 U Thimmappa     Created
151   -- Arguments
152   --   x_applid				Application ID
153   --   x_ledgerid			Ledger ID
154   --   x_data_type                      Data Type
155   --					   Balances
156   --					   Journals
157   --					   Translated Balances
158   --   x_actual_flag			Actual Flag -
159   --					   Actual
160   --					   Budget
161   --					   Encumbrance
162   --   x_budget_version_id              Budget version ID of the chosen budget
163   --   x_from_period			From period
164   --   x_status			        Status
165   --   x_from_period_eff_num            From period effective number
166 
167   -- Example
168   --   gl_arch_prg_from_prd_pkg.get_from_prd_bal_bud_arch
169   --				   (101, 2, data_type, actual_flag,
170   --				    x_budget_version_id, from_period, closing_status,
171   --     			    x_from_period_eff_num);
172 
173   -- Notes
174   --
175 
176   PROCEDURE get_from_prd_bal_bud_arch(
177 			x_appl_id 		IN NUMBER,
178 		        x_ledger_id 		IN NUMBER,
179 		 	x_data_type		IN VARCHAR2,
180 		 	x_actual_flag		IN VARCHAR2,
181 			x_budget_version_id     IN NUMBER,
182 		 	x_from_period		IN OUT NOCOPY VARCHAR2,
183 		 	x_closing_status	IN OUT NOCOPY VARCHAR2,
184 			x_from_period_eff_num   IN OUT NOCOPY NUMBER
185 			);
186 
187   --
188   -- Procedure
189   --   get_from_prd_bal_bud_purg
190   -- Purpose
191   --   This procedure is used to retrieve the earliest never purged period
192   --   for the chosen budget. This period must have been archived before.
193   -- History
194   --   04-16-96 U Thimmappa     Created
195   -- Arguments
196   --   x_applid				Application ID
197   --   x_ledgerid			Ledger ID
198   --   x_data_type                      Data Type
199   --					   Balances
200   --					   Journals
201   --					   Translated Balances
202   --   x_actual_flag			Actual Flag -
203   --					   Actual
204   --					   Budget
205   --					   Encumbrance
206   --   x_budget_version_id              Budget version ID of the chosen budget
207   --   x_from_period			From period
208   --   x_status			        Status
209   --   x_from_period_eff_num            From period effective number
210 
211   -- Example
212   --   gl_arch_prg_from_prd_pkg.get_from_prd_bal_bud_purg
213   --				   (101, 2, data_type, actual_flag,
214   --				    x_budget_version_id, from_period, closing_status,
215   --     			    x_from_period_eff_num);
216 
217   -- Notes
218   --
219 
220   PROCEDURE get_from_prd_bal_bud_purg(
221 			x_appl_id 		IN NUMBER,
222 		        x_ledger_id 		IN NUMBER,
223 		 	x_data_type		IN VARCHAR2,
224 		 	x_actual_flag		IN VARCHAR2,
225 			x_budget_version_id     IN NUMBER,
226 		 	x_from_period		IN OUT NOCOPY VARCHAR2,
227 		 	x_closing_status	IN OUT NOCOPY VARCHAR2,
228 			x_from_period_eff_num   IN OUT NOCOPY NUMBER
229 			);
230 
231 
232 
233   --
234   -- Procedure
235   --   get_from_prd_bal_bud_both
236   -- Purpose
237   --   This procedure is used to retrieve the earliest never purged period
238   --   for the chosen budget. This budget year must be open.
239   -- History
240   --   04-16-96 U Thimmappa     Created
241   -- Arguments
242   --   x_applid				Application ID
243   --   x_ledgerid			Ledger ID
244   --   x_data_type                      Data Type
245   --					   Balances
246   --					   Journals
247   --					   Translated Balances
248   --   x_actual_flag			Actual Flag -
249   --					   Actual
250   --					   Budget
251   --					   Encumbrance
252   --   x_budget_version_id              Budget version ID of the chosen budget
253   --   x_from_period			From period
254   --   x_status			        Status
255   --   x_from_period_eff_num            From period effective number
256 
257   -- Example
258   --   gl_arch_prg_from_prd_pkg.get_from_prd_bal_bud_both
259   --				   (101, 2, data_type, actual_flag,
260   --				    x_budget_version_id, from_period, closing_status,
261   --     			    x_from_period_eff_num);
262 
263   -- Notes
264   --
265 
266   PROCEDURE get_from_prd_bal_bud_both(
267 			x_appl_id 		IN NUMBER,
268 		        x_ledger_id 		IN NUMBER,
269 		 	x_data_type		IN VARCHAR2,
270 		 	x_actual_flag		IN VARCHAR2,
271 			x_budget_version_id     IN NUMBER,
272 		 	x_from_period		IN OUT NOCOPY VARCHAR2,
273 		 	x_closing_status	IN OUT NOCOPY VARCHAR2,
274 			x_from_period_eff_num   IN OUT NOCOPY NUMBER
275 			);
276 
277 
278 
279 
280   --
281   -- Procedure
282   --   get_to_prd_trn_both
283   -- Purpose
284   --   This procedure is used to retrieve the latest ever translated period.
285   -- History
286   --   04-16-96 U Thimmappa     Created
287   -- Arguments
288   --   x_applid				Application ID
289   --   x_ledgerid			Ledger ID
290   --   x_data_type                      Data Type
291   --					   Balances
292   --					   Journals
293   --					   Translated Balances
294   --   x_actual_flag			Actual Flag -
295   --					   Actual
296   --					   Budget
297   --					   Encumbrance
298   --   x_currency                       Foreign currency against which the
299   --                                    Translation is executed.
300   --   x_budget_version_id              Budget version ID of the chosen budget
301   --   x_to_period			From period
302   --   x_status			        Status
303   --   x_to_period_eff_num              From period effective number
304 
305   -- Example
306   --   gl_arch_prg_from_prd_pkg.get_to_prd_trn_both
307   --				   (101, 2, x_data_type, x_actual_flag, x_currency
308   --				    x_budget_version_id, x_from_period, closing_status,
309   --     			    x_from_period_eff_num);
310 
311   -- Notes
312   --
313 
317 		 	x_data_type		IN VARCHAR2,
314   PROCEDURE get_to_prd_trn_both(
315 			x_appl_id 		IN NUMBER,
316 		        x_ledger_id 		IN NUMBER,
318 		 	x_actual_flag		IN VARCHAR2,
319 			x_budget_version_id     IN NUMBER,
320 			x_currency              IN VARCHAR2,
321 		 	x_to_period  		IN OUT NOCOPY VARCHAR2,
322 		 	x_closing_status	IN OUT NOCOPY VARCHAR2,
323 			x_to_period_eff_num     IN OUT NOCOPY NUMBER
324 			);
325 
326   --
327   -- Procedure
328   --   get_to_prd_trn_standard
329   -- Purpose
330   --   This procedure is used to retrieve the latest ever translated period.
331   -- History
332   --   04-16-96 U Thimmappa     Created
333   -- Arguments
334   --   x_applid				Application ID
335   --   x_ledgerid			Ledger ID
336   --   x_data_type                      Data Type
337   --					   Balances
338   --					   Journals
339   --					   Translated Balances
340   --   x_actual_flag			Actual Flag -
341   --					   Actual
342   --					   Budget
343   --					   Encumbrance
344   --   x_currency                       Foreign currency against which the
345   --                                    Translation is executed.
346   --   x_budget_version_id              Budget version ID of the chosen budget
347   --   x_to_period			From period
348   --   x_status			        Status
349   --   x_to_period_eff_num              From period effective number
350 
351   -- Example
352   --   gl_arch_prg_from_prd_pkg.get_to_prd_trn_standard
353   --				   (101, 2, x_data_type, x_actual_flag, x_currency
354   --				    x_budget_version_id, x_from_period, closing_status,
355   --     			    x_from_period_eff_num);
356 
357   -- Notes
358   --
359 
360   PROCEDURE get_to_prd_trn_standard(
361 			x_appl_id 		IN NUMBER,
362 		        x_ledger_id 		IN NUMBER,
363 		 	x_data_type		IN VARCHAR2,
364 		 	x_actual_flag		IN VARCHAR2,
365 			x_budget_version_id     IN NUMBER,
366 			x_currency              IN VARCHAR2,
367 		 	x_to_period  		IN OUT NOCOPY VARCHAR2,
368 		 	x_closing_status	IN OUT NOCOPY VARCHAR2,
369 			x_to_period_eff_num     IN OUT NOCOPY NUMBER
370 			);
371 
372   --
373   -- Procedure
374   --   get_to_prd_trn_average
375   -- Purpose
376   --   This procedure is used to retrieve the latest ever translated period.
377   -- History
378   --   04-16-96 U Thimmappa     Created
379   -- Arguments
380   --   x_applid				Application ID
381   --   x_ledgerid			Ledger ID
385   --					   Translated Balances
382   --   x_data_type                      Data Type
383   --					   Balances
384   --					   Journals
389   --					   Encumbrance
386   --   x_actual_flag			Actual Flag -
387   --					   Actual
388   --					   Budget
390   --   x_currency                       Foreign currency against which the
391   --                                    Translation is executed.
392   --   x_budget_version_id              Budget version ID of the chosen budget
393   --   x_to_period			From period
394   --   x_status			        Status
395   --   x_to_period_eff_num              From period effective number
396 
397   -- Example
398   --   gl_arch_prg_from_prd_pkg.get_to_prd_trn_average
399   --				   (101, 2, x_data_type, x_actual_flag, x_currency
400   --				    x_budget_version_id, x_from_period, closing_status,
401   --     			    x_from_period_eff_num);
402 
403   -- Notes
404   --
405 
406   PROCEDURE get_to_prd_trn_average(
407 			x_appl_id 		IN NUMBER,
408 		        x_ledger_id 		IN NUMBER,
409 		 	x_data_type		IN VARCHAR2,
410 		 	x_actual_flag		IN VARCHAR2,
411 			x_budget_version_id     IN NUMBER,
412 			x_currency              IN VARCHAR2,
413 		 	x_to_period  		IN OUT NOCOPY VARCHAR2,
414 		 	x_closing_status	IN OUT NOCOPY VARCHAR2,
415 			x_to_period_eff_num     IN OUT NOCOPY NUMBER
416 			);
417 
418 END gl_arch_prg_from_prd_pkg;