DBA Data[Home] [Help]

PACKAGE: APPS.FND_FORM_FUNCTIONS_PKG

Source


1 package FND_FORM_FUNCTIONS_PKG AUTHID CURRENT_USER as
2 /* $Header: AFFMFUNS.pls 120.3 2006/02/17 09:29:18 jvalenti ship $ */
3 /*#
4 * Table Handler to insert or update data in FND_FORM_FUNCTIONS table.
5 * @rep:scope public
6 * @rep:product FND
7 * @rep:displayname Form Function
8 * @rep:lifecycle active
9 * @rep:compatibility S
10 * @rep:category BUSINESS_ENTITY FND_FUNCTION
11 * @rep:ihelp FND/@o_funcsec#o_funcsec See the related online help
12 */
13 
14 
15 /* Overloaded version below.  This version does not have new */
16 /* LAST_UPDATE_DATE, MAINTENANCE_MODE_SUPPORT, or CONTEXT_DEPENDENCE */
17 /* columns, so that it will continue to be callable from old forms code. */
18 /* This API is obsolete and should not be used for new code. */
19 procedure INSERT_ROW (
20   X_ROWID in out nocopy VARCHAR2,
21   X_FUNCTION_ID in NUMBER,
22   X_WEB_HOST_NAME in VARCHAR2,
23   X_WEB_AGENT_NAME in VARCHAR2,
24   X_WEB_HTML_CALL in VARCHAR2,
25   X_WEB_ENCRYPT_PARAMETERS in VARCHAR2,
26   X_WEB_SECURED in VARCHAR2,
27   X_WEB_ICON in VARCHAR2,
28   X_OBJECT_ID in NUMBER,
29   X_REGION_APPLICATION_ID in NUMBER,
30   X_REGION_CODE in VARCHAR2,
31   X_FUNCTION_NAME in VARCHAR2,
32   X_APPLICATION_ID in NUMBER,
33   X_FORM_ID in NUMBER,
34   X_PARAMETERS in VARCHAR2,
35   X_TYPE in VARCHAR2,
36   X_USER_FUNCTION_NAME in VARCHAR2,
37   X_DESCRIPTION in VARCHAR2,
38   X_CREATION_DATE in DATE,
39   X_CREATED_BY in NUMBER,
40   X_LAST_UPDATE_DATE in DATE,
41   X_LAST_UPDATED_BY in NUMBER,
42   X_LAST_UPDATE_LOGIN in NUMBER);
43 
44 /* Overloaded version below.  This version does not have new */
45 /* MAINTENANCE_MODE_SUPPORT, or CONTEXT_DEPENDENCE */
46 /* columns, so that it will continue to be callable from old forms code. */
47 /* This API is obsolete and should not be used for new code. */
48 procedure LOCK_ROW (
49   X_FUNCTION_ID in NUMBER,
50   X_WEB_HOST_NAME in VARCHAR2,
51   X_WEB_AGENT_NAME in VARCHAR2,
52   X_WEB_HTML_CALL in VARCHAR2,
53   X_WEB_ENCRYPT_PARAMETERS in VARCHAR2,
54   X_WEB_SECURED in VARCHAR2,
55   X_WEB_ICON in VARCHAR2,
56   X_OBJECT_ID in NUMBER,
57   X_REGION_APPLICATION_ID in NUMBER,
58   X_REGION_CODE in VARCHAR2,
59   X_FUNCTION_NAME in VARCHAR2,
60   X_APPLICATION_ID in NUMBER,
61   X_FORM_ID in NUMBER,
62   X_PARAMETERS in VARCHAR2,
63   X_TYPE in VARCHAR2,
64   X_USER_FUNCTION_NAME in VARCHAR2,
65   X_DESCRIPTION in VARCHAR2
66 );
67 
68 /* Overloaded version below.  This version does not have new */
69 /* MAINTENANCE_MODE_SUPPORT, or CONTEXT_DEPENDENCE */
70 /* columns, so that it will continue to be callable from old forms code. */
71 /* This API is obsolete and should not be used for new code. */
72 procedure UPDATE_ROW (
73   X_FUNCTION_ID in NUMBER,
74   X_WEB_HOST_NAME in VARCHAR2,
75   X_WEB_AGENT_NAME in VARCHAR2,
76   X_WEB_HTML_CALL in VARCHAR2,
77   X_WEB_ENCRYPT_PARAMETERS in VARCHAR2,
78   X_WEB_SECURED in VARCHAR2,
79   X_WEB_ICON in VARCHAR2,
80   X_OBJECT_ID in NUMBER,
81   X_REGION_APPLICATION_ID in NUMBER,
82   X_REGION_CODE in VARCHAR2,
83   X_FUNCTION_NAME in VARCHAR2,
84   X_APPLICATION_ID in NUMBER,
85   X_FORM_ID in NUMBER,
86   X_PARAMETERS in VARCHAR2,
87   X_TYPE in VARCHAR2,
88   X_USER_FUNCTION_NAME in VARCHAR2,
89   X_DESCRIPTION in VARCHAR2,
90   X_LAST_UPDATE_DATE in DATE,
91   X_LAST_UPDATED_BY in NUMBER,
92   X_LAST_UPDATE_LOGIN in NUMBER
93 );
94 
95 /* Overloaded version below.  */
96 /* This version does NOT have last_update_date, for old forms code*/
97 /* This API is obsolete and should not be used for new code. */
98 procedure LOAD_ROW (
99   X_FUNCTION_NAME in VARCHAR2,
100   X_APPLICATION_SHORT_NAME in VARCHAR2,
101   X_FORM_NAME in VARCHAR2,
102   X_PARAMETERS in VARCHAR2,
103   X_TYPE in VARCHAR2,
104   X_WEB_HOST_NAME in VARCHAR2,
105   X_WEB_AGENT_NAME in VARCHAR2,
106   X_WEB_HTML_CALL in VARCHAR2,
107   X_WEB_ENCRYPT_PARAMETERS in VARCHAR2,
108   X_WEB_SECURED in VARCHAR2,
109   X_WEB_ICON in VARCHAR2,
110   X_OBJECT_NAME in VARCHAR2,
111   X_REGION_APPLICATION_NAME in VARCHAR2,
112   X_REGION_CODE in VARCHAR2,
113   X_USER_FUNCTION_NAME in VARCHAR2,
114   X_DESCRIPTION in VARCHAR2,
115   X_OWNER in VARCHAR2,
116   X_CUSTOM_MODE in VARCHAR2
117 );
118 
119 procedure DELETE_ROW (
120   X_FUNCTION_ID in NUMBER
121 );
122 
123 procedure ADD_LANGUAGE;
124 
125 /* Overloaded version below */
126 /* This version does NOT have last_update_date for old forms code*/
127 /* This API is obsolete and should not be used for new code. */
128 procedure TRANSLATE_ROW (
129   X_FUNCTION_ID in NUMBER,
130   X_USER_FUNCTION_NAME in VARCHAR2,
131   X_DESCRIPTION in VARCHAR2,
132   X_OWNER in VARCHAR2,
133   X_CUSTOM_MODE in VARCHAR2
134 );
135 
136 /* Overloaded version above.  This version DOES have new */
137 /* LAST_UPDATE_DATE, MAINTENANCE_MODE_SUPPORT,  CONTEXT_DEPENDENCE, */
138 /* JRAD_REF_PATH columns so this API should be used for new code. */
139     /*#
140      * Creates or updates Form Function as appropriate
141      * @param x_function_name Function Name
142      * @param x_application_short_name Application Short Name
143      * @param x_form_name Form Name
144      * @param x_parameters Parameters To the Function
145      * @param x_type Function Type
146      * @param x_web_host_name Web Host Name
147      * @param x_web_agent_name Web Agent Name
148      * @param x_web_html_call HTML Call
149      * @param x_web_encrypt_parameters Encrypt Parameters or Not
150      * @param x_web_secured Web Secured or Not
151      * @param x_web_icon Web Icon
152      * @param x_object_name Object Name
153      * @param x_region_application_name Region Application Name
154      * @param x_region_code Region Code
155      * @param x_user_function_name User Function Name
156      * @param x_description Description
157      * @param x_owner Owner Name
158      * @param x_custom_mode Custom Mode
159      * @param x_last_update_date Insert/Update Date
160      * @param x_maintenance_mode_support Maintenance Mode Support
161      * @param x_context_dependence Context Dependence
162      * @param x_jrad_ref_path MDS Reference Path
163      * @rep:scope public
164      * @rep:lifecycle active
165      * @rep:displayname Create/Update Form Function
166      * @rep:compatibility S
167      * @rep:ihelp FND/@dev_sp_subfunc#dev_sp_subfunc See the related online help
168      */
169 procedure LOAD_ROW (
170   X_FUNCTION_NAME in VARCHAR2,
171   X_APPLICATION_SHORT_NAME in VARCHAR2,
172   X_FORM_NAME in VARCHAR2,
173   X_PARAMETERS in VARCHAR2,
174   X_TYPE in VARCHAR2,
175   X_WEB_HOST_NAME in VARCHAR2,
176   X_WEB_AGENT_NAME in VARCHAR2,
177   X_WEB_HTML_CALL in VARCHAR2,
178   X_WEB_ENCRYPT_PARAMETERS in VARCHAR2,
179   X_WEB_SECURED in VARCHAR2,
180   X_WEB_ICON in VARCHAR2,
181   X_OBJECT_NAME in VARCHAR2,
182   X_REGION_APPLICATION_NAME in VARCHAR2,
183   X_REGION_CODE in VARCHAR2,
184   X_USER_FUNCTION_NAME in VARCHAR2,
185   X_DESCRIPTION in VARCHAR2,
186   X_OWNER in VARCHAR2,
187   X_CUSTOM_MODE in VARCHAR2,
188   X_LAST_UPDATE_DATE in VARCHAR2,
189   X_MAINTENANCE_MODE_SUPPORT in VARCHAR2,
190   X_CONTEXT_DEPENDENCE in VARCHAR2,
191   X_JRAD_REF_PATH in VARCHAR2 default NULL
192 );
193 
194 /* Overloaded version above.  This version DOES have new */
195 /* LAST_UPDATE_DATE */
196 /* columns, so this API should be used for new code. */
197 procedure TRANSLATE_ROW (
198   X_FUNCTION_ID in NUMBER,
199   X_USER_FUNCTION_NAME in VARCHAR2,
200   X_DESCRIPTION in VARCHAR2,
201   X_OWNER in VARCHAR2,
202   X_CUSTOM_MODE in VARCHAR2,
203   X_LAST_UPDATE_DATE in VARCHAR2);
204 
205 /* Overloaded version above.  This version DOES have new */
206 /* MAINTENANCE_MODE_SUPPORT,  CONTEXT_DEPENDENCE, JRAD_REF_PATH */
207 /* columns, so this API should be used for new code. */
208 procedure INSERT_ROW (
209   X_ROWID in out nocopy VARCHAR2,
210   X_FUNCTION_ID in NUMBER,
211   X_WEB_HOST_NAME in VARCHAR2,
212   X_WEB_AGENT_NAME in VARCHAR2,
213   X_WEB_HTML_CALL in VARCHAR2,
214   X_WEB_ENCRYPT_PARAMETERS in VARCHAR2,
215   X_WEB_SECURED in VARCHAR2,
216   X_WEB_ICON in VARCHAR2,
217   X_OBJECT_ID in NUMBER,
218   X_REGION_APPLICATION_ID in NUMBER,
219   X_REGION_CODE in VARCHAR2,
220   X_FUNCTION_NAME in VARCHAR2,
221   X_APPLICATION_ID in NUMBER,
222   X_FORM_ID in NUMBER,
223   X_PARAMETERS in VARCHAR2,
224   X_TYPE in VARCHAR2,
225   X_USER_FUNCTION_NAME in VARCHAR2,
226   X_DESCRIPTION in VARCHAR2,
227   X_CREATION_DATE in DATE,
228   X_CREATED_BY in NUMBER,
229   X_LAST_UPDATE_DATE in DATE,
230   X_LAST_UPDATED_BY in NUMBER,
231   X_LAST_UPDATE_LOGIN in NUMBER,
232   X_MAINTENANCE_MODE_SUPPORT in VARCHAR2,
233   X_CONTEXT_DEPENDENCE in VARCHAR2,
234   X_JRAD_REF_PATH in VARCHAR2 default NULL
235 );
236 
237 /* Overloaded version above.  This version DOES have new */
238 /* MAINTENANCE_MODE_SUPPORT,  CONTEXT_DEPENDENCE, JRAD_REF_PATH */
239 /* columns, so this API should be used for new code. */
240 procedure LOCK_ROW (
241   X_FUNCTION_ID in NUMBER,
242   X_WEB_HOST_NAME in VARCHAR2,
243   X_WEB_AGENT_NAME in VARCHAR2,
244   X_WEB_HTML_CALL in VARCHAR2,
245   X_WEB_ENCRYPT_PARAMETERS in VARCHAR2,
246   X_WEB_SECURED in VARCHAR2,
247   X_WEB_ICON in VARCHAR2,
248   X_OBJECT_ID in NUMBER,
249   X_REGION_APPLICATION_ID in NUMBER,
250   X_REGION_CODE in VARCHAR2,
251   X_FUNCTION_NAME in VARCHAR2,
252   X_APPLICATION_ID in NUMBER,
253   X_FORM_ID in NUMBER,
254   X_PARAMETERS in VARCHAR2,
255   X_TYPE in VARCHAR2,
256   X_USER_FUNCTION_NAME in VARCHAR2,
257   X_DESCRIPTION in VARCHAR2,
258   X_MAINTENANCE_MODE_SUPPORT in VARCHAR2,
259   X_CONTEXT_DEPENDENCE in VARCHAR2,
260   X_JRAD_REF_PATH in VARCHAR2 default NULL
261 );
262 
263 /* Overloaded version above.  This version DOES have new */
264 /* MAINTENANCE_MODE_SUPPORT,  CONTEXT_DEPENDENCE, JRAD_REF_PATH */
265 /* columns, so this API should be used for new code. */
266 procedure UPDATE_ROW (
267   X_FUNCTION_ID in NUMBER,
268   X_WEB_HOST_NAME in VARCHAR2,
269   X_WEB_AGENT_NAME in VARCHAR2,
270   X_WEB_HTML_CALL in VARCHAR2,
271   X_WEB_ENCRYPT_PARAMETERS in VARCHAR2,
272   X_WEB_SECURED in VARCHAR2,
273   X_WEB_ICON in VARCHAR2,
274   X_OBJECT_ID in NUMBER,
275   X_REGION_APPLICATION_ID in NUMBER,
276   X_REGION_CODE in VARCHAR2,
277   X_FUNCTION_NAME in VARCHAR2,
278   X_APPLICATION_ID in NUMBER,
279   X_FORM_ID in NUMBER,
280   X_PARAMETERS in VARCHAR2,
281   X_TYPE in VARCHAR2,
282   X_USER_FUNCTION_NAME in VARCHAR2,
283   X_DESCRIPTION in VARCHAR2,
284   X_LAST_UPDATE_DATE in DATE,
285   X_LAST_UPDATED_BY in NUMBER,
286   X_LAST_UPDATE_LOGIN in NUMBER,
287   X_MAINTENANCE_MODE_SUPPORT in VARCHAR2,
288   X_CONTEXT_DEPENDENCE in VARCHAR2,
289   X_JRAD_REF_PATH in VARCHAR2 default NULL
290 );
291 
292 /* Function Maintenance Mode can be: FUZZY, MAINT, NONE, QUERY and OFFLINE */
293 /* Please refer to LOOKUP_TYPE APPS_MAINTENANCE_MODE_SUPPORT for these */
294 /* value and description */
295 /* Input                 */
296 /*   x_function_name : specific function name or a wildcard function name */
297 /*   x_function_mode : the value of the maintenance_mode_support */
298 
299 procedure SET_FUNCTION_MODE (x_function_name in varchar2,
300                              x_function_mode in varchar2);
301 
302 function FUNCTION_VALIDATION (application_id in out nocopy number,
303                                form_id in out nocopy number,
304                                type in out nocopy varchar2,
305                                parameters in out nocopy varchar2,
306                                web_html_call in out nocopy varchar2,
307                                web_host_name in varchar2,
308                                region_application_id in out nocopy number,
309                                region_code in out nocopy varchar2,
310                                function_name in varchar2) return varchar2;
311 
312 
313 end FND_FORM_FUNCTIONS_PKG;