[Home] [Help]
PACKAGE: APPS.BIS_DIMENSION_LEVEL_PUB
Source
1 PACKAGE BIS_DIMENSION_LEVEL_PUB AS
2 /* $Header: BISPDMLS.pls 120.4 2006/01/06 03:25:49 akoduri noship $ */
3 /*
4 REM +=======================================================================+
5 REM | Copyright (c) 1998 Oracle Corporation, Redwood Shores, CA, USA |
6 REM | All rights reserved. |
7 REM +=======================================================================+
8 REM | FILENAME |
9 REM | BISPDMLS.pls |
10 REM | |
11 REM | DESCRIPTION |
12 REM | PUB.lic API for managing dimension levels for the
13 REM | Key Performance Framework.
14 REM |
15 REM | This package should be maintaind by EDW once it gets integrated
16 REM | with BIS.
17 REM |
18 REM | NOTES |
19 REM | |
20 REM | HISTORY |
21 REM | 05-DEC-98 irchen Creation
22 REM | 01-FEB-99 ansingha added required dimension api
23 REM | 25-JUL-02 jxyu Modified for enhancement #2435226
24 REM | Added Comparison_Label_Code for TYPE Dimension_Level_Rec_Type
25 REM | 20-FEB-03 PAJOHRI Added Procedure Update_Dimension_Level |
26 REM | 24-NOV-02 mahrao Modified for enhancement #2668271
27 REM | Added Attribute_Code for TYPE Dimension_Level_Rec_Type
28 REM | 17-MAR-03 PAJOHRI Added procedures DELETE_DIMENSION_LEVEL |
29 REM | CREATE_DIMENSION_LEVEL |
30 REM | 17-MAR-03 PAJOHRI Added Application_id for TYPE |
31 REM | Dimension_Level_Rec_Type |
32 REM | 13-JUN-03 MAHRAO Added Procedure Load_Dimension_Level |
33 REM | 26-JUN-03 RCHANDRA do away with hard coded length for name and |
34 REM | description for bug 2910316 |
35 REM | for dimension and dimension levels |
36 REM | 10-JUL-2003 mahrao bug#3042968 Added extra parameter to |
37 REM | Load_Dimension_Level |
38 REM | 29-OCT-03 MAHRAO enh of adding new attributes to dim objects |
39 REM | 14-NOV-03 RCHANDRA enh 2997632, customization APIs |
40 REM | arhegde 07/23/2004 bug# 3760735 dim object caching. |
41 REM | ankgoel 29-SEP-2004 Added WHO columns in Rec for Bug#3891748 |
42 REM | 21-DEC-04 vtulasi Modified for bug#4045278 - Addtion of LUD |
43 REM | 08-Feb-04 skchoudh Enh#3873195 drill_to_form_function column |
44 REM | is added |
45 REM | 08-Feb-05 ankgoel Enh#4172034 DD Seeding by Product Teams |
46 REM | 21-Jun-05 ankgoel Bug#4437121 bisdimld/v.ldt compatible in 409 |
47 REM | 07-NOV-05 akoduri Bug#4696105,Added overloaded API |
48 REM | get_customized_enabled |
49 REM | 12-Dec-05 ankgoel Enh#4640165 - Select dim objects from Report |
50 REM | 01-Jan-06 akoduri Enh#4739401 - Hide Dimensions/Dim Objects |
51 REM +=======================================================================+
52 */
53 --
54 -- Data Types: Records
55 --
56 C_PARENT CONSTANT VARCHAR2(2) := 'P';
57 C_SIBLING CONSTANT VARCHAR2(2) := 'S';
58 C_NO_REL CONSTANT VARCHAR2(2) := 'R';
59 C_NO_MASTER CONSTANT VARCHAR2(2) := 'M';
60
61 TYPE Dimension_Level_Rec_Type IS RECORD
62 ( Dimension_ID NUMBER
63 , Dimension_Short_Name VARCHAR2(30)
64 , Dimension_Name bis_dimensions_tl.name%TYPE
65 , Dimension_Level_ID NUMBER
66 , Dimension_Level_Short_Name VARCHAR2(30)
67 , Dimension_Level_Name bis_levels_tl.name%TYPE
68 , Description bis_levels_tl.Description%TYPE
69 , Level_Values_View_Name VARCHAR2(30)
70 , where_Clause VARCHAR2(2000)
71 , source VARCHAR2(30)
72 , Comparison_Label_Code VARCHAR2(30)
73 , Attribute_Code VARCHAR2(30)
74 , Application_ID BIS_LEVELS.Application_Id%TYPE
75 , default_search BIS_LEVELS.default_search%TYPE
76 , Long_Lov BIS_LEVELS.Long_Lov%TYPE
77 , Master_Level BIS_LEVELS.Master_Level%TYPE
78 , View_Object_Name BIS_LEVELS.View_Object_Name%TYPE
79 , Default_Values_Api BIS_LEVELS.Default_Values_Api%TYPE
80 , Enabled BIS_LEVELS.Enabled%TYPE
81 , Drill_To_Form_Function BIS_LEVELS.DRILL_TO_FORM_FUNCTION%TYPE
82 , Language BIS_LEVELS_TL.Language%TYPE
83 , Source_Lang BIS_LEVELS_TL.Source_Lang%TYPE
84 -- ankgoel: bug#3891748
85 , Created_By BIS_LEVELS.CREATED_BY%TYPE
86 , Creation_Date BIS_LEVELS.CREATION_DATE%TYPE
87 , Last_Updated_By BIS_LEVELS.LAST_UPDATED_BY%TYPE
88 , Last_Update_Date BIS_LEVELS.LAST_UPDATE_DATE%TYPE
89 , Last_Update_Login BIS_LEVELS.LAST_UPDATE_LOGIN%TYPE
90 -- ankgoel: enh#4172034
91 , Primary_Dim VARCHAR2(1) := FND_API.G_TRUE
92 , Hide BIS_LEVELS.HIDE_IN_DESIGN%TYPE := FND_API.G_FALSE
93 );
94 --
95 -- Data Types: Tables
96 --
97 TYPE Dimension_Level_Tbl_Type IS TABLE of Dimension_Level_Rec_Type
98 INDEX BY BINARY_INTEGER;
99 --
100 --
101 Procedure Retrieve_Dimension_Levels
102 ( p_api_version IN NUMBER
103 , p_Dimension_Rec IN BIS_DIMENSION_PUB.Dimension_Rec_Type
104 , x_Dimension_Level_Tbl OUT NOCOPY BIS_DIMENSION_LEVEL_PUB.Dimension_Level_Tbl_Type
105 , x_return_status OUT NOCOPY VARCHAR2
106 , x_error_Tbl OUT NOCOPY BIS_UTILITIES_PUB.Error_Tbl_Type
107 );
108 --
109 Procedure Retrieve_Dimension_Level
110 ( p_api_version IN NUMBER
111 , p_Dimension_Level_Rec IN BIS_DIMENSION_LEVEL_PUB.Dimension_Level_Rec_Type
112 , x_Dimension_Level_Rec IN OUT NOCOPY BIS_DIMENSION_LEVEL_PUB.Dimension_Level_Rec_Type
113 , x_return_status OUT NOCOPY VARCHAR2
114 , x_error_Tbl OUT NOCOPY BIS_UTILITIES_PUB.Error_Tbl_Type
115 );
116 --
117 Procedure Translate_Dimension_Level
118 ( p_api_version IN NUMBER
119 , p_commit IN VARCHAR2 := FND_API.G_FALSE
120 , p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL
121 , p_Dimension_Level_Rec IN BIS_DIMENSION_LEVEL_PUB.Dimension_Level_Rec_Type
122 , p_OWNER IN VARCHAR2 := BIS_UTILITIES_PUB.G_CUSTOM_OWNER
123 , x_return_status OUT NOCOPY VARCHAR2
124 , x_error_Tbl OUT NOCOPY BIS_UTILITIES_PUB.Error_Tbl_Type
125 );
126 --
127 Procedure Load_Dimension_Level
128 ( p_api_version IN NUMBER
129 , p_commit IN VARCHAR2 := FND_API.G_FALSE
130 , p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL
131 , p_Dimension_Level_Rec IN BIS_DIMENSION_LEVEL_PUB.Dimension_Level_Rec_Type
132 , p_OWNER IN VARCHAR2 := BIS_UTILITIES_PUB.G_CUSTOM_OWNER
133 , x_return_status OUT NOCOPY VARCHAR2
134 , x_error_Tbl OUT NOCOPY BIS_UTILITIES_PUB.Error_Tbl_Type
135 , p_force_mode IN BOOLEAN := FALSE
136 );
137 --
138 --
139 PROCEDURE Update_Dimension_Level
140 ( p_api_version IN NUMBER
141 , p_commit IN VARCHAR2 := FND_API.G_FALSE
142 , p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL
143 , p_Dimension_Level_Rec IN BIS_DIMENSION_LEVEL_PUB.Dimension_Level_Rec_Type
144 , x_return_status OUT NOCOPY VARCHAR2
145 , x_error_Tbl OUT NOCOPY BIS_UTILITIES_PUB.Error_Tbl_Type
146 );
147 --
148 PROCEDURE Create_Dimension_Level
149 ( p_api_version IN NUMBER
150 , p_commit IN VARCHAR2 := FND_API.G_FALSE
151 , p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL
152 , p_Dimension_Level_Rec IN BIS_DIMENSION_LEVEL_PUB.Dimension_Level_Rec_Type
153 , x_return_status OUT NOCOPY VARCHAR2
154 , x_error_Tbl OUT NOCOPY BIS_UTILITIES_PUB.Error_Tbl_Type
155 );
156 --
157 PROCEDURE Delete_Dimension_Level
158 (
159 p_commit IN VARCHAR2 := FND_API.G_FALSE
160 , p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL
161 , p_Dimension_Level_Rec IN BIS_Dimension_Level_PUB.Dimension_Level_Rec_Type
162 , x_return_status OUT NOCOPY VARCHAR2
163 , x_error_Tbl OUT NOCOPY BIS_UTILITIES_PUB.Error_Tbl_Type
164 );
165 --
166 PROCEDURE Load_Dimension_Level (
167 p_Commit IN VARCHAR2 := FND_API.G_FALSE
168 ,p_Dim_Grp_Rec IN BSC_DIMENSION_GROUPS_PUB.Bsc_Dim_Group_Rec_Type
169 ,p_Bsc_Pmf_Dim_Rec IN BSC_PMF_UI_API_PUB.Bsc_Pmf_Dim_Rec_Type
170 ,p_Bsc_Dim_Level_Rec IN BSC_DIMENSION_LEVELS_PUB.Bsc_Dim_Level_Rec_Type
171 ,x_return_status OUT NOCOPY VARCHAR2
172 ,x_msg_count OUT NOCOPY NUMBER
173 ,x_msg_data OUT NOCOPY VARCHAR2
174 ,p_force_mode IN BOOLEAN := FALSE
175 );
176 --
177
178 PROCEDURE Trans_DimObj_By_Given_Lang
179 (
180 p_commit IN VARCHAR2 := FND_API.G_FALSE
181 , p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL
182 , p_Dimension_Level_Rec IN BIS_DIMENSION_LEVEL_PUB.Dimension_Level_Rec_Type
183 , x_return_status OUT NOCOPY VARCHAR2
184 , x_error_Tbl OUT NOCOPY BIS_UTILITIES_PUB.Error_Tbl_Type
185 );
186
187 --
188 --=============================================================================
189 Procedure Retrieve_Dimension_Level_Wrap
190 ( p_dim_level_short_name IN VARCHAR2
191 , p_master_dim_level_short_name IN VARCHAR2
192 , p_dim_short_name IN VARCHAR2
193 , x_dim_level_name OUT NOCOPY VARCHAR2
194 , x_dim_level_desc OUT NOCOPY VARCHAR2
195 , x_default_search OUT NOCOPY VARCHAR2
196 , x_long_lov OUT NOCOPY VARCHAR2
197 , x_master_level OUT NOCOPY VARCHAR2
198 , x_is_related_by_master OUT NOCOPY VARCHAR2
199 , x_view_object_name OUT NOCOPY VARCHAR2
200 , x_default_values_api OUT NOCOPY VARCHAR2
201 , x_enabled OUT NOCOPY VARCHAR2
202 , x_hide OUT NOCOPY VARCHAR2
203 , x_dim_group_id OUT NOCOPY NUMBER
204 , x_dim_level_id OUT NOCOPY NUMBER
205 , x_dim_level_index OUT NOCOPY NUMBER
206 , x_total_flag OUT NOCOPY NUMBER
207 , x_total_disp_name OUT NOCOPY VARCHAR2
208 , x_dim_level_where_clause OUT NOCOPY VARCHAR2
209 , x_comparison_flag OUT NOCOPY NUMBER
210 , x_comp_disp_name OUT NOCOPY VARCHAR2
211 , x_filter_column OUT NOCOPY VARCHAR2
212 , x_filter_value OUT NOCOPY NUMBER
213 , x_default_value OUT NOCOPY VARCHAR2
214 , x_default_type OUT NOCOPY NUMBER
215 , x_parent_in_total OUT NOCOPY NUMBER
216 , x_no_items OUT NOCOPY NUMBER
217 , x_pmf_dim_id OUT NOCOPY NUMBER
218 , x_pmf_dim_level_id OUT NOCOPY NUMBER
219 , x_comparison_label_code OUT NOCOPY VARCHAR2
220 , x_level_values_view_name OUT NOCOPY VARCHAR2
221 , x_source OUT NOCOPY VARCHAR2
222 , x_attribute_code OUT NOCOPY VARCHAR2
223 , x_application_id OUT NOCOPY NUMBER
224 , x_drill_to_form_function OUT NOCOPY VARCHAR2
225 , x_dim_name OUT NOCOPY VARCHAR2
226 , x_return_status OUT NOCOPY VARCHAR2
227 , x_msg_count OUT NOCOPY VARCHAR2
228 , x_msg_data OUT NOCOPY VARCHAR2
229 );
230
231 --=============================================================================
232 -- get customized values for name , description and enabled
233 FUNCTION get_customized_name( p_dim_level_id IN NUMBER) RETURN VARCHAR2;
234
235 FUNCTION get_customized_description( p_dim_level_id IN NUMBER) RETURN VARCHAR2;
236
237 FUNCTION get_customized_enabled( p_dim_level_id IN NUMBER) RETURN VARCHAR2;
238
239 FUNCTION get_customized_enabled( p_dim_level_sht_name IN VARCHAR2) RETURN VARCHAR2;
243 Procedure Retrieve_Dim_Level_Cust_Wrap
240
241 PROCEDURE validate_disabling (p_dim_level_id IN NUMBER);
242
244 ( p_dim_level_short_name IN VARCHAR2
245 , p_dim_short_name IN VARCHAR2
246 , x_dim_level_cust_name OUT NOCOPY VARCHAR2
247 , x_dim_level_cust_desc OUT NOCOPY VARCHAR2
248 , x_dim_level_cust_enabled OUT NOCOPY VARCHAR2
249 );
250 --
251
252 Procedure Load_Dimension_Level_Wrapper
253 ( p_commit IN VARCHAR2 := FND_API.G_FALSE
254 , p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL
255 , p_Dimension_Level_Rec IN BIS_DIMENSION_LEVEL_PUB.Dimension_Level_Rec_Type
256 , p_Dim_Grp_Rec IN BSC_DIMENSION_GROUPS_PUB.Bsc_Dim_Group_Rec_Type
257 , p_Bsc_Pmf_Dim_Rec IN BSC_PMF_UI_API_PUB.Bsc_Pmf_Dim_Rec_Type
258 , p_Bsc_Dim_Level_Rec IN BSC_DIMENSION_LEVELS_PUB.Bsc_Dim_Level_Rec_Type
259 , p_Owner IN VARCHAR2 := BIS_UTILITIES_PUB.G_CUSTOM_OWNER
260 , p_force_mode IN BOOLEAN := FALSE
261 , x_return_status OUT NOCOPY VARCHAR2
262 , x_msg_count OUT NOCOPY NUMBER
263 , x_msg_data OUT NOCOPY VARCHAR2
264 );
265 --
266 Procedure Translate_Dim_Level_Wrapper
267 ( p_commit IN VARCHAR2 := FND_API.G_FALSE
268 , p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL
269 , p_Dimension_Level_Rec IN BIS_DIMENSION_LEVEL_PUB.Dimension_Level_Rec_Type
270 , p_Bsc_Pmf_Dim_Rec IN BSC_PMF_UI_API_PUB.Bsc_Pmf_Dim_Rec_Type
271 , p_Bsc_Dim_Level_Rec IN BSC_DIMENSION_LEVELS_PUB.Bsc_Dim_Level_Rec_Type
272 , p_Owner IN VARCHAR2 := BIS_UTILITIES_PUB.G_CUSTOM_OWNER
273 , x_return_status OUT NOCOPY VARCHAR2
274 , x_msg_count OUT NOCOPY NUMBER
275 , x_msg_data OUT NOCOPY VARCHAR2
276 );
277 --
278
279 PROCEDURE Update_Dim_Obj_Obsolete_Flag (
280 p_commit IN VARCHAR2 := FND_API.G_FALSE,
281 p_dim_obj_short_name IN VARCHAR2,
282 p_hide IN VARCHAR2,
283 x_return_status OUT nocopy VARCHAR2,
284 x_Msg_Count OUT NOCOPY NUMBER,
285 x_msg_data OUT nocopy VARCHAR2
286 );
287
288
289 END BIS_DIMENSION_LEVEL_PUB;