DBA Data[Home] [Help]

PACKAGE: APPS.BSC_LAUNCH_PAD_PVT

Source


1 PACKAGE BSC_LAUNCH_PAD_PVT AUTHID CURRENT_USER AS
2 /* $Header: BSCLPADS.pls 115.6 2003/12/17 05:26:09 ashankar ship $ */
3 
4 /* --------------------------APPS MENUS -------------------------*/
5 /*===========================================================================+
6 |
7 |   Name:          INSERT_APP_MENU_VB
8 |
9 |   Description:   it is a wrapper for FND_MENUS_PKG.INSERT_ROW function
10 |		   This procedure is to be called from a VB program.
11 |                  If there is an error, the procedure inserts the error
12 |                  message in BSC_MESSAGE_LOGS table.
13 |
14 |   Parameters:	 x_menu_id - Menu id
15 |		 x_menu_name  - Menu Name
16 |		 x_user_menu_name - User Menu Name
17 |		 x_menu_type	  - Menu Type
18 |		 x_description    - Description
19 |		 x_user id 	  -User Id
20 |
21 |   Notes:
22 |
23 +============================================================================*/
24 PROCEDURE INSERT_APP_MENU_VB(X_MENU_ID in NUMBER,
25 	  X_MENU_NAME in VARCHAR2,
26 	  X_USER_MENU_NAME in VARCHAR2,
27 	  X_MENU_TYPE    in VARCHAR2,
28 	  X_DESCRIPTION in VARCHAR2,
29 	  X_USER_ID in NUMBER
30 	);
31 /*===========================================================================+
32 |
33 |   Name:          UPDATE_APP_MENU_VB
34 |
35 |   Description:   it is a wrapper for FND_MENUS_PKG.UPDATE_ROW function
36 |		   This procedure is to be called from a VB program.
37 |                  If there is an error, the procedure inserts the error
38 |                  message in BSC_MESSAGE_LOGS table.
39 |
40 |   Parameters:	 x_menu_id - Menu id
41 |		 x_menu_name  - Menu Name
42 |		 x_user_menu_name - User Menu Name
43 |		 x_menu_type	  - Menu Type
44 |		 x_description    - Description
45 |		 x_user id 	  -User Id
46 |
47 |   Notes:
48 |
49 +============================================================================*/
50 PROCEDURE UPDATE_APP_MENU_VB(X_MENU_ID in NUMBER,
51 	  X_MENU_NAME in VARCHAR2,
52 	  X_USER_MENU_NAME in VARCHAR2,
53 	  X_MENU_TYPE    in VARCHAR2,
54 	  X_DESCRIPTION in VARCHAR2,
55 	  X_USER_ID in NUMBER
56 	);
57 /*===========================================================================+
58 |
59 |   Name:          DELETE_APP_MENU_VB
60 |
61 |   Description:   it is a wrapper for FND_MENUS_PKG.DELETE_ROW function
62 |		   This procedure is to be called from a VB program.
63 |                  If there is an error, the procedure inserts the error
64 |                  message in BSC_MESSAGE_LOGS table.
65 |
66 |   Parameters:	 x_menu_id - Menu id
67 |
68 |   Notes:
69 |
70 +============================================================================*/
71 PROCEDURE DELETE_APP_MENU_VB(X_MENU_ID in NUMBER
72 	);
73 
74 /*===========================================================================+
75 |
76 |   Name:          CHECK_MENU_NAMES
77 |
78 |   Description:   Check if the menu name and User name are unique to
79 |		   insert as a new menu.
80 |   Return :       'N' : Name Invalid, The name alreday exist
81 |                  'U' : User Name Invalid, The user name alreday exist
82 |                  'T' : True , The names don't exist. It can be added
83 |   Parameters:    X_MENU_ID 		Menu Id that will be inserted
84 | 	   	   X_MENU_NAME  	Menu Name
85 |      		   X_USER_MENU_NAME 	User Menu Name
86 +============================================================================*/
87 FUNCTION  CHECK_MENU_NAMES(X_MENU_ID in NUMBER,
88 	  X_MENU_NAME in VARCHAR2,
89 	  X_USER_MENU_NAME in VARCHAR2
90 	) RETURN VARCHAR2;
91 PRAGMA RESTRICT_REFERENCES(CHECK_MENU_NAMES, WNDS);
92 /* --------------------------FORM FUNCTIONS -------------------------*/
93 /*===========================================================================+
94 |
95 |   Name:          INSERT_FORM_FUNCTION_VB
96 |
97 |   Description:   it is a wrapper for FND_FORM_FUNCTIONS_PKG.INSERT_ROW function
98 |		   This procedure is to be called from a VB program.
99 |                  If there is an error, the procedure inserts the error
100 |                  message in BSC_MESSAGE_LOGS table.
101 |
102 |   Parameters:
103 +============================================================================*/
104 PROCEDURE INSERT_FORM_FUNCTION_VB(X_FUNCTION_ID in NUMBER,
105 	  X_WEB_HOST_NAME in VARCHAR2,
106 	  X_WEB_AGENT_NAME in VARCHAR2,
107 	  X_WEB_HTML_CALL in VARCHAR2,
108 	  X_WEB_ENCRYPT_PARAMETERS in VARCHAR2,
109 	  X_WEB_SECURED in  VARCHAR2,
110 	  X_WEB_ICON  in VARCHAR2,
111 	  X_OBJECT_ID  in NUMBER,
112 	  X_REGION_APPLICATION_ID in NUMBER,
113 	  X_REGION_CODE  in VARCHAR2,
114 	  X_FUNCTION_NAME in VARCHAR2,
115 	  X_APPLICATION_ID in NUMBER,
116 	  X_FORM_ID  in NUMBER,
117 	  X_PARAMETERS in VARCHAR2,
118 	  X_TYPE    in VARCHAR2,
119 	  X_USER_FUNCTION_NAME in VARCHAR2,
120 	  X_DESCRIPTION in VARCHAR2,
121 	  X_USER_ID in NUMBER
122 	);
123 /*===========================================================================+
124 |
125 |   Name:          UPDATE_FORM_FUNCTION_VB
126 |
127 |   Description:   it is a wrapper for FND_FORM_FUNCTIONS_PKG.UPDATE_ROW function
128 |		   This procedure is to be called from a VB program.
129 |                  If there is an error, the procedure inserts the error
130 |                  message in BSC_MESSAGE_LOGS table.
131 |
132 |   Parameters:
133 +============================================================================*/
134 PROCEDURE UPDATE_FORM_FUNCTION_VB(X_FUNCTION_ID in NUMBER,
135 	  X_WEB_HOST_NAME in VARCHAR2,
136 	  X_WEB_AGENT_NAME in VARCHAR2,
137 	  X_WEB_HTML_CALL in VARCHAR2,
138 	  X_WEB_ENCRYPT_PARAMETERS in VARCHAR2,
139 	  X_WEB_SECURED in  VARCHAR2,
140 	  X_WEB_ICON  in VARCHAR2,
141 	  X_OBJECT_ID  in NUMBER,
142 	  X_REGION_APPLICATION_ID in NUMBER,
143 	  X_REGION_CODE  in VARCHAR2,
144 	  X_FUNCTION_NAME in VARCHAR2,
145 	  X_APPLICATION_ID in NUMBER,
146 	  X_FORM_ID  in NUMBER,
147 	  X_PARAMETERS in VARCHAR2,
148 	  X_TYPE    in VARCHAR2,
149 	  X_USER_FUNCTION_NAME in VARCHAR2,
150 	  X_DESCRIPTION in VARCHAR2,
151 	  X_USER_ID in NUMBER
152 	);
153 /*===========================================================================+
154 |
155 |   Name:          DELETE_FORM_FUNCTION_VB
156 |
157 |   Description:   it is a wrapper for FND_FORM_FUNCTIONS_PKG.DELETE_ROW function
158 |		   This procedure is to be called from a VB program.
159 |                  If there is an error, the procedure inserts the error
160 |                  message in BSC_MESSAGE_LOGS table.
161 |
162 |   Parameters:
163 +============================================================================*/
164 PROCEDURE DELETE_FORM_FUNCTION_VB(X_FUNCTION_ID in NUMBER
165 	);
166 /*===========================================================================+
167 | FUNCTION CHECK_FUNCTION_NAMES
168 |
169 |   Name:          CHECK_FUNCTION_NAMES
170 |
171 |   Description:   Check if the fucntion name and User name are unique to
172 |		   insert as a new function.
173 |   Return :       'N' : Name Invalid, The name alreday exist
174 |                  'U' : User Name Invalid, The user name alreday exist
175 |                  'T' : True , The names don't exist. It can be added
176 |   Parameters:    X_FUNCTION_ID 		Menu Id that will be inserted
177 | 	   	   X_FUNCTION_NAME  	Menu Name
178 |      		   X_USER_FUNCTION_NAME	User Menu Name
179 +============================================================================*/
180 
181 FUNCTION  CHECK_FUNCTION_NAMES(X_FUNCTION_ID in NUMBER,
182 	  X_FUNCTION_NAME in VARCHAR2,
183 	  X_USER_FUNCTION_NAME in VARCHAR2
184 	) RETURN VARCHAR2;
185 PRAGMA RESTRICT_REFERENCES(CHECK_FUNCTION_NAMES, WNDS);
186 
187 /* --------------------------APPS MENU-ENTRIES -------------------------*/
188 /*===========================================================================+
189 |
190 |   Name:          INSERT_APP_MENU_ENTRIES_VB
191 |
192 |   Description:   it is a wrapper for FND_MENU_ENTRIES_PKG.INSERT_ROW  function
193 |		   This procedure is to be called from a VB program.
194 |                  If there is an error, the procedure inserts the error
195 |                  message in BSC_MESSAGE_LOGS table.
196 |
197 |   Parameters:
198 +============================================================================*/
199 PROCEDURE INSERT_APP_MENU_ENTRIES_VB(X_MENU_ID in NUMBER,
200 	  X_ENTRY_SEQUENCE in NUMBER,
201 	  X_SUB_MENU_ID  in NUMBER,
202 	  X_FUNCTION_ID in NUMBER,
203 	  X_GRANT_FLAG  in VARCHAR2,
204 	  X_PROMPT      in VARCHAR2,
205 	  X_DESCRIPTION in VARCHAR2,
206 	  X_USER_ID in NUMBER
207 	);
208 /*===========================================================================+
209 |
210 |   Name:          UPDATE_APP_MENU_ENTRIES_VB
211 |
212 |   Description:   it is a wrapper for FND_MENU_ENTRIES_PKG.UPDATE_ROW  function
213 |		   This procedure is to be called from a VB program.
214 |                  If there is an error, the procedure inserts the error
215 |                  message in BSC_MESSAGE_LOGS table.
216 |
217 |   Parameters:
218 +============================================================================*/
219 PROCEDURE UPDATE_APP_MENU_ENTRIES_VB(X_MENU_ID in NUMBER,
220 	  X_ENTRY_SEQUENCE in NUMBER,
221 	  X_SUB_MENU_ID  in NUMBER,
222 	  X_FUNCTION_ID in NUMBER,
223 	  X_GRANT_FLAG  in VARCHAR2,
224 	  X_PROMPT      in VARCHAR2,
225 	  X_DESCRIPTION in VARCHAR2,
226 	  X_USER_ID in NUMBER
227 	);
228 /*===========================================================================+
229 |
230 |   Name:          DELETE_APP_MENU_ENTRIES_VB
231 |
232 |   Description:   it is a wrapper for FND_MENU_ENTRIES_PKG.DELETE_ROW  function
233 |		   This procedure is to be called from a VB program.
234 |                  If there is an error, the procedure inserts the error
235 |                  message in BSC_MESSAGE_LOGS table.
236 |
237 |   Parameters:
238 +============================================================================*/
239 PROCEDURE DELETE_APP_MENU_ENTRIES_VB(X_MENU_ID in NUMBER,
240 	  X_ENTRY_SEQUENCE in NUMBER
241 	);
242 
243 /* --------------------------APPS SECURITY -------------------------*/
244 /*===========================================================================+
245 |
246 |   Name:          SECURITY_RULE_EXISTS_VB
247 |
248 |   Description:   it is a wrapper for FND_FUNCTION_SECURITY.SECURITY_RULE_EXISTS function
249 |		   This procedure is to be called from a VB program.
250 |                  If there is an error, the procedure inserts the error
251 |                  message in BSC_MESSAGE_LOGS table.
252 |
253 |   Parameters:
254 +============================================================================*/
255 FUNCTION SECURITY_RULE_EXISTS_VB(responsibility_key in varchar2,
256 	  rule_type in varchar2 default 'F',  -- F = Function, M = Menu
257 	  rule_name in varchar2
258 	) RETURN VARCHAR2;
259 /*===========================================================================+
260 | FUNCTION SECURITY_ACCESS_MENU
261 |
262 |   Name:          SECURITY_ACCESS_MENU
263 |
264 |   Description:   It verifies if a Responsibility has acces to a menu or not
265 |   Return :       'T' : It has access
266 |                  'F' : It doesn't have access
267 |   Parameters:    X_RESPO 		Responsibility
268 | 	   	   X_MENU_ID 		Menu Id
269 +============================================================================*/
270 
271 FUNCTION  SECURITY_ACCESS_MENU(X_RESPO in NUMBER,
272 	  X_MENU_ID  in NUMBER
273 	) RETURN VARCHAR2;
274 PRAGMA RESTRICT_REFERENCES(SECURITY_ACCESS_MENU, WNDS);
275 
276 
277 /*===========================================================================+
278 | FUNCTION Migrate_Custom_Links
279 |
280 |   Description:   Migrate custom links from the source system.
281 |                  It creates the menu in the target system in case it does
282 |                  not exist and it is a BSC menu.
283 |                  It creates unexisting BSC functions inside the menus.
284 |                  It never update or delete an existing menu or function.
285 |
286 |   Return :       TRUE : no errors
287 |                  FALSE : error
288 |
289 |   Parameters:    x_src_db_link	source db link.
290 +============================================================================*/
291 FUNCTION Migrate_Custom_Links(
292 	x_src_db_link IN VARCHAR2
293 	) RETURN BOOLEAN;
294 
295 
296 /*===========================================================================+
297 | FUNCTION Migrate_Custom_Links_Security
298 |
299 |   Description:   Assing the custom links (menus) to the target responsibility
300 |                  according to the source responsibility.
301 |                  Only add BSC menus to the target responsibility.
302 |
303 |   Return :       TRUE : no errors
304 |                  FALSE : error
305 |
306 +============================================================================*/
307 FUNCTION Migrate_Custom_Links_Security(
308 	x_trg_resp IN NUMBER,
309 	x_src_resp IN NUMBER,
310 	x_src_db_link IN VARCHAR2
311 	) RETURN BOOLEAN;
312 
313 
314 /*===========================================================================+
315 | FUNCTION is_Launch_Pad_Attached
316 |
317 |   Description:   This fucntion will validate whether the launchpad is attached
318 |                  to the root application menu or not
319 |   Return :       TRUE  : launchpad is attached
320 |                  FALSE : not attached
321 |
322 +============================================================================*/
323 FUNCTION is_Launch_Pad_Attached
324 (
325      p_Menu_Id        IN   FND_MENUS.menu_id%TYPE
326    , p_Sub_Menu_Id    IN   FND_MENUS.menu_id%TYPE
327 
328 ) RETURN BOOLEAN;
329 
330 /*===========================================================================+
331 | FUNCTION is_Launch_Pad_Attached
332 |
333 |   Description:   This function will return the entry sequence of the launchpad
334 |                  in the root application menu
335 |   Return :       entry sequence
336 |
337 +============================================================================*/
338 
339 FUNCTION get_entry_sequence
340 (
341      p_Menu_Id        IN  FND_MENUS.menu_id%TYPE
342    , p_Sub_Menu_Id    IN  FND_MENUS.menu_id%TYPE
343 ) RETURN NUMBER;
344 
345 END BSC_LAUNCH_PAD_PVT;