1 PACKAGE fnd_flex_dsc_api AS
2 /* $Header: AFFFDAIS.pls 120.6.12010000.1 2008/07/25 14:13:41 appldev ship $ */
3
4 PROCEDURE set_session_mode(session_mode IN VARCHAR2);
5
6 /* restricted function. do not use! */
7 PROCEDURE set_validation(v_in IN BOOLEAN);
8 PROCEDURE debug_on;
9 PROCEDURE debug_off;
10
11 FUNCTION version RETURN VARCHAR2;
12 FUNCTION message RETURN VARCHAR2;
13
14
15 PROCEDURE register(appl_short_name IN VARCHAR2,
16 flexfield_name IN VARCHAR2,
17 title IN VARCHAR2,
18 description IN VARCHAR2,
19 table_appl_short_name IN VARCHAR2,
20 table_name IN VARCHAR2,
21 structure_column IN VARCHAR2,
22 context_prompt IN VARCHAR2 DEFAULT 'Context Value',
23 protected_flag IN VARCHAR2 DEFAULT 'N',
24 enable_columns IN VARCHAR2 DEFAULT NULL,
25 concatenated_segs_view_name IN VARCHAR2 DEFAULT NULL);
26
27
28 PROCEDURE enable_columns(appl_short_name IN VARCHAR2,
29 flexfield_name IN VARCHAR2,
30 pattern IN VARCHAR2);
31
32
33 PROCEDURE setup_context_field(appl_short_name IN VARCHAR2,
34 flexfield_name IN VARCHAR2,
35 /* data */
36 segment_separator IN VARCHAR2,
37 prompt IN VARCHAR2 DEFAULT 'Context Value',
38 default_value IN VARCHAR2,
39 reference_field IN VARCHAR2,
40 value_required IN VARCHAR2,
41 override_allowed IN VARCHAR2,
42 freeze_flexfield_definition IN VARCHAR2 DEFAULT 'N',
43 context_default_type IN VARCHAR2 DEFAULT NULL,
44 context_default_value IN VARCHAR2 DEFAULT NULL,
45 context_override_value_set_nam IN VARCHAR2 DEFAULT NULL,
46 context_runtime_property_funct IN VARCHAR2 DEFAULT NULL);
47
48
49 PROCEDURE freeze(appl_short_name IN VARCHAR2,
50 flexfield_name IN VARCHAR2);
51
52
53 PROCEDURE create_context(
54 /* identification */
55 appl_short_name IN VARCHAR2,
56 flexfield_name IN VARCHAR2,
57 /* data */
58 context_code IN VARCHAR2,
59 context_name IN VARCHAR2,
60 description IN VARCHAR2,
61 enabled IN VARCHAR2,
62 global_flag IN VARCHAR2 DEFAULT 'N');
63
64
65 PROCEDURE create_segment(
66 /* identification */
67 appl_short_name IN VARCHAR2,
68 flexfield_name IN VARCHAR2,
69 context_name IN VARCHAR2,
70 /* data */
71 name IN VARCHAR2,
72 column IN VARCHAR2,
73 description IN VARCHAR2,
74 sequence_number IN NUMBER,
75 enabled IN VARCHAR2,
76 displayed IN VARCHAR2,
77 /* validation */
78 value_set IN VARCHAR2,
79 default_type IN VARCHAR2,
80 default_value IN VARCHAR2,
81 required IN VARCHAR2,
82 security_enabled IN VARCHAR2,
83 /* sizes */
84 display_size IN NUMBER,
85 description_size IN NUMBER,
86 concatenated_description_size IN NUMBER,
87 list_of_values_prompt IN VARCHAR2,
88 window_prompt IN VARCHAR2,
89 range IN VARCHAR2 DEFAULT NULL,
90 srw_parameter IN VARCHAR2 DEFAULT NULL,
91 runtime_property_function IN VARCHAR2 DEFAULT NULL);
92
93
94 PROCEDURE modify_segment
95 (-- PK for segment
96 p_appl_short_name IN VARCHAR2,
97 p_flexfield_name IN VARCHAR2,
98 p_context_code IN VARCHAR2,
99 p_segment_name IN VARCHAR2 DEFAULT NULL,
100 p_column_name IN VARCHAR2 DEFAULT NULL,
101 -- Data
102 p_description IN VARCHAR2 DEFAULT fnd_api.g_miss_char,
103 p_sequence_number IN NUMBER DEFAULT fnd_api.g_miss_num,
104 p_enabled IN VARCHAR2 DEFAULT fnd_api.g_miss_char,
105 p_displayed IN VARCHAR2 DEFAULT fnd_api.g_miss_char,
106 -- Validation
107 p_value_set IN VARCHAR2 DEFAULT fnd_api.g_miss_char,
108 p_default_type IN VARCHAR2 DEFAULT fnd_api.g_miss_char,
109 p_default_value IN VARCHAR2 DEFAULT fnd_api.g_miss_char,
110 p_required IN VARCHAR2 DEFAULT fnd_api.g_miss_char,
111 p_security_enabled IN VARCHAR2 DEFAULT fnd_api.g_miss_char,
112 -- Sizes
113 p_display_size IN NUMBER DEFAULT fnd_api.g_miss_num,
114 p_description_size IN NUMBER DEFAULT fnd_api.g_miss_num,
115 p_concat_desc_size IN NUMBER DEFAULT fnd_api.g_miss_num,
116 p_lov_prompt IN VARCHAR2 DEFAULT fnd_api.g_miss_char,
117 p_window_prompt IN VARCHAR2 DEFAULT fnd_api.g_miss_char,
118 p_range IN VARCHAR2 DEFAULT fnd_api.g_miss_char,
119 p_srw_parameter IN VARCHAR2 DEFAULT fnd_api.g_miss_char,
120 p_runtime_property_function IN VARCHAR2 DEFAULT fnd_api.g_miss_char);
121
122
123
124 PROCEDURE create_reference_field(appl_short_name IN VARCHAR2,
125 flexfield_name IN VARCHAR2,
126 context_field_name IN VARCHAR2,
127 description IN VARCHAR2);
128
129
130 PROCEDURE delete_flexfield(appl_short_name IN VARCHAR2,
131 flexfield_name IN VARCHAR2);
132
133 PROCEDURE disable_columns(appl_short_name IN VARCHAR2,
134 flexfield_name IN VARCHAR2,
135 pattern IN VARCHAR2);
136
137 PROCEDURE delete_context(appl_short_name IN VARCHAR2,
138 flexfield_name IN VARCHAR2,
139 context IN VARCHAR2);
140
141 PROCEDURE update_context(
142 p_appl_short_name IN VARCHAR2,
143 p_flexfield_name IN VARCHAR2,
144 p_desc_flex_context_code IN VARCHAR2,
145 p_desc_flex_context_name IN VARCHAR2 DEFAULT NULL,
146 p_description IN VARCHAR2 DEFAULT NULL,
147 p_enabled_flag IN VARCHAR2 DEFAULT NULL,
148 p_language IN VARCHAR2);
149
150
151 PROCEDURE delete_segment(appl_short_name IN VARCHAR2,
152 flexfield_name IN VARCHAR2,
153 context IN VARCHAR2,
154 segment IN VARCHAR2);
155
156 FUNCTION flexfield_exists(appl_short_name IN VARCHAR2,
157 flexfield_name IN VARCHAR2) RETURN BOOLEAN;
158
159 FUNCTION context_exists(p_appl_short_name IN VARCHAR2,
160 p_flexfield_name IN VARCHAR2,
161 p_context_code IN VARCHAR2) RETURN BOOLEAN;
162
163 FUNCTION segment_exists(p_appl_short_name IN VARCHAR2,
164 p_flexfield_name IN VARCHAR2,
165 p_context_code IN VARCHAR2,
166 p_segment_name IN VARCHAR2 DEFAULT NULL,
167 p_column_name IN VARCHAR2 DEFAULT NULL) RETURN BOOLEAN;
168
169 PROCEDURE enable_context(appl_short_name IN VARCHAR2,
170 flexfield_name IN VARCHAR2,
171 context IN VARCHAR2,
172 enable IN BOOLEAN DEFAULT TRUE);
173
174 FUNCTION is_table_used(p_application_id IN fnd_tables.application_id%TYPE,
175 p_table_name IN fnd_tables.table_name%TYPE,
176 x_message OUT nocopy VARCHAR2) RETURN BOOLEAN;
177
178 FUNCTION is_column_used(p_application_id IN fnd_tables.application_id%TYPE,
179 p_table_name IN fnd_tables.table_name%TYPE,
180 p_column_name IN fnd_columns.column_name%TYPE,
181 x_message OUT nocopy VARCHAR2) RETURN BOOLEAN;
182
183 PROCEDURE rename_dff(p_old_application_short_name IN fnd_application.application_short_name%TYPE,
184 p_old_dff_name IN fnd_descriptive_flexs.descriptive_flexfield_name%TYPE,
185 p_new_application_short_name IN fnd_application.application_short_name%TYPE,
186 p_new_dff_name IN fnd_descriptive_flexs.descriptive_flexfield_name%TYPE);
187
188 PROCEDURE migrate_dff(p_application_short_name IN fnd_application.application_short_name%TYPE,
189 p_descriptive_flexfield_name IN fnd_descriptive_flexs.descriptive_flexfield_name%TYPE,
190 p_new_table_appl_short_name IN fnd_application.application_short_name%TYPE,
191 p_new_table_name IN fnd_tables.table_name%TYPE);
192
193 END fnd_flex_dsc_api;