1 package FND_RUN_FUNCTION as
2 /* $Header: AFRFS.pls 120.3.12010000.2 2008/11/21 20:27:19 jvalenti 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 */
59 function get_run_function_url ( p_function_id in number,
60 p_resp_appl_id in number,
61 p_resp_id in number,
62 p_security_group_id in number,
63 p_parameters in varchar2 default null,
64 p_override_agent in varchar2 default null,
65 p_org_id in number default null,
66 p_lang_code in varchar2 default null,
67 p_encryptParameters in boolean default true )
68 return varchar2;
69
70
71 --
72 -- Version of get_run_function_url that takes names instead of ID's.
73 --
74 /*#
75 * Returns a URL to execute the specified function, using the security
76 * context specified by the responsibility and security group parameters.
77 * If the responsibility is not known in advance, nulls can be passed
78 * and the user will be presented with a list of responsibilities that
79 * the function is available in, after navigating to the URL.
80 *
81 * @param p_function_name the function to execute
82 * @param p_resp_appl the application to execute the function in
83 * @param p_resp_key the responsibility to execute the function in
84 * @param p_security_group_key the security group to execute the function in
85 * @param p_parameters if the specified function takes any parameters,
86 * these can be passed here
87 * @param p_override_agent overrides the default jsp agent for the
88 * resulting link - intended for internal use
89 * @param p_org_id if no responsibility is passed, this can be used
90 * to limit the responsibility list that guest displayed
91 * This should be left as null if a responsibility
92 * is explicitly specified.
93 * @param p_lang_code if the url requires the user to authenticate,
94 * the login page will be displayed in this language
95 * If the user is already authenticated, this will not
96 * override the user's language preferences.
97 *
98 * @param p_encryptParameters boolean that is defaulted to true to always
99 * encrypt.
100 * @return run function URL.
101 * @rep:displayname Get Run Function URL
102 */
103 function get_run_function_url ( p_function_name in varchar2,
104 p_resp_appl in varchar2,
105 p_resp_key in varchar2,
106 p_security_group_key in varchar2,
107 p_parameters in varchar2 default null,
108 p_override_agent in varchar2 default null,
109 p_org_id in number default null,
110 p_lang_code in varchar2 default null,
111 p_encryptParameters in boolean default true )
112 return varchar2;
113
114
115 --
116 -- Generates a link automatically - returns HTML of the form
117 -- <a href=...> .. </a>
118 -- which will run the specified function in the given responsibility.
119 --
120 -- If called on a function of type 'FORM', make sure the output from
121 -- 'get_forms_launcher_setup' is run first.
122 --
123 /*#
124 * Returns the same url as get_run_function_url, but embedded in a
125 * full HTML link (ie, "<a href="..url..">..</a>").
126 *
127 * @param p_text the text to display in the HTML link
128 * @param p_target the HTML target for the link
129 * @param p_function_id the function to execute
130 * @param p_resp_appl_id the application to execute the function in
131 * @param p_resp_id the responsibility to execute the function in
132 * @param p_security_group_id the security group to execute the function in
133 * @param p_parameters if the specified function takes any parameters,
134 * these can be passed here
135 * @param p_override_agent overrides the default jsp agent for the
136 * resulting link - intended for internal use
137 * @param p_org_id if no responsibility is passed, this can be used
138 * to limit the responsibility list that guest displayed
139 * This should be left as null if a responsibility
140 * is explicitly specified.
141 * @param p_lang_code if the url requires the user to authenticate,
142 * the login page will be displayed in this language
143 * If the user is already authenticated, this will not
144 * override the user's language prefences.
145 * preferences.
146 * @param p_encryptParameters boolean that is defaulted to true to always
147 * encrypt.
148 * @return run function link.
149 * @rep:displayname Get Run Function Link
150 */
151 function get_run_function_link ( p_text in varchar2,
152 p_target in varchar2,
153 p_function_id in number,
154 p_resp_appl_id in number,
155 p_resp_id in number,
156 p_security_group_id in number,
157 p_parameters in varchar2 default null,
158 p_override_agent in varchar2 default null,
159 p_org_id in number default null,
160 p_lang_code in varchar2 default null,
161 p_encryptParameters in boolean default true )
162 return varchar2;
163
164
165 --
166 -- Version of get_run_function_link that takes names instead of ID's.
167 --
168 /*#
169 * Returns the same url as get_run_function_url, but embedded in a
170 * full HTML link (ie, "<a href="..url..">..</a>").
171 *
172 * @param p_text the text to display in the HTML link
173 * @param p_target the HTML target for the link
174 *
175 * @param p_function_name the function to execute
176 * @param p_resp_appl the application to execute the function in
177 * @param p_resp_key the responsibility to execute the function in
178 * @param p_security_group_key the security group to execute the function in
179 * @param p_parameters if the specified function takes any parameters,
180 * these can be passed here
181 * @param p_override_agent overrides the default jsp agent for the
182 * resulting link - intended for internal use
183 * @param p_org_id if no responsibility is passed, this can be used
184 * to limit the responsibility list that guest displayed
185 * This should be left as null if a responsibility
186 * is explicitly specified.
187 * @param p_lang_code if the url requires the user to authenticate,
188 * the login page will be displayed in this language
189 * If the user is already authenticated, this will not
190 * override the user's language preferences.
191 * @param p_encryptParameters boolean that is defaulted tp true to always
192 * encrypt.
193 *
194 * @return Run function link.
195 * @rep:displayname Get Run Function Link
196 */
197 function get_run_function_link ( p_text in varchar2,
198 p_target in varchar2,
199 p_function_name in varchar2,
200 p_resp_appl in varchar2,
201 p_resp_key in varchar2,
202 p_security_group_key in varchar2,
203 p_parameters in varchar2 default null,
204 p_override_agent in varchar2 default null,
205 p_org_id in number default null,
206 p_lang_code in varchar2 default null,
207 p_encryptParameters in boolean default true )
208 return varchar2;
209
210 end FND_RUN_FUNCTION;
[Home] [Help]