[Home] [Help]
PACKAGE: APPS.GL_ALLOC_FORM_LINES_PKG
Source
1 PACKAGE GL_ALLOC_FORM_LINES_PKG AS
2 /* $Header: glimafls.pls 120.5 2003/07/03 01:43:20 ticheng ship $ */
3 --
4 -- Package
5 -- gl_alloc_formula_lines_pkg
6 -- Purpose
7 -- To contain validation and insertion routines for gl_alloc_formula_lines
8 -- History
9 -- 11-11-93 D. J. Ogg Created
10
11 --
12 -- Procedure
13 -- complete_formula
14 -- Purpose
15 -- Checks to make sure that the formula contains all necessary lines.
16 -- History
17 -- 11-12-93 D. J. Ogg Created
18 -- Arguments
19 -- formula_id The ID of the formula
20 -- actual_flag The balance type of the formula
21 -- Example
22 -- gl_alloc_form_lines_pkg.complete_formula(123, 'A');
23 -- Notes
24 --
25 FUNCTION complete_formula(formula_id NUMBER,
26 actual_flag VARCHAR2) RETURN BOOLEAN;
27
28 --
29 -- Procedure
30 -- delete_rows
31 -- Purpose
32 -- Deletes all of the lines in a formula
33 -- History
34 -- 09-JUN-94 D. J. Ogg Created
35 -- Arguments
36 -- formula_id The ID of the formula to delete
37 -- Example
38 -- gl_alloc_form_lines_pkg.delete_rows(5);
39 -- Notes
40 --
41 PROCEDURE delete_rows(formula_id NUMBER);
42
43 --
44 -- Procedure
45 -- delete_batch
46 -- Purpose
47 -- Deletes all of the lines in a batch
48 -- History
49 -- 09-JUN-94 D. J. Ogg Created
50 -- Arguments
51 -- formula_id The ID of the batch to delete
52 -- Example
53 -- gl_alloc_form_lines_pkg.delete_batch(5);
54 -- Notes
55 --
56 PROCEDURE delete_batch(batch_id NUMBER);
57
58 -- Procedure
59 -- validate_ledger_action
60 -- Purpose
61 -- Make sure that the action code is Constant for a ledger, and
62 -- Looping (default) or Summing for a ledger set.
63 -- History
64 -- 04-APR-02 T Cheng Created
65 -- Arguments
66 -- x_object_type_code The object type of the ledger selected
67 -- x_segment_types_key_full The first element of it is the ledger action
68 -- Example
69 -- gl_alloc_form_lines_pkg.validate_ledger_action('L', 'C-C-L-C');
70 -- Notes
71 --
72 PROCEDURE validate_ledger_action(x_object_type_code VARCHAR2,
73 x_segment_types_key_full VARCHAR2);
74
75 --
76 -- Procedure
77 -- check_target_ledger
78 -- Purpose
79 -- For MassBudget and MassEncumbrance: if the transaction currency has
80 -- changed, use this procedure to check target/offset line ledger.
81 -- History
82 -- 24-MAR-03 T Cheng Created
83 -- Arguments
84 -- x_allocation_formula_id The allocation formula id
85 -- Example
86 -- gl_alloc_form_lines_pkg.check_target_ledger(1234);
87 -- Notes
88 --
89 PROCEDURE check_target_ledger(x_allocation_formula_id NUMBER);
90
91 --
92 -- Procedure
93 -- check_target_ledger_currency
94 -- Purpose
95 -- Called when balance type is Budget or Encumbrance. Check if the primary
96 -- currency of the ledger or common primary currency of the ledger set
97 -- is the same as the selected ledger currency.
98 -- History
99 -- 18-APR-02 T Cheng Created
100 -- Arguments
101 -- x_ledger_id The ledger id. Can be a ledger or a ledger set.
102 -- x_ledger_currency The selected ledger currency
103 -- Example
104 -- gl_alloc_form_lines_pkg.check_target_ledger_currency(10, 'USD', 'E');
105 -- Notes
106 -- Also called by the form directly.
107 --
108 PROCEDURE check_target_ledger_currency(x_ledger_id NUMBER,
109 x_ledger_currency VARCHAR2,
110 x_actual_flag VARCHAR2);
111
112 --
113 -- Procedure
114 -- update_currency
115 -- Purpose
116 -- Updates the currency and transaction currency of all of the
117 -- lines in a formula.
118 -- History
119 -- 16-JUN-94 D. J. Ogg Created
120 -- Arguments
121 -- formula_id The ID of the formula to update
122 -- transaction_currency The new transaction currency
123 -- conversion_method The conversion method
124 -- Example
125 -- gl_alloc_form_lines_pkg.update_currency(5, 'USD', 'CA');
126 -- Notes
127 --
128 PROCEDURE update_currency(formula_id NUMBER,
129 transaction_currency VARCHAR2,
130 conversion_method VARCHAR2);
131
132 --
133 -- Procedure
134 -- currency_changed
135 -- Purpose
136 -- Returns TRUE if the formula currency differs from the
137 -- currency provided. Returns FALSE otherwise.
138 -- History
139 -- 17-JUN-94 D. J. Ogg Created
140 -- Arguments
141 -- formula_id The ID of the formula to check
142 -- transaction_currency The transaction currency to verify against
143 -- Example
144 -- IF(gl_alloc_form_lines_pkg.currency_changed(5, 'CND')) THEN
145 -- Notes
146 --
147 FUNCTION currency_changed(formula_id NUMBER,
148 transaction_currency VARCHAR2) RETURN BOOLEAN;
149
150 PROCEDURE Insert_Row(X_Rowid IN OUT NOCOPY VARCHAR2,
151 X_Allocation_Formula_Id IN OUT NOCOPY NUMBER,
152 X_Line_Number NUMBER,
153 X_Line_Type VARCHAR2,
154 X_Operator VARCHAR2,
155 X_Last_Update_Date DATE,
156 X_Last_Updated_By NUMBER,
157 X_Creation_Date DATE,
158 X_Created_By NUMBER,
159 X_Last_Update_Login NUMBER,
160 X_Amount NUMBER,
161 X_Relative_Period VARCHAR2,
162 X_Period_Name VARCHAR2,
163 X_Transaction_Currency VARCHAR2,
164 X_Ledger_Currency VARCHAR2,
165 X_Currency_Type VARCHAR2,
166 X_Entered_Currency VARCHAR2,
167 X_Actual_Flag VARCHAR2,
168 X_Budget_Version_Id NUMBER,
169 X_Encumbrance_Type_Id NUMBER,
170 X_Amount_Type VARCHAR2,
171 X_Ledger_Id NUMBER,
172 X_Segment_Types_Key_Full VARCHAR2,
173 X_Segment_Break_Key VARCHAR2,
174 X_Segment1 VARCHAR2,
175 X_Segment2 VARCHAR2,
176 X_Segment3 VARCHAR2,
177 X_Segment4 VARCHAR2,
178 X_Segment5 VARCHAR2,
179 X_Segment6 VARCHAR2,
180 X_Segment7 VARCHAR2,
181 X_Segment8 VARCHAR2,
182 X_Segment9 VARCHAR2,
183 X_Segment10 VARCHAR2,
184 X_Segment11 VARCHAR2,
185 X_Segment12 VARCHAR2,
186 X_Segment13 VARCHAR2,
187 X_Segment14 VARCHAR2,
188 X_Segment15 VARCHAR2,
189 X_Segment16 VARCHAR2,
190 X_Segment17 VARCHAR2,
191 X_Segment18 VARCHAR2,
192 X_Segment19 VARCHAR2,
193 X_Segment20 VARCHAR2,
194 X_Segment21 VARCHAR2,
195 X_Segment22 VARCHAR2,
196 X_Segment23 VARCHAR2,
197 X_Segment24 VARCHAR2,
198 X_Segment25 VARCHAR2,
199 X_Segment26 VARCHAR2,
200 X_Segment27 VARCHAR2,
201 X_Segment28 VARCHAR2,
202 X_Segment29 VARCHAR2,
203 X_Segment30 VARCHAR2
204 );
205
206 PROCEDURE Lock_Row(X_Rowid VARCHAR2,
207 X_Allocation_Formula_Id NUMBER,
208 X_Line_Number NUMBER,
209 X_Line_Type VARCHAR2,
210 X_Operator VARCHAR2,
211 X_Amount NUMBER,
212 X_Relative_Period VARCHAR2,
213 X_Period_Name VARCHAR2,
214 X_Transaction_Currency VARCHAR2,
215 X_Ledger_Currency VARCHAR2,
216 X_Currency_Type VARCHAR2,
217 X_Entered_Currency VARCHAR2,
218 X_Actual_Flag VARCHAR2,
219 X_Budget_Version_Id NUMBER,
220 X_Encumbrance_Type_Id NUMBER,
221 X_Amount_Type VARCHAR2,
222 X_Ledger_Id NUMBER,
223 X_Segment_Types_Key_Full VARCHAR2,
224 X_Segment_Break_Key VARCHAR2,
225 X_Segment1 VARCHAR2,
226 X_Segment2 VARCHAR2,
227 X_Segment3 VARCHAR2,
228 X_Segment4 VARCHAR2,
229 X_Segment5 VARCHAR2,
230 X_Segment6 VARCHAR2,
231 X_Segment7 VARCHAR2,
232 X_Segment8 VARCHAR2,
233 X_Segment9 VARCHAR2,
234 X_Segment10 VARCHAR2,
235 X_Segment11 VARCHAR2,
236 X_Segment12 VARCHAR2,
237 X_Segment13 VARCHAR2,
238 X_Segment14 VARCHAR2,
239 X_Segment15 VARCHAR2,
240 X_Segment16 VARCHAR2,
241 X_Segment17 VARCHAR2,
242 X_Segment18 VARCHAR2,
243 X_Segment19 VARCHAR2,
244 X_Segment20 VARCHAR2,
245 X_Segment21 VARCHAR2,
246 X_Segment22 VARCHAR2,
247 X_Segment23 VARCHAR2,
248 X_Segment24 VARCHAR2,
249 X_Segment25 VARCHAR2,
250 X_Segment26 VARCHAR2,
251 X_Segment27 VARCHAR2,
252 X_Segment28 VARCHAR2,
253 X_Segment29 VARCHAR2,
254 X_Segment30 VARCHAR2
255 );
256
257 PROCEDURE Update_Row(X_Rowid VARCHAR2,
258 X_Allocation_Formula_Id NUMBER,
259 X_Line_Number NUMBER,
260 X_Line_Type VARCHAR2,
261 X_Operator VARCHAR2,
262 X_Last_Update_Date DATE,
263 X_Last_Updated_By NUMBER,
264 X_Last_Update_Login NUMBER,
265 X_Amount NUMBER,
266 X_Relative_Period VARCHAR2,
267 X_Period_Name VARCHAR2,
268 X_Transaction_Currency VARCHAR2,
269 X_Ledger_Currency VARCHAR2,
270 X_Currency_Type VARCHAR2,
271 X_Entered_Currency VARCHAR2,
272 X_Actual_Flag VARCHAR2,
273 X_Budget_Version_Id NUMBER,
274 X_Encumbrance_Type_Id NUMBER,
275 X_Amount_Type VARCHAR2,
276 X_Ledger_Id NUMBER,
277 X_Segment_Types_Key_Full VARCHAR2,
278 X_Segment_Break_Key VARCHAR2,
279 X_Segment1 VARCHAR2,
280 X_Segment2 VARCHAR2,
281 X_Segment3 VARCHAR2,
282 X_Segment4 VARCHAR2,
283 X_Segment5 VARCHAR2,
284 X_Segment6 VARCHAR2,
285 X_Segment7 VARCHAR2,
286 X_Segment8 VARCHAR2,
287 X_Segment9 VARCHAR2,
288 X_Segment10 VARCHAR2,
289 X_Segment11 VARCHAR2,
290 X_Segment12 VARCHAR2,
291 X_Segment13 VARCHAR2,
292 X_Segment14 VARCHAR2,
293 X_Segment15 VARCHAR2,
294 X_Segment16 VARCHAR2,
295 X_Segment17 VARCHAR2,
296 X_Segment18 VARCHAR2,
297 X_Segment19 VARCHAR2,
298 X_Segment20 VARCHAR2,
299 X_Segment21 VARCHAR2,
300 X_Segment22 VARCHAR2,
301 X_Segment23 VARCHAR2,
302 X_Segment24 VARCHAR2,
303 X_Segment25 VARCHAR2,
304 X_Segment26 VARCHAR2,
305 X_Segment27 VARCHAR2,
306 X_Segment28 VARCHAR2,
307 X_Segment29 VARCHAR2,
308 X_Segment30 VARCHAR2
309 );
310
311 PROCEDURE Delete_Row(X_Rowid VARCHAR2);
312
313 END GL_ALLOC_FORM_LINES_PKG;