1 PACKAGE GL_FORMSINFO AS
2 /* $Header: gligcfis.pls 120.14 2005/07/29 16:58:35 djogg ship $ */
3
4 -- Constants for levels of access
5 FULL_ACCESS CONSTANT VARCHAR2(1) := 'F';
6 WRITE_ACCESS CONSTANT VARCHAR2(1) := 'B';
7 READ_ACCESS CONSTANT VARCHAR2(1) := 'R';
8 NO_ACCESS CONSTANT VARCHAR2(1) := 'N';
9
10 -- NAME
11 -- get_coa_info
12 -- DESCRIPTION
13 -- Gets various chart of accounts attributes based on
14 -- the coa id provided.
15 -- PARAMETERS
16 PROCEDURE get_coa_info (x_chart_of_accounts_id IN NUMBER,
17 x_segment_delimiter IN OUT NOCOPY VARCHAR2,
18 x_enabled_segment_count IN OUT NOCOPY NUMBER,
19 x_segment_order_by IN OUT NOCOPY VARCHAR2,
20 x_accseg_segment_num IN OUT NOCOPY NUMBER,
21 x_accseg_app_col_name IN OUT NOCOPY VARCHAR2,
22 x_accseg_left_prompt IN OUT NOCOPY VARCHAR2,
23 x_balseg_segment_num IN OUT NOCOPY NUMBER,
24 x_balseg_app_col_name IN OUT NOCOPY VARCHAR2,
25 x_balseg_left_prompt IN OUT NOCOPY VARCHAR2,
26 x_mgtseg_segment_num IN OUT NOCOPY NUMBER,
27 x_mgtseg_app_col_name IN OUT NOCOPY VARCHAR2,
28 x_mgtseg_left_prompt IN OUT NOCOPY VARCHAR2,
29 x_ieaseg_segment_num IN OUT NOCOPY NUMBER,
30 x_ieaseg_app_col_name IN OUT NOCOPY VARCHAR2,
31 x_ieaseg_left_prompt IN OUT NOCOPY VARCHAR2);
32
33 -- NAME
34 -- get_access_info
35 -- DESCRIPTION
36 -- Gets chart_of_accounts_id, calendar name and period type
37 -- information with the given access set ID.
38 -- PARAMETERS
39 PROCEDURE get_access_info (x_access_set_id IN NUMBER,
40 x_name IN OUT NOCOPY VARCHAR2,
41 x_enabled_flag IN OUT NOCOPY VARCHAR2,
42 x_security_segment_code IN OUT NOCOPY VARCHAR2,
43 x_chart_of_accounts_id IN OUT NOCOPY NUMBER,
44 x_period_set_name IN OUT NOCOPY VARCHAR2,
45 x_accounted_period_type IN OUT NOCOPY VARCHAR2,
46 x_automatically_created_flag IN OUT NOCOPY VARCHAR2 );
47
48
49 -- NAME
50 -- check_access
51 -- DESCRIPTION
52 -- Returns the level of access to the given ledger and security segment
53 -- value for the specified access set and date. If the security segment
54 -- value is null, just checks the access to the ledger. If the date is
55 -- null, doesn't check the date
56 -- PARAMETERS
57 FUNCTION check_access ( X_access_set_id IN NUMBER,
58 X_ledger_id IN NUMBER,
59 X_segment_value IN VARCHAR2,
60 X_edate IN DATE) RETURN VARCHAR2;
61 -- NAME
62 -- get_ledger_type
63 -- DESCRIPTION
64 -- Returns the type of ledger of the given ledger ID.
65 -- PARAMETERS
66 FUNCTION get_ledger_type ( X_ledger_id IN NUMBER ) RETURN VARCHAR2;
67
68 -- NAME
69 -- get_default_ledger
70 -- DESCRIPTION
71 -- If the current access set is associated with only a single ledger
72 -- with the given access privilege code (or greater) and date,
73 -- returns the id of this ledger. Otherwise, returns a -1.
74 -- If no date is provided, the date is ignored.
75 -- PARAMETERS
76 FUNCTION get_default_ledger ( X_access_set_id IN NUMBER,
77 X_access_privilege_code IN VARCHAR2,
78 X_edate IN DATE ) RETURN NUMBER;
79
80 -- NAME
81 -- has_single_ledger
82 -- DESCRIPTION
83 -- If the given access set is associated with only a single ledger
84 -- returns the id of this ledger. Otherwise, returns a -1.
85 -- PARAMETERS
86 FUNCTION has_single_ledger ( X_access_set_id IN NUMBER) RETURN BOOLEAN;
87
88 -- NAME
89 -- write_any_ledger
90 -- DESCRIPTION
91 -- If the given access set contains any ledger where we have write or
92 -- full access to, this function will return TRUE.
93 -- Otherwise, it'll return FALSE.
94 -- PARAMETERS
95 FUNCTION write_any_ledger ( X_access_set_id IN NUMBER ) RETURN BOOLEAN;
96
97 -- NAME
98 -- get_ledger_info
99 -- DESCRIPTION
100 -- Gets various ledgers attributes based on the ledger id provided.
101 -- PARAMETERS
102 PROCEDURE get_ledger_info (
103 X_ledger_id IN NUMBER,
104 X_name IN OUT NOCOPY VARCHAR2,
105 X_short_name IN OUT NOCOPY VARCHAR2,
106 X_chart_of_accounts_id IN OUT NOCOPY NUMBER,
107 X_currency_code IN OUT NOCOPY VARCHAR2,
108 X_period_set_name IN OUT NOCOPY VARCHAR2,
109 X_accounted_period_type IN OUT NOCOPY VARCHAR2,
110 X_ret_earn_ccid IN OUT NOCOPY NUMBER,
111 X_suspense_allowed_flag IN OUT NOCOPY VARCHAR2,
112 X_allow_intercompany_post_flag IN OUT NOCOPY VARCHAR2,
113 X_enable_average_balances_flag IN OUT NOCOPY VARCHAR2,
114 X_enable_bc_flag IN OUT NOCOPY VARCHAR2,
115 X_require_budget_journals_flag IN OUT NOCOPY VARCHAR2,
116 X_enable_je_approval_flag IN OUT NOCOPY VARCHAR2,
117 X_enable_automatic_tax_flag IN OUT NOCOPY VARCHAR2,
118 X_consolidation_ledger_flag IN OUT NOCOPY VARCHAR2,
119 X_translate_eod_flag IN OUT NOCOPY VARCHAR2,
120 X_translate_qatd_flag IN OUT NOCOPY VARCHAR2,
121 X_translate_yatd_flag IN OUT NOCOPY VARCHAR2,
122 X_automatically_created_flag IN OUT NOCOPY VARCHAR2,
123 X_track_rnd_imbalance_flag IN OUT NOCOPY VARCHAR2,
124 X_alc_ledger_type_code IN OUT NOCOPY VARCHAR2,
125 X_reconciliation_flag IN OUT NOCOPY VARCHAR2,
126 X_object_type_code IN OUT NOCOPY VARCHAR2,
127 X_le_ledger_type_code IN OUT NOCOPY VARCHAR2,
128 X_bal_seg_value_option_code IN OUT NOCOPY VARCHAR2,
129 X_bal_seg_column_name IN OUT NOCOPY VARCHAR2,
130 X_mgt_seg_value_option_code IN OUT NOCOPY VARCHAR2,
131 X_mgt_seg_column_name IN OUT NOCOPY VARCHAR2,
132 X_description IN OUT NOCOPY VARCHAR2,
133 X_latest_opened_period_name IN OUT NOCOPY VARCHAR2,
134 X_latest_encumbrance_year IN OUT NOCOPY NUMBER,
135 X_future_enterable_periods IN OUT NOCOPY NUMBER,
136 X_cum_trans_ccid IN OUT NOCOPY NUMBER,
137 X_res_encumb_ccid IN OUT NOCOPY NUMBER,
138 X_net_income_ccid IN OUT NOCOPY NUMBER,
139 X_rounding_ccid IN OUT NOCOPY NUMBER,
140 X_transaction_calendar_id IN OUT NOCOPY NUMBER,
141 X_daily_translation_rate_type IN OUT NOCOPY VARCHAR2,
142 X_legal_entity_id IN OUT NOCOPY NUMBER,
143 X_period_average_rate_type IN OUT NOCOPY VARCHAR2,
144 X_period_end_rate_type IN OUT NOCOPY VARCHAR2,
145 X_ledger_category_code IN OUT NOCOPY VARCHAR2);
146
150 -- Returns if the provided balancing segment value is valid for the given
147 -- NAME
148 -- valid_bsv
149 -- DESCRIPTION
151 -- ledger and date.
152 -- If no date is provided, the date is ignored.
153 -- PARAMETERS
154 FUNCTION valid_bsv ( X_ledger_id IN NUMBER,
155 X_bsv IN VARCHAR2,
156 X_edate IN DATE) RETURN VARCHAR2;
157
158
159 -- NAME
160 -- valid_msv
161 -- DESCRIPTION
165 -- PARAMETERS
162 -- Returns if the provided management segment value is valid for the given
163 -- ledger and date.
164 -- If no date is provided, the date is ignored.
166 FUNCTION valid_msv ( X_ledger_id IN NUMBER,
167 X_msv IN VARCHAR2,
168 X_edate IN DATE) RETURN VARCHAR2;
169
170 -- NAME
171 -- multi_org
172 -- DESCRIPTION
173 -- Returns TRUE if this is a multi-org environment and false otherwise
174 -- PARAMETERS
175 FUNCTION multi_org RETURN BOOLEAN;
176
177 -- NAME
178 -- install_info
179 -- DESCRIPTION
180 -- Just calls fnd_installation.get to workaround a forms bug
181 -- PARAMETERS
182 FUNCTION install_info(appl_id IN NUMBER,
183 dep_appl_id IN NUMBER,
184 status OUT NOCOPY VARCHAR2) RETURN BOOLEAN;
185
186 --
187 -- Procedure
188 -- get_iea_info
189 -- Purpose
190 -- Used to select all of the information about a subsidiary
191 -- History
192 -- 01-16-97 D. J. Ogg Created
193 -- 11-12-98 S Kung Added parameters for data model changes.
194 -- Arguments
195 -- x_subsidiary_id ID of subsidiary to get information
196 -- about
197 -- x_name Name of subsidiary
198 -- x_chart_of_accounts_id ID of chart of accounts used by
199 -- subsidiary
200 -- x_ledger_id ID of ledger used by subsidiary
201 -- x_enabled_flag Enabled flag of subsidiary
202 -- x_subsidiary_type_code P - parent, S - subsidiary
203 -- x_company_value Company value of subsidiary
204 -- x_currency_code Functional currency of subsidiary
205 -- x_autoapprove_flag Y - subsidiary has autoapproval.
206 -- N - subsidiary does not.
207 -- x_view_partner_lines_flag Y - subsidiary can access
208 -- partner lines.
209 -- N - subsidiary cannot.
210 -- x_conversion_type_code D - Daily Rates.
211 -- P - Period Rates.
212 -- x_conversion_type Conversion type for transactions
213 -- x_remote_instance_flag Y - Transfer Ledger is on
214 -- a remote instance.
215 -- N - Transfer Ledger is on
216 -- local instance.
217 -- x_transfer_ledger_id Transfer Ledger ID.
218 -- x_transfer_currency_code Transfer currency code.
219 -- x_contact Workflow role to send
220 -- notification when threshold is
221 -- reached.
222 -- x_notification_threshold Notification Threshold level
223 -- in transfer currency.
224 -- Example
225 -- gl_formsinfo.get_iea_info(100, :name, :coa_id, :led_id,
226 -- :enabled_flag, :sub_type_code,
227 -- :company_code, :currency_code,
228 -- :autoapprove_flag);
229 -- Notes
230 --
231 PROCEDURE get_iea_info(x_subsidiary_id NUMBER,
232 x_name IN OUT NOCOPY VARCHAR2,
233 x_chart_of_accounts_id IN OUT NOCOPY NUMBER,
234 x_ledger_id IN OUT NOCOPY NUMBER,
235 x_enabled_flag IN OUT NOCOPY VARCHAR2,
236 x_subsidiary_type_code IN OUT NOCOPY VARCHAR2,
237 x_company_value IN OUT NOCOPY VARCHAR2,
238 x_currency_code IN OUT NOCOPY VARCHAR2,
239 x_autoapprove_flag IN OUT NOCOPY VARCHAR2,
240 x_view_partner_lines_flag IN OUT NOCOPY VARCHAR2,
241 x_conversion_type_code IN OUT NOCOPY VARCHAR2,
242 x_conversion_type IN OUT NOCOPY VARCHAR2,
243 x_remote_instance_flag IN OUT NOCOPY VARCHAR2,
244 x_transfer_ledger_id IN OUT NOCOPY NUMBER,
245 x_transfer_currency_code IN OUT NOCOPY VARCHAR2,
246 x_contact IN OUT NOCOPY VARCHAR2,
247 x_notification_threshold IN OUT NOCOPY NUMBER);
248 --
249 -- Procedure
250 -- get_usage_info
251 -- Purpose
252 -- Gets the values of some columns from gl_system_usages
253 -- History
254 -- 16-JAN-96 D J Ogg Created.
255 -- Arguments
256 -- x_average_balances_flag Indicates whether average balances
257 -- is used in any ledger
258 --
259 PROCEDURE get_usage_info(
260 x_average_balances_flag IN OUT NOCOPY VARCHAR2,
261 x_consolidation_ledger_flag IN OUT NOCOPY VARCHAR2);
262
263 --
264 -- Procedure
265 -- get_business_days_pattern
266 -- Purpose
267 -- Uses transaction_calendar_id and start and end dates
268 -- to obtain which days are business in the form of a
269 -- binary VARCHAR pattern.
270 -- History
271 -- 16-JAN-96 D J Ogg Created.
272 -- Arguments
273 -- X_transaction_cal_id
274 -- X_start_date
275 -- X_end_date
276 -- X_bus_days_pattern
277 --
278 PROCEDURE get_business_days_pattern(X_transaction_cal_id IN NUMBER,
279 X_start_date IN DATE,
280 X_end_date IN DATE,
281 X_bus_days_pattern IN OUT NOCOPY VARCHAR2);
282
283 --
284 -- Procedure
285 -- iea_disabled_subsidiary
286 -- Purpose
287 -- Check if a GIS subsidiary is disabled.
288 -- Return true if subsidiary is diabled or does not exist.
289 -- History
290 -- 20-MAY-99 Charmaine Wang Created.
291 -- Arguments
292 -- X_Subsidiary_Id
293 --
294 FUNCTION iea_disabled_subsidiary(X_Subsidiary_Id IN NUMBER) RETURN BOOLEAN;
295
296 --
297 -- Procedure
298 -- get_industry_message
299 -- Purpose
300 -- Library cover for gl_public_sector.get_message_name
304 -- 17-DEC-01 D J Ogg Created
301 -- Given a message name, returns the appropriate message name
302 -- for the industry
303 -- History
305 -- Arguments
306 -- Message_Name -- Message Name to check
307 -- Application_Shortname -- Application Shortname
308 --
309 FUNCTION get_industry_message(Message_Name IN VARCHAR2,
310 Application_Shortname IN VARCHAR2)
311 RETURN VARCHAR2;
312
313 -- NAME
314 -- session_id
315 -- DESCRIPTION
316 -- Returns the session id.
317 -- PARAMETERS
318 FUNCTION session_id RETURN NUMBER;
319
320 -- NAME
321 -- serial_id
322 -- DESCRIPTION
323 -- Returns the serial id.
324 -- PARAMETERS
325 FUNCTION serial_id RETURN NUMBER;
326
327 END GL_FORMSINFO;
[Home] [Help]