1 package fa_rx_publish as
2 /* $Header: FARXPBSS.pls 120.2 2005/10/25 10:46:04 rravunny ship $ */
3
4 -------------------------------------------
5 -- Globals
6 -------------------------------------------
7 page_break_level CONSTANT NUMBER := -1;
8 page_carry_forward_level CONSTANT NUMBER := -2;
9 report_break_level CONSTANT NUMBER := -3;
10
11
12 --*
13 --* This value is used in the package to get the message text, that needs to be shouwn in
14 --* the report heading. Refer to bug#4394814, for furhter details.
15 --*
16 G_Moac_Message_Code Constant Varchar2(100) := 'FND_MO_RPT_PARTIAL_LEDGER';
17
18 --*
19 --* if this value is stored in the fnd_concurrent_programs.multi_org_category,
20 --* then we need to handle the MOAC changes, of displaying the message.
21 --*
22 G_Moac_Mo_Category_Conc_Flag Constant Varchar2(10) := 'M';
23
24
25 ----------------------------------------------------------
26 -- This routine are used by the RXi publishing engine.
27 -- These routines are meant only to provide information
28 -- to the publishing engine.
29 --------
30 -- The following outlines the how these functions should be called:
31 --
32 --
33 -- Init_Report or Init_Request
34 -- Get_Report_Info
35 -- Loop
36 -- Start_Format
37 -- Get_Format_Info
38 -- For i in 1..Get_Param_Count Loop
39 -- Get_Parameter
40 -- End Loop
41 -- For i in 1..Get_Break_Level_Count Loop
42 -- For j in 1..Get_Column_Count(i) Loop
43 -- Get_Column_Info
44 -- End Loop
45 -- For j in 1..Get_Summary_Column_Count(i) Loop
46 -- Get_Summary_Column_Info
47 -- End Loop
48 -- End Loop
49 --
50 -- Output Data
51 --
52 -- End_Format
53 -- While Format_Available
54 ----------------------------------------------------------
55
56
57
58
59 ------------------------------------------------------------------
60 -- Get_Report_Name
61 --
62 -- Given a report_id, this routine returns
63 -- the application short name and concurrent program name of the
64 -- associated concurrent program.
65 -- If this is a Direct Select RX, it will return a NULL value
66 -- for p_appname and p_concname
67 ------------------------------------------------------------------
68 PROCEDURE get_report_name(
69 p_report_id IN NUMBER,
70 p_appname OUT NOCOPY VARCHAR2,
71 p_concname OUT NOCOPY VARCHAR2);
72
73 ------------------------------------------------------------------
74 -- Init_Request
75 --
76 -- Initializes this package with the given request ID, report ID,
77 -- attribute set and output format.
78 -- Should not call this for Direct Select RX.
79 -- Should only be called once per session.
80 ------------------------------------------------------------------
81 PROCEDURE init_request(p_request_id IN NUMBER,
82 p_report_id IN NUMBER,
83 p_attribute_set IN VARCHAR2,
84 p_output_format IN VARCHAR2,
85 p_request_type IN VARCHAR2 DEFAULT 'PUBLISH');
86
87 ------------------------------------------------------------------
88 -- Init_Report
89 --
90 -- Initializes this package with the given report ID, attribute
91 -- set, output format, and concurrent program arguments.
92 -- This routine should only be called for Direct Select RX.
93 -- This routine should only be called once per session.
94 ------------------------------------------------------------------
95 PROCEDURE init_report(
96 p_report_id IN NUMBER,
97 p_attribute_set IN VARCHAR2,
98 p_output_format IN VARCHAR2,
99 p_argument1 IN VARCHAR2 ,
100 p_argument2 IN VARCHAR2 ,
101 p_argument3 IN VARCHAR2 ,
102 p_argument4 IN VARCHAR2 ,
103 p_argument5 IN VARCHAR2 ,
104 p_argument6 IN VARCHAR2 ,
105 p_argument7 IN VARCHAR2 ,
106 p_argument8 IN VARCHAR2 ,
107 p_argument9 IN VARCHAR2 ,
108 p_argument10 IN VARCHAR2 ,
109 p_argument11 IN VARCHAR2 ,
110 p_argument12 IN VARCHAR2 ,
111 p_argument13 IN VARCHAR2 ,
112 p_argument14 IN VARCHAR2 ,
113 p_argument15 IN VARCHAR2 ,
114 p_argument16 IN VARCHAR2 ,
115 p_argument17 IN VARCHAR2 ,
116 p_argument18 IN VARCHAR2 ,
117 p_argument19 IN VARCHAR2 ,
118 p_argument20 IN VARCHAR2 ,
119 p_argument21 IN VARCHAR2 ,
120 p_argument22 IN VARCHAR2 ,
121 p_argument23 IN VARCHAR2 ,
122 p_argument24 IN VARCHAR2 ,
123 p_argument25 IN VARCHAR2 ,
124 p_argument26 IN VARCHAR2 ,
125 p_argument27 IN VARCHAR2 ,
126 p_argument28 IN VARCHAR2 ,
127 p_argument29 IN VARCHAR2 ,
128 p_argument30 IN VARCHAR2 ,
129 p_argument31 IN VARCHAR2 ,
130 p_argument32 IN VARCHAR2 ,
131 p_argument33 IN VARCHAR2 ,
132 p_argument34 IN VARCHAR2 ,
133 p_argument35 IN VARCHAR2 ,
134 p_argument36 IN VARCHAR2 ,
135 p_argument37 IN VARCHAR2 ,
136 p_argument38 IN VARCHAR2 ,
137 p_argument39 IN VARCHAR2 ,
138 p_argument40 IN VARCHAR2 ,
139 p_argument41 IN VARCHAR2 ,
140 p_argument42 IN VARCHAR2 ,
141 p_argument43 IN VARCHAR2 ,
142 p_argument44 IN VARCHAR2 ,
143 p_argument45 IN VARCHAR2 ,
144 p_argument46 IN VARCHAR2 ,
145 p_argument47 IN VARCHAR2 ,
146 p_argument48 IN VARCHAR2 ,
147 p_argument49 IN VARCHAR2 ,
148 p_argument50 IN VARCHAR2 ,
149 p_argument51 IN VARCHAR2 ,
150 p_argument52 IN VARCHAR2 ,
151 p_argument53 IN VARCHAR2 ,
152 p_argument54 IN VARCHAR2 ,
153 p_argument55 IN VARCHAR2 ,
154 p_argument56 IN VARCHAR2 ,
155 p_argument57 IN VARCHAR2 ,
156 p_argument58 IN VARCHAR2 ,
157 p_argument59 IN VARCHAR2 ,
158 p_argument60 IN VARCHAR2 ,
159 p_argument61 IN VARCHAR2 ,
160 p_argument62 IN VARCHAR2 ,
161 p_argument63 IN VARCHAR2 ,
162 p_argument64 IN VARCHAR2 ,
163 p_argument65 IN VARCHAR2 ,
164 p_argument66 IN VARCHAR2 ,
165 p_argument67 IN VARCHAR2 ,
166 p_argument68 IN VARCHAR2 ,
167 p_argument69 IN VARCHAR2 ,
168 p_argument70 IN VARCHAR2 ,
169 p_argument71 IN VARCHAR2 ,
170 p_argument72 IN VARCHAR2 ,
171 p_argument73 IN VARCHAR2 ,
172 p_argument74 IN VARCHAR2 ,
173 p_argument75 IN VARCHAR2 ,
174 p_argument76 IN VARCHAR2 ,
175 p_argument77 IN VARCHAR2 ,
176 p_argument78 IN VARCHAR2 ,
177 p_argument79 IN VARCHAR2 ,
178 p_argument80 IN VARCHAR2 ,
179 p_argument81 IN VARCHAR2 ,
180 p_argument82 IN VARCHAR2 ,
181 p_argument83 IN VARCHAR2 ,
182 p_argument84 IN VARCHAR2 ,
183 p_argument85 IN VARCHAR2 ,
184 p_argument86 IN VARCHAR2 ,
185 p_argument87 IN VARCHAR2 ,
186 p_argument88 IN VARCHAR2 ,
187 p_argument89 IN VARCHAR2 ,
188 p_argument90 IN VARCHAR2 ,
189 p_argument91 IN VARCHAR2 ,
190 p_argument92 IN VARCHAR2 ,
191 p_argument93 IN VARCHAR2 ,
192 p_argument94 IN VARCHAR2 ,
193 p_argument95 IN VARCHAR2 ,
194 p_argument96 IN VARCHAR2 ,
195 p_argument97 IN VARCHAR2 ,
196 p_argument98 IN VARCHAR2 ,
197 p_argument99 IN VARCHAR2 ,
198 p_argument100 IN VARCHAR2 );
199
200 ------------------------------------------------------------------
201 -- Get_Report_Info
202 --
203 -- This routine returns report level information.
204 -- These are information that should not change between formats.
205 ------------------------------------------------------------------
206 PROCEDURE get_report_info(
207 p_display_report_title OUT NOCOPY VARCHAR2,
208 p_display_set_of_books OUT NOCOPY VARCHAR2,
209 p_display_functional_currency OUT NOCOPY VARCHAR2,
210 p_display_submission_date OUT NOCOPY VARCHAR2,
211 p_display_current_page OUT NOCOPY VARCHAR2,
212 p_display_total_page OUT NOCOPY VARCHAR2,
213 p_report_title OUT NOCOPY VARCHAR2,
214 p_set_of_books_name OUT NOCOPY VARCHAR2,
215 p_function_currency_prompt OUT NOCOPY VARCHAR2,
216 p_function_currency OUT NOCOPY VARCHAR2,
217 p_submission_date OUT NOCOPY VARCHAR2,
218 p_current_page_prompt OUT NOCOPY VARCHAR2,
219 p_total_page_prompt OUT NOCOPY VARCHAR2,
220 p_page_width OUT NOCOPY NUMBER,
221 p_page_height OUT NOCOPY NUMBER,
222 p_output_format OUT NOCOPY VARCHAR2,
223 p_nls_end_of_report OUT NOCOPY VARCHAR2,
224 p_nls_no_data_found OUT NOCOPY VARCHAR2);
225
226 ------------------------------------------------------------------
227 -- Get_Format_Info
228 --
229 -- This routine returns format level information.
230 -- These are information that may change from format to format.
231 ------------------------------------------------------------------
232 PROCEDURE get_format_info(
233 p_display_parameters OUT NOCOPY VARCHAR2,
234 p_display_page_break OUT NOCOPY VARCHAR2,
235 p_group_display_type OUT NOCOPY VARCHAR2);
236
237 ------------------------------------------------------------------
238 -- Get_Param_Count
239 --
240 -- Returns the number of parameters for the current format.
241 ------------------------------------------------------------------
242 FUNCTION get_param_count RETURN NUMBER;
243
244 ------------------------------------------------------------------
245 -- Get_Parameter
246 --
247 -- Returns parameter information.
248 -- Must be called exact number of times as is returned by
249 -- Get_Param_Count.
250 ------------------------------------------------------------------
251 PROCEDURE get_parameter(
252 p_param_id IN NUMBER,
253 p_param_name OUT NOCOPY VARCHAR2,
254 p_param_value OUT NOCOPY VARCHAR2);
255
256 ------------------------------------------------------------------
257 -- Get_Break_Level
258 --
259 -- Returns the number of break levels in the current format.
260 ------------------------------------------------------------------
261 FUNCTION get_break_level_count RETURN NUMBER;
262
263
264 ------------------------------------------------------------------
265 -- Get_Column_Count
266 --
267 -- Returns the number of columns in the given break level.
268 -- Break level should be between 1 and the returned value of
269 -- Get_Break_Level.
270 ------------------------------------------------------------------
271 FUNCTION get_column_count(
272 p_break_level IN NUMBER) RETURN NUMBER;
273
274
275 ------------------------------------------------------------------
276 -- Get_Column_Info
277 --
278 -- Returns the column information for the given break level.
279 -- This routine must be called as many times as is returned
280 -- by Get_Column_Count.
281 ------------------------------------------------------------------
282 PROCEDURE get_column_info(
283 p_break_level IN NUMBER,
284 p_column_id OUT NOCOPY NUMBER,
285 p_column_name OUT NOCOPY VARCHAR2,
286 p_column_type OUT NOCOPY VARCHAR2,
287 p_attribute_name OUT NOCOPY VARCHAR2,
288 p_length OUT NOCOPY NUMBER,
289 p_currency_column_id OUT NOCOPY NUMBER,
290 p_precision OUT NOCOPY NUMBER,
291 p_minimum_accountable_unit OUT NOCOPY NUMBER,
292 p_break OUT NOCOPY VARCHAR2);
293
294 ------------------------------------------------------------------
295 -- Get_Summary_Column_Count
296 --
297 -- Returns the number of summary columns in the given break level.
298 -- Break level should be between 1 and the returned value of
299 -- Get_Break_Level.
300 ------------------------------------------------------------------
301 FUNCTION get_summary_column_count(
302 p_break_level IN NUMBER) RETURN NUMBER;
303
304
305 ------------------------------------------------------------------
306 -- Get_Summary_Column_Info
307 --
308 -- Returns the summary column information for the given break level.
309 -- This routine must be called as many times as is returned
310 -- by Get_Summary_Column_Count.
311 ------------------------------------------------------------------
312 PROCEDURE get_summary_column_info(
313 p_break_level IN NUMBER,
314 p_summary_column_id OUT NOCOPY NUMBER,
315 p_prompt OUT NOCOPY VARCHAR2,
316 p_source_column_id OUT NOCOPY NUMBER);
317
318
319 ------------------------------------------------------------------
320 -- Start_Format
321 --
322 -- This routine should be called at the beginning of every format.
323 ------------------------------------------------------------------
324 PROCEDURE start_format;
325
326 ------------------------------------------------------------------
327 -- End_Format
328 --
329 -- This routine should be called at the end of every format.
330 ------------------------------------------------------------------
331 PROCEDURE end_format;
332
333 ------------------------------------------------------------------
334 -- Format Available
335 --
336 -- This routine should be called after a format ends to determine
337 -- if there are any more formats.
338 ------------------------------------------------------------------
339 FUNCTION format_available RETURN VARCHAR2;
340
341
342 ------------------------------------------------------------------
343 -- Get_Select_Stmt
344 --
345 -- This routine returns the main select statment.
346 -- There will be no bind variables here.
347 ------------------------------------------------------------------
348 FUNCTION get_select_stmt RETURN VARCHAR2;
349
350
351 ------------------------------------------------------------------
352 -- Get_All_Column_Count
353 --
354 -- This routine returns the number of columns in the select
355 -- statement returned by Get_Select_Stmt
356 -- May return more than get_break_level_count * get_column_count
357 -- since the select statement may include currency columns
358 -- as well.
359 ------------------------------------------------------------------
360 function get_all_column_count return number;
361 function get_disp_column_count return number;
362
363
364 ------------------------------------------------------------------
365 -- Get_Format_Col_Info
366 --
367 -- This routine returns information required for formatting.
368 -- It will return the columns in order of the column_id returned
369 -- by Get_Column_Info. The p_currency_column_id returned here
370 -- will also point to a valid column_id returned by this routine.
371 ------------------------------------------------------------------
372 PROCEDURE get_format_col_info(
373 p_column_name OUT NOCOPY VARCHAR2,
374 p_display_format OUT NOCOPY VARCHAR2,
375 p_display_length OUT NOCOPY NUMBER,
376 p_break_group_level OUT NOCOPY NUMBER,
377 p_format_mask OUT NOCOPY VARCHAR2,
378 p_currency_column_id OUT NOCOPY NUMBER,
379 p_precision OUT NOCOPY NUMBER,
380 p_minunit OUT NOCOPY NUMBER);
381
382
383 ------------------------------------------------------------------
384 -- Get_All_Summary_Count
385 --
386 -- This routine returns the number of summary columns
387 ------------------------------------------------------------------
388 FUNCTION get_all_summary_count RETURN NUMBER;
389
390 ------------------------------------------------------------------
391 -- Get_Format_Sum_Info
392 --
393 -- This routine returns information about summary columns as required
394 -- to format.
395 -- p_source_column_id will point to a valid column_id returned
396 -- by Get_Format_Column_Info.
397 -- This routine will return the columns in order of p_summary_column_id
398 -- returned by Get_Summary_Column_Info
399 ------------------------------------------------------------------
400 PROCEDURE get_format_sum_info(
401 p_source_column_id OUT NOCOPY NUMBER,
402 p_reset_level OUT NOCOPY NUMBER,
403 p_compute_level OUT NOCOPY NUMBER,
404 p_summary_function OUT NOCOPY VARCHAR2);
405
406 -----------------------------------------
407 -- Handle Bind variables
408 -----------------------------------------
409 FUNCTION get_bind_count RETURN NUMBER;
410 FUNCTION get_bind_variable RETURN VARCHAR2;
411
412 ------------------------------------------------------------------
413 -- Get_Rows_Purged
414 --
415 -- This routine returns the number of rows purged.
416 ------------------------------------------------------------------
417 PROCEDURE get_rows_purged(request_id IN VARCHAR2, l_report_id IN NUMBER,
418 l_purge_api OUT NOCOPY VARCHAR2, row_num out NUMBER);
419
420
421
422 Procedure Get_Moac_Message(xMoac_Message out NOCOPY Varchar2);
423
424 end fa_rx_publish;
[Home] [Help]