DBA Data[Home] [Help]

PACKAGE: APPS.ZPB_BUSAREA_MAINT

Source


1 PACKAGE ZPB_BUSAREA_MAINT AS
2 /* $Header: ZPBVBAMS.pls 120.9 2007/12/04 14:37:01 mbhat noship $ */
3 
4 G_PKG_NAME CONSTANT VARCHAR2(17) := 'zpb_busarea_maint';
5 
6 -------------------------------------------------------------------------
7 -- ADD_ATTRIBUTE - Adds an attribute to the Business Area version
8 --
9 -- IN:  p_version_id      - The version ID
10 --      p_logical_dim_id  - Logical Dimension Id
11 --      p_attribute_id    - The FEM Attribute ID
12 -------------------------------------------------------------------------
13 PROCEDURE ADD_ATTRIBUTE (p_version_id     IN      NUMBER,
14                          p_logical_dim_id IN      NUMBER, -- "Consistent Dimension"
15                          p_attribute_id   IN      NUMBER);
16 
17 -------------------------------------------------------------------------
18 -- ADD_USER - Adds a user to the Business Area
19 --
20 -- IN:  p_business_area_id   - The bsuiness area ID
21 --      p_user_id            - The User ID
22 -------------------------------------------------------------------------
23 PROCEDURE ADD_USER (p_business_area_id   IN      NUMBER,
24                     p_user_id            IN      NUMBER);
25 
26 
27 -------------------------------------------------------------------------
28 -- ADD_CONDITION - Adds an attribute condition to the Business Area version
29 --
30 -- IN:  p_version_id      - The version ID
31 --      p_logical_dim_id  - Logical Dimension Id
32 --      p_attribute_id    - The FEM Attribute ID
33 --      p_value           - The attribute value
34 --      p_value_set_id    - The value set ID, for VS-enabled attributes
35 --      p_operation       - The operator for the condition (default null)
36 -------------------------------------------------------------------------
37 PROCEDURE ADD_CONDITION (p_version_id     IN      NUMBER,
38                          p_logical_dim_id IN      NUMBER, -- "Consistent Dimension"
39                          p_attribute_id   IN      NUMBER,
40                          p_value          IN      VARCHAR2,
41                          p_value_set_id   IN      NUMBER := null,
42                          p_operation      IN      VARCHAR2 := null);
43 
44 
45 -------------------------------------------------------------------------
46 -- ADD_DATASET - Adds a dataset to the Business Area version
47 --
48 -- IN:  p_version_id   - The version ID
49 --      p_dataset_id   - The FEM Dataset ID
50 -------------------------------------------------------------------------
51 PROCEDURE ADD_DATASET (p_version_id   IN      NUMBER,
52                        p_dataset_id   IN      NUMBER);
53 
54 -------------------------------------------------------------------------
55 -- ADD_DIMENSION - Adds a dimension to the Business Area version
56 --
57 -- IN:  p_version_id      - The version ID
58 --      p_func_dim_set_id - Functional Dimension Set Id
59 --      p_dimension_id    - The FEM Dimension ID
60 -------------------------------------------------------------------------
61 PROCEDURE ADD_DIMENSION (p_version_id      IN  NUMBER,
62                          p_func_dim_set_id IN  NUMBER := null, -- "Consistent Dimension"
63                          p_dimension_id    IN  NUMBER);
64 
65 -------------------------------------------------------------------------
66 -- ADD_HIERARCHY - Adds a hierarchy to the Business Area version
67 --
68 -- IN:  p_version_id      - The version ID
69 --      p_logical_dim_id  - Logical Dimension Id
70 --      p_hierarchy_id    - The FEM Hierarchy ID
71 -------------------------------------------------------------------------
72 PROCEDURE ADD_HIERARCHY (p_version_id      IN      NUMBER,
73                          p_logical_dim_id  IN      NUMBER,  -- "Consistent Dimension"
74                          p_hierarchy_id    IN      NUMBER);
75 
76 -------------------------------------------------------------------------
77 -- ADD_HIERARCHY_MEMBER - Adds a top level member to the Business Area version
78 --
79 -- IN:  p_version_id      - The version ID
80 --      p_logical_dim_id  - Logical Dimension Id
81 --      p_hierarchy_id    - The FEM Hierarchy ID
82 --      p_hier_mbr_id     - The FEM member ID
83 --      p_member_vset     - The FEM member valueset ID (defaults to null)
84 --      p_hier_version    - The FEM hierarchy version ID (defaults to null)
85 -------------------------------------------------------------------------
86 PROCEDURE ADD_HIERARCHY_MEMBER (p_version_id      IN      NUMBER,
87                                 p_logical_dim_id  IN      NUMBER,  -- "Consistent Dimension"
88                                 p_hierarchy_id    IN      NUMBER,
89                                 p_member_id       IN      NUMBER,
90                                 p_member_vset     IN      NUMBER := null,
91                                 p_hier_version    IN      NUMBER := null);
92 
93 -------------------------------------------------------------------------
94 -- ADD_HIERARCHY_VERSION - Adds a hierarchy to the Business Area version
95 --
96 -- IN:  p_version_id      - The version ID
97 --      p_logical_dim_id  - Logical Dimension Id
98 --      p_hierarchy_id    - The FEM Hierarchy ID
99 --      p_hier_vers_id    - The FEM Hierarchy Version ID
100 -------------------------------------------------------------------------
101 PROCEDURE ADD_HIERARCHY_VERSION (p_version_id      IN      NUMBER,
102                                  p_logical_dim_id  IN      NUMBER,  -- "Consistent Dimension"
103                                  p_hierarchy_id    IN      NUMBER,
104                                  p_hier_vers_id    IN      NUMBER);
105 
106 
107 -------------------------------------------------------------------------
108 -- ADD_LEDGER - Adds a ledger to the Business Area version
109 --
110 -- IN:  p_version_id   - The version ID
111 --      p_ledger_id    - The FEM Ledger ID
112 -------------------------------------------------------------------------
113 PROCEDURE ADD_LEDGER (p_version_id   IN      NUMBER,
114                       p_ledger_id    IN      NUMBER);
115 
116 -------------------------------------------------------------------------
117 -- ADD_LEVEL - Adds a level to the Business Area version
118 --
119 -- IN:  p_version_id      - The version ID
120 --      p_logical_dim_id  - Logical Dimension Id
121 --      p_level_id        - The FEM Level ID
122 --      p_hierarchy_id    - The Hierarchy to add the level to
123 -------------------------------------------------------------------------
124 PROCEDURE ADD_LEVEL (p_version_id      IN      NUMBER,
125                      p_logical_dim_id  IN      NUMBER,  -- "Consistent Dimension"
126                      p_level_id        IN      NUMBER,
127                      p_hierarchy_id    IN      NUMBER);
128 
129 -------------------------------------------------------------------------
130 -- CHANGE_HIER_VERS_INCL - Should be called anytime the user changes
131 --                         what hierarchy versions are included in the
132 --                         Business Area
133 --
134 -- IN:  p_version_id      - The version ID
135 --      p_logical_dim_id  - Logical Dimension Id
136 --      p_hierarchy_id    - The Hierarchy to add the level to
137 -------------------------------------------------------------------------
138 PROCEDURE CHANGE_HIER_VERS_INCL (p_version_id      IN      NUMBER,
139                                  p_logical_dim_id  IN      NUMBER,  -- "Consistent Dimension"
140                                  p_hierarchy_id    IN      NUMBER);
141 
142 
143 -------------------------------------------------------------------------
144 -- CREATE_BUSINESS_AREA - Creates a new, empty Business Area
145 --
146 -- OUT: The created Business Area's ID
147 -------------------------------------------------------------------------
148 FUNCTION CREATE_BUSINESS_AREA
149    return NUMBER;
150 
151 -------------------------------------------------------------------------
152 -- CREATE_EMPTY VERSION - Creates a new, empty version for a Business Area.  If
153 --                        the version already exists, it will be overwritten
154 --                        (cleared).  If you want to create a version with a
155 --                        default definition, use COPY_VERSION instead.
156 --
157 -- IN:  p_business_area_id - The Business Area ID of the version
158 --      p_version_type     - The version type ('P', 'D', 'T', 'R')
159 --
160 -- OUT: The created Business Area version's ID
161 -------------------------------------------------------------------------
162 FUNCTION CREATE_EMPTY_VERSION (p_business_area_id IN     NUMBER,
163                                p_version_type     IN     VARCHAR2)
164    return NUMBER;
165 
166 -------------------------------------------------------------------------
167 -- COPY_VERSION - Copies one version to another.  If the version that is to be
168 --                copied to does not exist, this function will create it.
169 --                Otherwise, it will overwrite that version's definition.
170 --                Returns the version ID of the version that was created or
171 --                overwritten.
172 --
173 -- IN:  p_from_busarea_id    - The Business Area ID that the version to copy
174 --                             from is associated with
175 --      p_from_version_type  - The version type of the version to copy from
176 --      p_to_busarea_id      - The Business Area ID that the version to copy
177 --                             to is associated with
178 --      p_to_version_type    - The version type of the version to copy to
179 --
180 -- OUT: The ID of the version that was copied to
181 -------------------------------------------------------------------------
182 FUNCTION COPY_VERSION (p_from_busarea_id   IN      NUMBER,
183                        p_from_version_type IN      VARCHAR2,
184                        p_to_busarea_id     IN      NUMBER,
185                        p_to_version_type   IN      VARCHAR2)
186    return NUMBER;
187 
188 -------------------------------------------------------------------------
189 -- DELETE_BUSINESS_AREA_CR - Creates a conc. req. to deletes a Business Area
190 --                            including all versions
191 --
192 -- IN:  p_business_area_id - The Business Area ID
193 --
194 -- OUT: concurrent request number
195 -------------------------------------------------------------------------
196 FUNCTION DELETE_BUSINESS_AREA_CR (p_business_area_id IN     NUMBER)
197    return NUMBER;
198 
199 -------------------------------------------------------------------------
200 -- DELETE_BUSINESS_AREA - Deletes a Business Area, including all versions
201 --
202 -- IN:  p_business_area_id - The Business Area ID
203 -- OUT: ERRBUF - error buffer
204 -- OUT: RETCODE - return code
205 -------------------------------------------------------------------------
206 PROCEDURE DELETE_BUSINESS_AREA (ERRBUF          OUT NOCOPY VARCHAR2,
207                                 RETCODE         OUT NOCOPY VARCHAR2,
208                                 p_business_area_id IN     NUMBER);
209 
210 -------------------------------------------------------------------------
211 -- LOGIN - Called when a user logs in to a Business Area
212 --
213 -- IN: p_business_area_id - The Business Area that the user logged in
214 --                          under
215 -----------------------------------------------------------------------
216 PROCEDURE LOGIN (p_business_area_id IN      NUMBER);
217 
218 -------------------------------------------------------------------------
219 -- REFRESH - Submits a conc. req. to refresh a Business Area into EPB
220 --
221 -- IN:  p_business_area_id - The Business Area ID
222 -------------------------------------------------------------------------
223 FUNCTION REFRESH (p_business_area_id IN      NUMBER) return NUMBER;
224 
225 -------------------------------------------------------------------------
226 -- REMOVE_ATTRIBUTE - Removes an attribute from the Business Area version
227 --
228 -- IN:  p_version_id     - The version ID
229 --      p_logical_dim_id - Logical Dim Id
230 --      p_attribute_id   - The FEM Attribute ID
231 -------------------------------------------------------------------------
232 PROCEDURE REMOVE_ATTRIBUTE (p_version_id     IN      NUMBER,
233                             p_logical_dim_id IN      NUMBER,  -- "Consistent Dimension"
234                             p_attribute_id   IN      NUMBER);
235 
236 -------------------------------------------------------------------------
237 -- REMOVE_USER - Removes a user from the Business Area
238 --
239 -- IN:  p_business_area_id   - The business area ID
240 --      p_user_id - The User ID
241 -------------------------------------------------------------------------
242 PROCEDURE REMOVE_USER (p_business_area_id   IN      NUMBER,
243                        p_user_id            IN      NUMBER);
244 
245 -------------------------------------------------------------------------
246 -- REMOVE_CONDITION - Removes an attribute condition from the Business
247 --                    Area version
248 --
249 -- IN:  p_version_id     - The version ID
250 --      p_logical_dim_id - Logical Dim Id
251 --      p_attribute_id   - The FEM Attribute ID
252 --      p_value          - The attribute value
253 --      p_value_set_id   - The value set ID, for VS-enabled attributes
254 --      p_operation      - The operation of the condition
255 -------------------------------------------------------------------------
256 PROCEDURE REMOVE_CONDITION (p_version_id     IN      NUMBER,
257                             p_logical_dim_id IN      NUMBER,  -- "Consistent Dimension"
258                             p_attribute_id   IN      NUMBER,
259                             p_value          IN      VARCHAR2,
260                             p_operation      IN      VARCHAR2,
261                             p_value_set_id   IN      NUMBER := null);
262 
263 -------------------------------------------------------------------------
264 -- REMOVE_DATASET - Removes a dataset from the Business Area version
265 --
266 -- IN:  p_version_id   - The version ID
267 --      p_dataset_id   - The FEM Dataset ID
268 -------------------------------------------------------------------------
269 PROCEDURE REMOVE_DATASET (p_version_id   IN      NUMBER,
273 -- REMOVE_DIMENSION - Removes a dimension from the Business Area version
270                           p_dataset_id   IN      NUMBER);
271 
272 -------------------------------------------------------------------------
274 --
275 -- IN:  p_version_id     - The version ID
276 --      p_logical_dim_id - The FEM Dimension ID
277 -------------------------------------------------------------------------
278 PROCEDURE REMOVE_DIMENSION (p_version_id     IN      NUMBER,
279                             p_logical_dim_id IN      NUMBER);  -- "Consistent Dimension"
280 
281 -------------------------------------------------------------------------
282 -- REMOVE_HIERARCHY - Removes a hierarchy from the Business Area version
283 --
284 -- IN:  p_version_id     - The version ID
285 --      p_logical_dim_id - Logical Dim Id
286 --      p_hierarchy_id   - The FEM Hierarchy ID
287 -------------------------------------------------------------------------
288 PROCEDURE REMOVE_HIERARCHY (p_version_id   IN      NUMBER,
289                             p_logical_dim_id IN    NUMBER,  -- "Consistent Dimension"
290                             p_hierarchy_id IN      NUMBER);
291 
292 -------------------------------------------------------------------------
293 -- REMOVE_HIERARCHY_MEMBER - Removes a top level member to the
294 --                           Business Area version
295 --
296 -- IN:  p_version_id     - The version ID
297 --      p_logical_dim_id - Logical Dim Id
298 --      p_hierarchy_id   - The FEM Hierarchy ID
299 --      p_member_id      - The FEM member ID
300 --      p_member_vset    - The FEM member valueset ID (defaults to null)
301 --      p_hier_version   - The FEM hierarchy version ID (defaults to null)
302 -------------------------------------------------------------------------
303 PROCEDURE REMOVE_HIERARCHY_MEMBER (p_version_id     IN      NUMBER,
304                                    p_logical_dim_id IN      NUMBER, -- "Consistent Dimension"
305                                    p_hierarchy_id   IN      NUMBER,
306                                    p_member_id      IN      NUMBER,
307                                    p_member_vset    IN      NUMBER := null,
308                                    p_hier_version   IN      NUMBER := null);
309 
310 -------------------------------------------------------------------------
311 -- REMOVE_HIERARCHY_VERSION - Removes a hierarchy to the Business Area version
312 --
313 -- IN:  p_version_id     - The version ID
314 --      p_logical_dim_id - Logical Dim Id
315 --      p_hierarchy_id   - The FEM Hierarchy ID
316 --      p_hier_vers_id   - The FEM Hierarchy Version ID
317 -------------------------------------------------------------------------
318 PROCEDURE REMOVE_HIERARCHY_VERSION (p_version_id     IN      NUMBER,
319                                     p_logical_dim_id IN      NUMBER, -- "Consistent Dimension"
320                                     p_hierarchy_id   IN      NUMBER,
321                                     p_hier_vers_id   IN      NUMBER);
322 
323 
324 -------------------------------------------------------------------------
325 -- REMOVE_LEDGER - Removes a ledger from the Business Area version
326 --
327 -- IN:  p_version_id  - The version ID
328 --      p_ledger_id   - The FEM Ledger ID
329 -------------------------------------------------------------------------
330 PROCEDURE REMOVE_LEDGER (p_version_id  IN      NUMBER,
331                          p_ledger_id   IN      NUMBER);
332 
333 -------------------------------------------------------------------------
334 -- REMOVE_LEVEL - Removes a level from the Business Area version
335 --
336 -- IN:  p_version_id     - The version ID
337 --      p_logical_dim_id - Logical Dim Id
338 --      p_hierarchy_id   - The FEM Hierarchy ID
339 --      p_level_id       - The FEM Level ID
340 -------------------------------------------------------------------------
341 PROCEDURE REMOVE_LEVEL (p_version_id     IN      NUMBER,
342                         p_logical_dim_id IN      NUMBER, -- "Consistent Dimension"
343                         p_hierarchy_id   IN      NUMBER,
344                         p_level_id       IN      NUMBER);
345 
346 
347 -------------------------------------------------------------------------
348 -- HANDLE_FDR_CHANGES - Handles chnages in the FDR of a BA
349 --                    - Added for "Consistent Dimension" Project
350 --
351 -- IN:  p_version_id         - The version ID
352 --      p_fdr_obj_def_id_old - Old FDR Object Definition Id
353 --      p_fdr_obj_def_id_new - New FDR Object Definition Id
354 --      p_return_status      - return status
355 -------------------------------------------------------------------------
356 PROCEDURE HANDLE_FDR_CHANGES (p_version_id          IN          NUMBER,
357                               p_fdr_obj_def_id_old  IN          NUMBER,
358                               p_fdr_obj_def_id_new  IN          NUMBER,
359                               p_return_status       OUT NOCOPY VARCHAR2);
360 
361 
362 -------------------------------------------------------------------------
363 -- GENERATE_AW_DIM_NAME - Generates the AW name of a dimension
364 --                      - Added for "Consistent Dimension" Project
365 --
366 -- IN:  p_dim_type_code  - FEM Dimension Type Code
367 --      p_member_b_table - FEM XDIM Member B Table
368 -- OUT: p_aw_dim_name    - ZPB AW Dimension Name
369 -------------------------------------------------------------------------
370 PROCEDURE GENERATE_AW_DIM_NAME (p_dim_type_code    IN          VARCHAR2,
371                                 p_member_b_table   IN          VARCHAR2,
375 END ZPB_BUSAREA_MAINT;
372                                 p_aw_dim_name      OUT NOCOPY  VARCHAR2);
373 
374