PACKAGE: APPS.GL_MANAGEMENT_SEGMENT_UPGRADE

Source

1 PACKAGE GL_MANAGEMENT_SEGMENT_UPGRADE AUTHID CURRENT_USER AS
2 /* $Header: glumsups.pls 120.1 2005/05/05 01:41:23 kvora ship $ */
3 --
4 -- Package
5 --   gl_management_segment_upgrade
6 -- Purpose
7 --   Package procedures for the Management Segment Upgrade Program
8 -- History
9 --   07-APR-04	T Cheng		Created
10 --
11 
12   --
13   -- PUBLIC FUNCTIONS
14   --
15 
16   --
17   -- Procedure
18   --   request_lock
19   -- Purpose
20   --   Allocate and request a user name lock. Returns TRUE if succeeded,
21   --   FALSE if failed.
22   -- Arguments
23   --   X_Chart_Of_Accounts_Id	Chart of accounts id
24   --   X_Lock_Mode		Lock mode
25   --   X_Timeout_Secs		Timeout in seconds
26   --   X_Keep_Trying		Whether to keep trying in case of timeout
27   --   X_Try_Times		Number of times to try
28   --   X_Wait_Secs		Time to wait before retry, in seconds
29   -- Example
30   --   GL_MAGAGEMENT_SEGMENT_UPGRADE.request_lock(101, DBMS_LOCK.x_mode,
31   --                                              60, 'Y', 10, 60);
32   -- Notes
33   --   Available lock modes from DBMS_LOCK:
34   --    nl_mode  constant integer := 1;
35   --    ss_mode  constant integer := 2;	-- Also called 'Intended Share'
36   --    sx_mode  constant integer := 3;	-- Also called 'Intended Exclusive'
37   --    s_mode   constant integer := 4;
38   --    ssx_mode constant integer := 5;
39   --    x_mode   constant integer := 6;
40   --
41   FUNCTION request_lock(
42     X_Chart_Of_Accounts_Id NUMBER,
43     X_Lock_Mode            INTEGER,
44     X_Timeout_Secs         INTEGER DEFAULT 1,
45     X_Keep_Trying          BOOLEAN DEFAULT FALSE,
46     X_Try_Times            NUMBER DEFAULT 1,
47     X_Wait_Secs            NUMBER DEFAULT 60) RETURN BOOLEAN;
48 
49   --
50   -- Procedure
51   --   release_lock
52   -- Purpose
53   --   Allocate and release a user name lock. Returns TRUE if succeeded,
54   --   FALSE if failed.
55   -- Arguments
56   --   X_Chart_Of_Accounts_Id	Chart of accounts id
57   -- Example
58   --   GL_MAGAGEMENT_SEGMENT_UPGRADE.release_lock(101);
59   -- Notes
60   --
61   FUNCTION release_lock(X_Chart_Of_Accounts_Id NUMBER) RETURN BOOLEAN;
62 
63   --
64   -- Procedure
65   --   Setup_Upgrade
66   -- Purpose
67   --
68   -- Arguments
69   --   X_Chart_Of_Accounts_Id	Chart of accounts ID
70   --   X_Mgt_Seg_Column_Name	Column name of the selected management segment
71   -- Example
72   --   GL_MANAGEMENT_SEGMENT_UPGRADE.Setup_Upgrade
73   --                                   (errbuf, retcode, 101, 'SEGMENT2');
74   -- Notes
75   --
76   PROCEDURE Setup_Upgrade(
77     X_Errbuf                OUT NOCOPY VARCHAR2,
78     X_Retcode               OUT NOCOPY VARCHAR2,
79     X_Chart_Of_Accounts_Id  NUMBER,
80     X_Mgt_Seg_Column_Name   VARCHAR2);
81 
82   --
83   -- Procedure
84   --   Process_Incremental_Data
85   -- Purpose
86   --
87   -- Arguments
88   --   X_Chart_Of_Accounts_Id	Chart of accounts ID
89   -- Example
90   --   GL_MANAGEMENT_SEGMENT_UPGRADE.Process_Incremental_Data
91   --                                   (errbuf, retcode, 101);
92   -- Notes
93   --
94   PROCEDURE Process_Incremental_Data(
95     X_Errbuf                OUT NOCOPY VARCHAR2,
96     X_Retcode               OUT NOCOPY VARCHAR2,
97     X_Chart_Of_Accounts_Id  NUMBER);
98 
99   --
100   -- Procedure
101   --   Assign_Management_Segment
102   -- Purpose
103   --
104   -- Arguments
105   --   X_Chart_Of_Accounts_Id	Chart of accounts ID
106   -- Example
107   --   GL_MANAGEMENT_SEGMENT_UPGRADE.Assign_Management_Segment
108   --                                   (errbuf, retcode, 101);
109   -- Notes
110   --
111   PROCEDURE Assign_Management_Segment(
112     X_Errbuf                OUT NOCOPY VARCHAR2,
113     X_Retcode               OUT NOCOPY VARCHAR2,
114     X_Chart_Of_Accounts_Id  NUMBER);
115 
116 END GL_MANAGEMENT_SEGMENT_UPGRADE;