DBA Data[Home] [Help]

PACKAGE: APPS.WMS_INSTALL

Source


1 PACKAGE WMS_INSTALL  AUTHID CURRENT_USER AS
2 /* $Header: WMSINSTS.pls 120.1 2005/06/15 13:41:30 appldev  $ */
3 /*#
4  * This package provides routine to verify that Oracle Warehouse Management
5  * (WMS) is installed in the system and to determine whether or not an
6  * organization is WMS enabled.
7  * @rep:scope public
8  * @rep:product WMS
9  * @rep:lifecycle active
10  * @rep:displayname WMS Install
11  * @rep:category BUSINESS_ENTITY WMS_INSTALL
12  */
13 /*
14 ** -------------------------------------------------------------------------
15 ** To prevent requery of database as much as possible within the same session,
16 ** the following global variables are cached and used suitably:
17 **
18 ** g_wms_installation_status :
19 ** 	If 'I', indicates product WMS is installed
20 ** g_organization_id:
21 **	The last organization that was checked if WMS enabled
22 ** g_wms_enabled_flag :
23 **	Indicates if the last organization checked is WMS enabled or not
24 ** -------------------------------------------------------------------------
25 */
26 g_wms_installation_status varchar2(10);
27 g_organization_id         number;
28 g_wms_enabled_flag        varchar2(1);
29 
30 /*
31 ** -------------------------------------------------------------------------
32 ** Function:    check_install
33 ** Description: Checks to see if WMS is installed
34 ** Output:
35 **      x_return_status
36 **              return status indicating success, error, unexpected error
37 **      x_msg_count
38 **              number of messages in message list
39 **      x_msg_data
40 **              if the number of messages in message list is 1, contains
41 **              message text
42 ** Input:
43 **      p_organization_id
44 **	       -specific organization to be checked if WMS enabled.
45 **
46 **	       -if NULL, the check is just made at site level
47 **              and not for any specific organization.This is more relaxed than
48 **              passing a specific organization.
49 ** Returns:
50 **      TRUE if WMS installed, else FALSE
51 **
52 **      Please use return value to determine if WMS is installed or not.
53 **      Do not use x_return_status for this purpose as
54 **      . x_return_status could be success and yet WMS not be installed.
55 **      . x_return_status is set to error when an error(such as SQL error)
56 **        occurs.
57 ** --------------------------------------------------------------------------
58 */
59 
60 /*#
61  * This routine can be used to check if Warehouse Management System is installed
62  * and if an organization is WMS enabled.
63  * @param x_return_status return variable holding the status of the procedure call
64  * @param x_msg_count return variable holding the number of error messages returned
65  * @param x_msg_data return variable holding the error message
66  * @param p_organization_id specific organization to be checked if WMS enabled. if NULL, the check is just made at site level
67  * @return if wms is installed or if the organization is wms enabled
68  * @rep:displayname Check Install
69 */
70 function check_install (
71   x_return_status               OUT NOCOPY VARCHAR2
72 , x_msg_count                   OUT NOCOPY NUMBER
73 , x_msg_data                    OUT NOCOPY VARCHAR2
74 , p_organization_id             IN         NUMBER ) return boolean;
75 
76 end WMS_INSTALL;