1 PACKAGE GL_LEDGER_UTILS_PKG AUTHID CURRENT_USER AS
2 /* $Header: gluldgus.pls 120.2 2005/01/05 18:07:02 djogg noship $ */
3 --
4 -- Package
5 -- GL_LEDGER_UTILS_PKG
6 -- Purpose
7 -- To create GL_LEDGER_UTILS_PKG package.
8 -- History
9 -- 05/20/01 T Cheng Created.
10 --
11
12 -- *********************************************************************
13 -- The following procedures are designed to handle the ledger segment
14 -- in the mirror chart of accounts, or can also be used in general to
15 -- convert between ledger short name and ledger id/currency.
16
17 --
18 -- Procedure
19 -- Find_Ledger
20 -- Purpose
21 -- Find the ledger by short name.
22 -- History
23 -- 02/20/03 T Cheng Created
24 -- Arguments
25 -- X_Ledger_Short_Name ledger short name (unique)
26 -- X_Ledger_Id ledger id
27 -- X_Ledger_Currency ledger currency, NULL for ledger sets
28 -- X_Translated_Flag whether it is a translated ALC (Y/N)
29 -- Example
30 -- gl_ledger_utils_pkg.Find_Ledger('Vision Operations',
31 -- ldg_id, ldg_cur, flag);
32 -- Notes
33 -- For ledger sets, X_Ledger_Currency will be null.
34 --
35 PROCEDURE Find_Ledger(X_Ledger_Short_Name VARCHAR2,
36 X_Ledger_Id OUT NOCOPY NUMBER,
37 X_Ledger_Currency OUT NOCOPY VARCHAR2,
38 X_Translated_Flag OUT NOCOPY VARCHAR2);
39
40 --
41 -- Procedure
42 -- Find_Ledger_Short_Name
43 -- Purpose
44 -- Find the ledger short name by id and currency.
45 -- History
46 -- 02/27/03 T Cheng Created
47 -- Arguments
48 -- X_Ledger_Id ledger id
49 -- X_Ledger_Currency ledger currency, ignored if ledger sets
50 -- X_Ledger_Short_Name ledger short name
51 -- X_Translated_Flag whether it is a translated ALC (Y/N)
52 -- Example
53 -- gl_ledger_utils_pkg.Find_Ledger_Short_Name(1, 'USD', short_name, flag);
54 -- Notes
55 -- X_Ledger_Currency is ignored if it is a ledger set.
56 -- For a ledger id that corresponds to a single ledger, if no ledger
57 -- currency is passed in, the short name of the "base" ledger is returned.
58 --
59 PROCEDURE Find_Ledger_Short_Name(X_Ledger_Id NUMBER,
60 X_Ledger_Currency VARCHAR2,
61 X_Ledger_Short_Name OUT NOCOPY VARCHAR2,
62 X_Translated_Flag OUT NOCOPY VARCHAR2);
63
64 -- *********************************************************************
65 -- The following functions are designed to get default values for
66 -- report parameters.
67
68 --
69 -- Function
70 -- Get_Ledger_Id_Of_Short_Name
71 -- Purpose
72 -- Given a ledger short name, returns the ledger id.
73 -- History
74 -- 05/20/03 T Cheng Created
75 -- Arguments
76 -- X_Ledger_Short_Name ledger short name
77 -- Example
78 -- ledger_id := gl_ledger_utils_pkg.Get_Ledger_Id_Of_Short_Name('LSN');
79 -- Notes
80 --
81 FUNCTION Get_Ledger_Id_Of_Short_Name(X_Ledger_Short_Name VARCHAR2)
82 RETURN NUMBER;
83
84 --
85 -- Function
86 -- Get_Default_Ledger_Currency
87 -- Purpose
88 -- If the ledger parameter is a single ledger (ledger, MRC ALC or
89 -- translated ALC), return the ledger's currency. If it is a ledger set,
90 -- return the currency of the default ledger if there is one, otherwise
91 -- NULL.
92 -- History
93 -- 05/20/03 T Cheng Created
94 -- Arguments
95 -- X_Ledger_Short_Name ledger short name
96 -- Example
97 -- curr := gl_ledger_utils_pkg.Get_Default_Ledger_Currency('LSN');
98 -- Notes
99 --
100 FUNCTION Get_Default_Ledger_Currency(X_Ledger_Short_Name VARCHAR2)
101 RETURN VARCHAR2;
102
103 -- *********************************************************************
104
105 --
106 -- Procedure
107 -- Get_First_Ledger_Id_From_Set
108 -- Purpose
109 -- Get the first ledger id from a ledger set. This ledger id will be
110 -- used to get the first period name for all ledgers in this ledger set.
111 -- The first period name will then be used to calculate the YTD amount.
112 -- History
113 -- 06/02/03 K. Yung Created
114 -- Arguments
115 -- X_Ledger_set_id ledger set id
116 -- X_ledger_currency ledger currency
117 -- X_ledger_id returned first ledger id found in the ledger set
118 -- X_errbuf returned error message
119 -- Example
120 -- gl_ledger_utils_pkg.Get_First_Ledger_Id_From_Set(1394, 'USD', ledger_id,
121 -- errbuf);
122 -- Notes
123 --
124 procedure Get_First_Ledger_Id_From_Set(
125 X_Ledger_Set_Id IN number,
126 X_Ledger_Currency IN VARCHAR2,
127 X_Ledger_Id OUT NOCOPY number,
128 X_Errbuf OUT NOCOPY varchar2);
129
130 -- *********************************************************************
131
132
133 END GL_LEDGER_UTILS_PKG;
[Home] [Help]