DBA Data[Home] [Help]

PACKAGE: APPS.GL_FLATTEN_SETUP_DATA

Source


1 PACKAGE GL_FLATTEN_SETUP_DATA AS
2 /* $Header: gluflsds.pls 120.6 2005/05/05 01:38:50 kvora noship $ */
3 
4 -- *******************************************************************
5 -- Package level variables
6 -- *******************************************************************
7 GLSTFL_COA_ID		NUMBER		:= NULL;
8 GLSTFL_VS_ID		NUMBER		:= NULL;
9 GLSTFL_VS_TAB_NAME	VARCHAR2(240)	:= NULL;
10 GLSTFL_VS_COL_NAME      VARCHAR2(240)   := NULL;
11 GLSTFL_Op_Mode		VARCHAR2(2)	:= NULL;
12 GLSTFL_Debug		BOOLEAN		:= FALSE;
13 GLSTFL_User_Id		NUMBER		:= NULL;
14 GLSTFL_Login_Id		NUMBER		:= NULL;
15 GLSTFL_Req_Id		NUMBER		:= NULL;
16 GLSTFL_BAL_VS_ID	NUMBER		:= NULL;
17 GLSTFL_MGT_VS_ID	NUMBER		:= NULL;
18 
19 -- ********************************************************************
20 -- Procedure
21 --   Main
22 -- Purpose
23 --   This is the main procedure of the flattening program.  It will take
24 --   in all parameters, initialize all necessary variables and start
25 --   calling the appropriate routines based on the mode of operation.
26 -- History
27 --   07-03-2001       	S Kung		Created
28 -- Arguments
29 --   X_Mode		Mode of operation, type VARCHAR2
30 --   X_Mode_Parameter	Depending on the mode of operation, this will
31 --			either be the chart of accounts ID or the flex
32 --			value set ID. It is of type NUMBER
33 --   X_Debug		Indicate if program is running in debug mode,
34 --			type VARCHAR2.  Default value is NULL.
35 -- Example
36 --   GL_FLATTEN_SETUP_DATA.Main('SH', 1002714, 'Y');
37 --
38 
39   PROCEDURE Main(X_Mode				VARCHAR2,
40 		 X_Mode_Parameter		VARCHAR2,
41 		 X_Debug			VARCHAR2 DEFAULT NULL);
42 
43 -- ********************************************************************
44 -- Procedure
45 --   Main
46 -- Purpose
47 --   This is the concurrent job version of Main.  This will be used
48 --   when submitting the program through forms.
49 -- History
50 --   11-12-2001       	S Kung		Created
51 -- Arguments
52 --   errbuf		Standard error buffer
53 --   retcode 		Standard return code
54 --   X_Mode		Mode of operation, type VARCHAR2
55 --   X_Mode_Parameter	Depending on the mode of operation, this will
56 --			either be the chart of accounts ID or the flex
57 --			value set ID. It is of type NUMBER
58 --   X_Debug		Indicate if program is running in debug mode,
59 --			type VARCHAR2.  Default value is NULL.
60 -- Example
61 --   GL_FLATTEN_SETUP_DATA.Main(errbuf, retcode, 'SH', 1002714, 'Y');
62 --
63 
64   PROCEDURE Main(errbuf			OUT NOCOPY	VARCHAR2,
65 		 retcode		OUT NOCOPY	VARCHAR2,
66 		 X_Mode				VARCHAR2,
67 		 X_Mode_Parameter		VARCHAR2,
68 		 X_Debug			VARCHAR2 DEFAULT NULL);
69 
70 -- ******************************************************************
71 -- Function
72 --   Clean_Up
73 -- Purpose
74 --   This is the main function for the final clean up phase.  This routine
75 --   will call the appropriate clean up routines depending on the mode of
76 --   operation.
77 -- History
78 --   07-09-2001		S Kung		Created
79 -- Arguments
80 --
81 -- Example
82 --   ret_status := GL_FLATTEN_SETUP_DATA.Clean_Up;
83 --
84 
85   FUNCTION  Clean_Up RETURN BOOLEAN;
86 
87 -- *****************************************************************
88 -- Function
89 --   Get_Value_Set_Info
90 -- Purpose
91 --   This Function takes in the flex_value_set_id, then determine if
92 --   it is a table validated value set.  If that is the case, retrieve
93 --   the validation table and return it.
94 -- History
95 --   07-09-2001		S Kung		Created
96 -- Arguments
97 --   X_Vs_Id            	Flex_Value_set_id, type NUMBER
98 --   Table_Name			VARCHAR2 output paramter that contains the
99 --				table used for validating the value set.
100 -- Example
101 --   ret_status := GL_FLATTEN_SETUP_DATA.Get_Value_Set_Info
102 --		   (1002714, tab_validate, tab_name);
103 --
104 
105   FUNCTION  Get_Value_Set_Info(	X_Vs_Id			NUMBER,
106 				Table_Name	   OUT NOCOPY	VARCHAR2,
107                                 Column_Name	   OUT NOCOPY	VARCHAR2)
108                                  RETURN BOOLEAN;
109 
110 -- ******************************************************************
111 -- Function
112 --   Request_Lock
113 -- Purpose
114 --   This Function takes in a NUMBER type parameter, meaning of the parameter
115 --   (COA or VS) and the lock mode.  Then it construct a user named lock
116 --   and try to obtain a lock based on the lock mode.
117 -- History
118 --   07-10-2001		S Kung		Created
119 -- Arguments
120 --   X_Param_Type		Type VARCHAR2; C indicates it is a COA, while
121 --				V indicates it is a value set.
122 --   X_Param_Id			Type NUMBER; either the COA ID or value set ID.
123 --   X_Lock_Mode		Type INTEGER; lock mode for the lock
124 --   X_Keep_Looping		Type BOOLEAN; indicates if process should
125 -- 				keep looping when time out occurs
126 --   X_Max_Trys			Type NUMBER; maxium number of trials to
127 --				obtain the lock before aborting
128 -- Example
129 --   ret_status := GL_FLATTEN_SETUP_DATA.Request_Lock
130 --		   ('C', 101, 6, TRUE, 5);
131 --
132 
133   FUNCTION  Request_Lock(X_Param_Type		VARCHAR2,
134 			 X_Param_Id		NUMBER,
135 			 X_Lock_Mode		INTEGER,
136 			 X_Keep_Looping		BOOLEAN,
137 			 X_Max_Trys		NUMBER)
138 			RETURN BOOLEAN;
139 
140 -- ******************************************************************
141 -- Function
142 --   Release_Lock
143 -- Purpose
144 --   This Function reconstruct the user named lock based on input
145 --   parameters, then release lock.
146 -- History
147 --   07-10-2001		S Kung		Created
148 -- Arguments
149 --   X_Param_Type		Type VARCHAR2.  C indicates it is a COA,
150 --				V indicates it is a value set.
151 --   X_Param_Id			Type NUMBER, either the COA ID or value set
152 -- 				ID.
153 -- Example
154 --   ret_status := GL_FLATTEN_SETUP_DATA.Release_Lock('C', 101);
155 --
156 
157   FUNCTION  Release_Lock(X_Param_Type		VARCHAR2,
158 			 X_Param_Id		NUMBER)
159 			RETURN BOOLEAN;
160 
161 -- ******************************************************************
162 
163 
164 -- ******************************************************************
165 -- Function
166 --   GL_Flatten_Rule
167 -- Purpose
168 --   This Function will be used as a run function for the new
169 --   business event oracle.apps.fnd.flex.vst.hierarchy.compiled
170 -- History
171 --   10-Oct-2004       Srini pala		Created
172 -- Arguments
173 --   p_subscription_guid 	raw unique subscription id
174 --
175 --    p_event		        wf_event_t workflow business event
176 --
177 -- Example
178 --   ret_status := GL_FLATTEN_SETUP_DATA.GL_Flatten_Rule( );
179 --
180 
181   FUNCTION  GL_Flatten_Rule(
182                          p_subscription_guid in     raw,
183                          p_event             in out nocopy wf_event_t)
184             RETURN VARCHAR2;
185 
186 
187 -- ******************************************************************
188 
189 END GL_FLATTEN_SETUP_DATA;
190