1 package FND_RUN_FUNCTION AUTHID CURRENT_USER as
2 /* $Header: AFRFS.pls 120.5.12020000.1 2012/06/30 13:19:06 appldev ship $ */
3 /*#
4 * This is the public interface for generating URL's for executing functions
5 * It is used primarily by the workflow engine.
6 * @rep:scope public
7 * @rep:product FND
8 * @rep:displayname Function Security Navigation
9 * @rep:category BUSINESS_ENTITY FND_NAVIGATION
10 */
11
12
13 --
14 -- Returns iframe and JavaScript initialization code needed by the
15 -- Forms Launcher.
16 --
17 /*#
18 * Returns HTML (iframe tag and javascript code) that should be output
19 * to any page which contains links generated by 'get_run_function_link'
20 * to execute FORM functions.
21 *
22 * @return HTML iframe tag and javascript code.
23 * @rep:displayname Get Forms Launcher Setup
24 */
25 function get_forms_launcher_setup return varchar2;
26
27
28 --
29 -- Returns the URL to run the specified function in the given responsibility.
30 --
31 /*#
32 * Returns a URL to execute the specified function, using the security
33 * context specified by the responsibility and security group parameters.
34 * If the responsibility is not known in advance, nulls can be passed
35 * and the user will be presented with a list of responsibilities that
36 * the function is available in, after navigating to the URL.
37 *
38 * @param p_function_id the function to execute
39 * @param p_resp_appl_id the application to execute the function in
40 * @param p_resp_id the responsibility to execute the function in
41 * @param p_security_group_id the security group to execute the function in
42 * @param p_parameters if the specified function takes any parameters,
43 * these can be passed here
44 * @param p_override_agent overrides the default jsp agent for the
45 * resulting link - intended for internal use
46 * @param p_org_id if no responsibility is passed, this can be used
47 * to limit the responsibility list that guest displayed.
48 * This should be left as null if a responsibility
49 * is explicitly specified.
50 * @param p_lang_code if the url requires the user to authenticate,
51 * the login page will be displayed in this language.
52 * If the user is already authenticated, this will not
53 * override the user's language preferences.
54 * @param p_encryptParameters boolean that is defaulted to true to always
55 * encrypt.
56 * @return run function URL.
57 * @rep:displayname Get Run Function URL
58 * @rep:scope public
59 */
60 function get_run_function_url ( p_function_id in number,
61 p_resp_appl_id in number,
62 p_resp_id in number,
63 p_security_group_id in number,
64 p_parameters in varchar2 default null,
65 p_override_agent in varchar2 default null,
66 p_org_id in number default null,
67 p_lang_code in varchar2 default null,
68 p_encryptParameters in boolean default true )
69 return varchar2;
70
71
72 --
73 -- Version of get_run_function_url that takes names instead of ID's.
74 --
75 /*#
76 * Returns a URL to execute the specified function, using the security
77 * context specified by the responsibility and security group parameters.
78 * If the responsibility is not known in advance, nulls can be passed
79 * and the user will be presented with a list of responsibilities that
80 * the function is available in, after navigating to the URL.
81 *
82 * @param p_function_name the function to execute
83 * @param p_resp_appl the application to execute the function in
84 * @param p_resp_key the responsibility to execute the function in
85 * @param p_security_group_key the security group to execute the function in
86 * @param p_parameters if the specified function takes any parameters,
87 * these can be passed here
88 * @param p_override_agent overrides the default jsp agent for the
89 * resulting link - intended for internal use
90 * @param p_org_id if no responsibility is passed, this can be used
91 * to limit the responsibility list that guest displayed
92 * This should be left as null if a responsibility
93 * is explicitly specified.
94 * @param p_lang_code if the url requires the user to authenticate,
95 * the login page will be displayed in this language
96 * If the user is already authenticated, this will not
97 * override the user's language preferences.
98 *
99 * @param p_encryptParameters boolean that is defaulted to true to always
100 * encrypt.
101 * @return run function URL.
102 * @rep:displayname Get Run Function URL
103 * @rep:scope public
104 */
105 function get_run_function_url ( p_function_name in varchar2,
106 p_resp_appl in varchar2,
107 p_resp_key in varchar2,
108 p_security_group_key in varchar2,
109 p_parameters in varchar2 default null,
110 p_override_agent in varchar2 default null,
111 p_org_id in number default null,
112 p_lang_code in varchar2 default null,
113 p_encryptParameters in boolean default true )
114 return varchar2;
115
116
117 --
118 -- Generates a link automatically - returns HTML of the form
119 -- <a href=...> .. </a>
120 -- which will run the specified function in the given responsibility.
121 --
122 -- If called on a function of type 'FORM', make sure the output from
123 -- 'get_forms_launcher_setup' is run first.
124 --
125 /*#
126 * Returns the same url as get_run_function_url, but embedded in a
127 * full HTML link (ie, "<a href="..url..">..</a>").
128 *
129 * @param p_text the text to display in the HTML link
130 * @param p_target the HTML target for the link
131 * @param p_function_id the function to execute
132 * @param p_resp_appl_id the application to execute the function in
133 * @param p_resp_id the responsibility to execute the function in
134 * @param p_security_group_id the security group to execute the function in
135 * @param p_parameters if the specified function takes any parameters,
136 * these can be passed here
137 * @param p_override_agent overrides the default jsp agent for the
138 * resulting link - intended for internal use
139 * @param p_org_id if no responsibility is passed, this can be used
140 * to limit the responsibility list that guest displayed
141 * This should be left as null if a responsibility
142 * is explicitly specified.
143 * @param p_lang_code if the url requires the user to authenticate,
144 * the login page will be displayed in this language
145 * If the user is already authenticated, this will not
146 * override the user's language prefences.
147 * preferences.
148 * @param p_encryptParameters boolean that is defaulted to true to always
149 * encrypt.
150 * @return run function link.
151 * @rep:displayname Get Run Function Link
152 */
153 function get_run_function_link ( p_text in varchar2,
154 p_target in varchar2,
155 p_function_id in number,
156 p_resp_appl_id in number,
157 p_resp_id in number,
158 p_security_group_id in number,
159 p_parameters in varchar2 default null,
160 p_override_agent in varchar2 default null,
161 p_org_id in number default null,
162 p_lang_code in varchar2 default null,
163 p_encryptParameters in boolean default true )
164 return varchar2;
165
166
167 --
168 -- Version of get_run_function_link that takes names instead of ID's.
169 --
170 /*#
171 * Returns the same url as get_run_function_url, but embedded in a
172 * full HTML link (ie, "<a href="..url..">..</a>").
173 *
174 * @param p_text the text to display in the HTML link
175 * @param p_target the HTML target for the link
176 *
177 * @param p_function_name the function to execute
178 * @param p_resp_appl the application to execute the function in
179 * @param p_resp_key the responsibility to execute the function in
180 * @param p_security_group_key the security group to execute the function in
181 * @param p_parameters if the specified function takes any parameters,
182 * these can be passed here
183 * @param p_override_agent overrides the default jsp agent for the
184 * resulting link - intended for internal use
185 * @param p_org_id if no responsibility is passed, this can be used
186 * to limit the responsibility list that guest displayed
187 * This should be left as null if a responsibility
188 * is explicitly specified.
189 * @param p_lang_code if the url requires the user to authenticate,
190 * the login page will be displayed in this language
191 * If the user is already authenticated, this will not
192 * override the user's language preferences.
193 * @param p_encryptParameters boolean that is defaulted tp true to always
194 * encrypt.
195 *
196 * @return Run function link.
197 * @rep:displayname Get Run Function Link
198 */
199 function get_run_function_link ( p_text in varchar2,
200 p_target in varchar2,
201 p_function_name in varchar2,
202 p_resp_appl in varchar2,
203 p_resp_key in varchar2,
204 p_security_group_key in varchar2,
205 p_parameters in varchar2 default null,
206 p_override_agent in varchar2 default null,
207 p_org_id in number default null,
208 p_lang_code in varchar2 default null,
209 p_encryptParameters in boolean default true )
210 return varchar2;
211
212 end FND_RUN_FUNCTION;
[Home] [Help]