[Home] [Help]
PACKAGE: APPS.FND_FLEX_ORACLE_REPORTS_APIS
Source
1 PACKAGE fnd_flex_oracle_reports_apis AS
2 /* $Header: AFFFORAS.pls 120.1.12010000.1 2008/07/25 14:14:13 appldev ship $ */
3
4 --
5 -- FLEXSQL user exit, MODE constants
6 --
7 mode_select CONSTANT VARCHAR2(30) := 'SELECT';
8 mode_where CONSTANT VARCHAR2(30) := 'WHERE';
9 mode_order_by CONSTANT VARCHAR2(30) := 'ORDER BY';
10 mode_having CONSTANT VARCHAR2(30) := 'HAVING';
11
12 --
13 -- FLEXSQL user exit, OPERATOR constants
14 --
15 operator_equal CONSTANT VARCHAR2(30) := '=';
16 operator_less_than CONSTANT VARCHAR2(30) := '<';
17 operator_greater_than CONSTANT VARCHAR2(30) := '>';
18 operator_less_than_or_equal CONSTANT VARCHAR2(30) := '<=';
19 operator_greater_than_or_equal CONSTANT VARCHAR2(30) := '>=';
20 operator_not_equal CONSTANT VARCHAR2(30) := '!=';
21 operator_concatenate CONSTANT VARCHAR2(30) := '||';
22 operator_between CONSTANT VARCHAR2(30) := 'BETWEEN';
23 operator_qbe CONSTANT VARCHAR2(30) := 'QBE';
24 operator_like CONSTANT VARCHAR2(30) := 'LIKE';
25
26 --
27 -- Please see "Flexfields Guide", "Reporting on Flexfield Data" chapter
28 -- for more information about FLEXSQL and FLEXIDVAL APIs.
29 --
30 --
31 -- User Exit PL/SQL API
32 -- ----------- -----------------------------------------
33 -- FND FLEXSQL fnd_flex_oracle_reports_apis.flexsql(...);
34 --
35 -- This API returns a SQL fragment to be used in various portions of a
36 -- SELECT statement.
37 --
38 -- User Exit PL/SQL API
39 -- parameter parameter Notes
40 -- --------- ----------------- --------------------------
41 -- Input Arguments
42 -- APPL_SHORT_NAME p_appl_short_name e.g. 'SQLGL'
43 -- CODE p_code e.g. 'GL#'
44 -- MODE p_mode See mode_* constants
45 -- NUM p_num e.g. 101
46 -- MULTINUM p_multinum e.g. 'Y', 'N'
47 -- DISPLAY p_display e.g. 'ALL', '1', 'GL_ACCOUNT'
48 -- SHOWDEPSEG p_showdepseg e.g. 'Y', 'N'
49 -- TABLEALIAS p_tablealias e.g. 'my_table'
50 -- OPERATOR p_operator See operator_* constants
51 -- OPERAND1 p_operand1
52 -- OPERAND2 p_operand2
53 --
54 -- Output Arguments
55 -- OUTPUT x_output
56 --
57 -- Exception Handling
58 -- This procedure raises exception if there is any error. The translated
59 -- error message can be retreived by calling SQLERRM, or
60 -- dbms_utility.format_error_stack().
61 --
62 PROCEDURE flexsql(p_appl_short_name IN VARCHAR2,
63 p_code IN VARCHAR2,
64 p_mode IN VARCHAR2,
65 p_num IN NUMBER DEFAULT 101,
66 p_multinum IN VARCHAR2 DEFAULT 'N',
67 p_display IN VARCHAR2 DEFAULT 'ALL',
68 p_showdepseg IN VARCHAR2 DEFAULT 'Y',
69 p_tablealias IN VARCHAR2 DEFAULT NULL,
70 p_operator IN VARCHAR2 DEFAULT NULL,
71 p_operand1 IN VARCHAR2 DEFAULT NULL,
72 p_operand2 IN VARCHAR2 DEFAULT NULL,
73 x_output OUT nocopy VARCHAR2);
74
75
76 --
77 -- FLEXIDVAL user exit, Output Name Constants
78 --
79 output_value CONSTANT VARCHAR2(30) := 'VALUE';
80 output_description CONSTANT VARCHAR2(30) := 'DESCRIPTION';
81 output_aprompt CONSTANT VARCHAR2(30) := 'APROMPT';
82 output_lprompt CONSTANT VARCHAR2(30) := 'LPROMPT';
83 output_padded_value CONSTANT VARCHAR2(30) := 'PADDED_VALUE';
84 output_security CONSTANT VARCHAR2(30) := 'SECURITY';
85 output_full_description CONSTANT VARCHAR2(30) := 'FULL_DESCRIPTION';
86 output_ccid CONSTANT VARCHAR2(30) := 'CCID';
87
88 --
89 -- FLEXIDVAL user exit, Output Record Type
90 --
91 TYPE flexidval_output_rec_type IS RECORD
92 (name VARCHAR2(30),
93 value VARCHAR2(32000));
94
95 --
96 -- FLEXIDVAL user exit, Output Array Type (1-based array)
97 --
98 TYPE flexidval_output_arr_type IS TABLE OF flexidval_output_rec_type
99 INDEX BY BINARY_INTEGER;
100
101 --
102 -- User Exit PL/SQL API
103 -- ----------- -----------------------------------------
104 -- FND FLEXIDVAL fnd_flex_oracle_reports_apis.flexidval(...);
105 --
106 -- User Exit PL/SQL API
107 -- parameter parameter Notes
108 -- --------- ----------------- --------------------------
109 -- Input Arguments
110 -- APPL_SHORT_NAME p_appl_short_name
111 -- CODE p_code
112 -- DATA p_data
113 -- NUM p_num
114 -- MULTINUM p_multinum
115 -- DISPLAY p_display
116 -- IDISPLAY p_display
117 -- DINSERT p_dinsert
118 -- SHOWDEPSEG p_showdepseg
119 --
120 -- p_output_array_size
121 --
122 -- Input/Output Arguments
123 -- px_output_array See output_* constants
124 --
125 -- To be able to get outputs from this API, put the names of the
126 -- output variables you are interested in the px_output_array(i).name.
127 -- This API will return the value of that output in the
128 -- px_output_array(i).value. Please note that this array's index is 1-based.
129 -- p_output_array_size should be passed in too, and it should indicate
130 -- the index of the last element.
131 --
132 -- Exception Handling
133 -- This procedure raises exception if there is any error. The translated
134 -- error message can be retreived by calling SQLERRM, or
135 -- dbms_utility.format_error_stack().
136 --
137 PROCEDURE flexidval(p_appl_short_name IN VARCHAR2,
138 p_code IN VARCHAR2,
139 p_data IN VARCHAR2,
140 p_num IN NUMBER DEFAULT 101,
141 p_multinum IN VARCHAR2 DEFAULT 'N',
142 p_display IN VARCHAR2 DEFAULT 'ALL',
143 p_idisplay IN VARCHAR2 DEFAULT 'ALL',
144 p_showdepseg IN VARCHAR2 DEFAULT 'Y',
145 p_dinsert IN VARCHAR2 DEFAULT 'N',
146 p_output_array_size IN BINARY_INTEGER,
147 px_output_array IN OUT nocopy flexidval_output_arr_type);
148
149 END fnd_flex_oracle_reports_apis;