1 PACKAGE BIS_DIMENSION_PUB AS
2 /* $Header: BISPDIMS.pls 120.1 2006/01/06 03:20:44 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 | BISPDIMS.pls |
10 REM | |
11 REM | DESCRIPTION |
12 REM | Public API for managing Dimensions and 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 | 20-FEB-03 PAJOHRI Added Procedure UPDATE_DIMENSION |
24 REM | 23-FEB-03 PAJOHRI Added Procedures DELETE_DIMENSION |
25 REM | CREATE_DIMENSION |
26 REM | 13-JUN-03 MAHRAO Added Procedure Load_Dimension_Group |
27 REM | 26-JUN-03 RCHANDRA do away with hard coded length for name and |
28 REM | description for enh 2910316 |
29 REM | for dimension and dimension levels |
30 REM | 11-JUL-03 MAHRAO Modified the record type, to handle dim_grp_ID |
31 REM | which is added into the bis_dimensions |
32 REM | 29-SEP-04 ankgoel Added WHO columns in Rec for Bug#3891748 |
33 REM | 21-DEC-04 vtulasi Modified for bug#4045278 - Addtion of LUD |
34 REM | 08-Feb-05 ankgoel Enh#4172034 DD Seeding by Product Teams |
35 REM | 06-Jan-06 akoduri Enh#4739401 - Hide Dimensions/Dim Objects |
36 REM +=======================================================================+
37 */
38 --
39 -- Data Types: Records
40 --
41 TYPE Dimension_Rec_Type IS RECORD
42 ( Dimension_ID NUMBER
43 , Dimension_Short_Name VARCHAR2(30)
44 , Dimension_Name bis_dimensions_tl.name%TYPE
45 , Description bis_dimensions_tl.description%TYPE
46 , Application_ID BIS_DIMENSIONS.Application_Id%TYPE
47 , Dim_Grp_Id BIS_DIMENSIONS.Dim_Grp_Id%TYPE
48 , Language bis_dimensions_tl.Language%TYPE
49 , Source_Lang bis_dimensions_tl.Source_Lang%TYPE
50 -- ankgoel: bug#3891748
51 , Created_By BIS_DIMENSIONS.CREATED_BY%TYPE
52 , Creation_Date BIS_DIMENSIONS.CREATION_DATE%TYPE
53 , Last_Updated_By BIS_DIMENSIONS.LAST_UPDATED_BY%TYPE
54 , Last_Update_Date BIS_DIMENSIONS.LAST_UPDATE_DATE%TYPE
55 , Last_Update_Login BIS_DIMENSIONS.LAST_UPDATE_LOGIN%TYPE
56 , Hide BIS_DIMENSIONS.HIDE_IN_DESIGN%TYPE := FND_API.G_FALSE
57 );
58 --
59 -- Data Types: Tables
60 --
61 TYPE Dimension_Tbl_Type IS TABLE OF Dimension_Rec_Type
62 INDEX BY BINARY_INTEGER;
63 --
64 --
65 Procedure Retrieve_Dimensions
66 ( p_api_version IN NUMBER
67 , x_Dimension_Tbl OUT NOCOPY BIS_DIMENSION_PUB.Dimension_Tbl_Type
68 , x_return_status OUT NOCOPY VARCHAR2
69 , x_error_Tbl OUT NOCOPY BIS_UTILITIES_PUB.Error_Tbl_Type
70 );
71 --
72 Procedure Retrieve_Dimension
73 ( p_api_version IN NUMBER
74 , p_Dimension_Rec IN BIS_DIMENSION_PUB.Dimension_Rec_Type
75 , x_Dimension_Rec OUT NOCOPY BIS_DIMENSION_PUB.Dimension_Rec_Type
76 , x_return_status OUT NOCOPY VARCHAR2
77 , x_error_Tbl OUT NOCOPY BIS_UTILITIES_PUB.Error_Tbl_Type
78 );
79 --
80 -- API to retrieve the first and the second required dimension
81 -- this p_num can be either 1 or 2
82 -- I wish I had enumerated types :-(
83 Procedure Retrieve_Required_Dimension
84 ( p_api_version IN NUMBER
85 , p_num IN NUMBER
86 , x_dimension_rec OUT NOCOPY BIS_DIMENSION_PUB.Dimension_Rec_Type
87 , x_return_status OUT NOCOPY VARCHAR2
88 , x_error_Tbl OUT NOCOPY BIS_UTILITIES_PUB.Error_Tbl_Type
89 );
90 --
91 Procedure Translate_Dimension
92 ( p_api_version IN NUMBER
93 , p_commit IN VARCHAR2 := FND_API.G_FALSE
94 , p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL
95 , p_Dimension_Rec IN BIS_DIMENSION_PUB.Dimension_Rec_Type
96 , p_OWNER IN VARCHAR2 := BIS_UTILITIES_PUB.G_CUSTOM_OWNER
97 , x_return_status OUT NOCOPY VARCHAR2
98 , x_error_Tbl OUT NOCOPY BIS_UTILITIES_PUB.Error_Tbl_Type
99 );
100 --
101 Procedure Load_Dimension
102 ( p_api_version IN NUMBER
103 , p_commit IN VARCHAR2 := FND_API.G_FALSE
104 , p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL
105 , p_Dimension_Rec IN BIS_DIMENSION_PUB.Dimension_Rec_Type
106 , p_OWNER IN VARCHAR2 := BIS_UTILITIES_PUB.G_CUSTOM_OWNER
107 , x_return_status OUT NOCOPY VARCHAR2
108 , x_error_Tbl OUT NOCOPY BIS_UTILITIES_PUB.Error_Tbl_Type
109 , p_force_mode IN BOOLEAN := FALSE
110 );
111 --
112 PROCEDURE Update_Dimension
113 ( p_api_version IN NUMBER
114 , p_commit IN VARCHAR2 := FND_API.G_FALSE
115 , p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL
116 , p_Dimension_Rec IN BIS_DIMENSION_PUB.Dimension_Rec_Type
117 , x_return_status OUT NOCOPY VARCHAR2
118 , x_error_Tbl OUT NOCOPY BIS_UTILITIES_PUB.Error_Tbl_Type
119 );
120 --
121 PROCEDURE Create_Dimension
122 (
123 p_api_version IN NUMBER
124 , p_commit IN VARCHAR2 := FND_API.G_FALSE
125 , p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL
126 , p_Dimension_Rec IN BIS_DIMENSION_PUB.Dimension_Rec_Type
127 , x_return_status OUT NOCOPY VARCHAR2
128 , x_error_Tbl OUT NOCOPY BIS_UTILITIES_PUB.Error_Tbl_Type
129 );
130 --
131 PROCEDURE Delete_Dimension
132 (
133 p_commit IN VARCHAR2 := FND_API.G_FALSE
134 , p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL
135 , p_Dimension_Rec IN BIS_DIMENSION_PUB.Dimension_Rec_Type
136 , x_return_status OUT NOCOPY VARCHAR2
137 , x_error_Tbl OUT NOCOPY BIS_UTILITIES_PUB.Error_Tbl_Type
138 );
139 --
140 PROCEDURE Load_Dimension_Group (
141 p_commit IN VARCHAR2 := FND_API.G_FALSE
142 ,p_Dim_Grp_Rec IN BSC_DIMENSION_GROUPS_PUB.Bsc_Dim_Group_Rec_Type
143 ,x_return_status OUT NOCOPY VARCHAR2
144 ,x_msg_count OUT NOCOPY NUMBER
145 ,x_msg_data OUT NOCOPY VARCHAR2
146 ,p_force_mode IN BOOLEAN := FALSE
147 );
148
149 --
150 PROCEDURE Translate_Dim_By_Given_Lang
151 (
152 p_commit IN VARCHAR2 := FND_API.G_FALSE
153 , p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL
154 , p_Dimension_Rec IN BIS_DIMENSION_PUB.Dimension_Rec_Type
155 , x_return_status OUT NOCOPY VARCHAR2
156 , x_error_Tbl OUT NOCOPY BIS_UTILITIES_PUB.Error_Tbl_Type
157 );
158 --
159 Procedure Load_Dimension_Wrapper
160 ( p_commit IN VARCHAR2 := FND_API.G_FALSE
161 , p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL
162 , p_Dimension_Rec IN BIS_DIMENSION_PUB.Dimension_Rec_Type
163 , p_Dim_Grp_Rec IN BSC_DIMENSION_GROUPS_PUB.Bsc_Dim_Group_Rec_Type
164 , p_Owner IN VARCHAR2 := BIS_UTILITIES_PUB.G_CUSTOM_OWNER
165 , p_force_mode IN BOOLEAN := FALSE
166 , x_return_status OUT NOCOPY VARCHAR2
167 , x_msg_count OUT NOCOPY NUMBER
168 , x_msg_data OUT NOCOPY VARCHAR2
169 );
170 --
171 Procedure Translate_Dimension_Wrapper
172 ( p_commit IN VARCHAR2 := FND_API.G_FALSE
173 , p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL
174 , p_Dimension_Rec IN BIS_DIMENSION_PUB.Dimension_Rec_Type
175 , p_Dim_Grp_Rec IN BSC_DIMENSION_GROUPS_PUB.Bsc_Dim_Group_Rec_Type
176 , p_Owner IN VARCHAR2 := BIS_UTILITIES_PUB.G_CUSTOM_OWNER
177 , x_return_status OUT NOCOPY VARCHAR2
178 , x_msg_count OUT NOCOPY NUMBER
179 , x_msg_data OUT NOCOPY VARCHAR2
180 );
181
182 --
183 PROCEDURE Update_Dimension_Obsolete_Flag (
184 p_commit IN VARCHAR2 := FND_API.G_FALSE,
185 p_dim_short_name IN VARCHAR2,
186 p_hide IN VARCHAR2,
187 x_return_status OUT NOCOPY VARCHAR2,
188 x_Msg_Count OUT NOCOPY NUMBER,
189 x_msg_data OUT NOCOPY VARCHAR2
190 );
191
192 END BIS_DIMENSION_PUB;