DBA Data[Home] [Help]

PACKAGE: APPS.BIS_VIEW_GENERATOR_PVT

Source


1 PACKAGE BIS_VIEW_GENERATOR_PVT AUTHID CURRENT_USER AS
2 /* $Header: BISTBVGS.pls 120.2 2008/04/23 17:03:40 dbowles ship $ */
3 
4 ---  Copyright (c) 1998 Oracle Corporation, Redwood Shores, CA, USA
5 ---  All rights reserved.
6 ---
7 ---  FILENAME
8 ---
9 ---      BISTBVGS.pls
10 ---
11 ---  DESCRIPTION
12 ---
13 ---      specification  of package which generates the business views
14 ---
15 ---  NOTES
16 ---
17 ---  HISTORY
18 ---
19 ---  29-JUL-98 Created
20 ---  19-MAR-99 Edited by WNASRALL@US for exception handling
21 ---  03-NOV-00 Walid.Nasrallah  added new API Generate_Pruned_View
22 ---  04-JAN-01 Walid.Nasrallah changed signature of Generate_Pruned_View
23 ---  10-JAN-01 Walid.Nasrallah separated two signatures for
24 ---                            Generate_Pruned_View
25 ---  10-DEC-01 Edited by DBOWLES Added db driver comment
26 ---  18-JAN-05 Modified by AMITGUPT for GSCC warnings
27 ---
28 ---
29 g_debug_file  VARCHAR2(2000);
30 ---  Bug 6819715
31 ---  variable to control whether or not to use optimizer hints
32 g_use_optimizer_hints   VARCHAR2(3);
33 g_db_version            VARCHAR2(2);
34 --- ============================================================================
35 ---   PROCEDURE : Generate_Pruned_View
36 ---   PARAMETERS: 1. p_viewname        Name of source view
37 ---               2. p_column_table    Table of column names to generate
38 ---               3. x_success         Specifies if generate was successful
39 ---               4. x_error_string    Holds error message if unsuccesful
40 ---   COMMENT   : API to be called from Application Integrator.
41 ---               Generates one view only, throws exceptionson failure.
42 ---   EXCEPTIONS:
43 ---
44 ---
45 --- ============================================================================
46 
47 PROCEDURE Generate_Pruned_View
48    (   p_viewname      IN BIS_VG_TYPES.view_name_type
49      , p_objectname    IN VARCHAR2
50      , p_gen_viewname  IN VARCHAR2 DEFAULT NULL
51    );
52 
53 --- ============================================================================
54 ---   PROCEDURE : generate_Views
55 ---    PARAMETERS: 1. x_error_buf          error buffer to hold concurrent program error
56 ---                2. x_ret_code           return code of concurrent program
57 ---                3. p_all_flag           generate all views for all products
58 ---                4. p_Appl_Short_Name    application product_short name
59 ---                5. p_KF_Appl_Short_Name application product_short name
60 ---                6. p_Key_Flex_Code      key flexfield code
61 ---                7. p_DF_Appl_Short_Name application product_short name
62 ---                8. p_Desc_Flex_Name     descriptive flex field name
63 ---                9. p_Lookup_Table_Name  lookup table name
64 ---               10. p_Lookup_Type        lookup code type
65 ---               11. p_View_Name          name of view to generate
66 ---
67 ---    COMMENT   : Launch this program to generate the business view(s) with the key flexfield,
68 ---                descriptive flexfield and lookup information.
69 ---    EXCEPTION : None
70 --- ============================================================================
71    PROCEDURE generate_Views
72    ( x_error_buf           OUT NOCOPY VARCHAR2
73    , x_ret_code            OUT NOCOPY NUMBER
74    , p_all_flag            IN  VARCHAR2                         := NULL
75    , p_App_Short_Name      IN  BIS_VG_TYPES.App_Short_Name_Type := NULL
76    , p_KF_Appl_Short_Name  IN  BIS_VG_TYPES.App_Short_Name_Type := NULL
77    , p_Key_Flex_Code       IN  BIS_VG_TYPES.Key_Flex_Code_Type  := NULL
78    , p_DF_Appl_Short_Name  IN  BIS_VG_TYPES.App_Short_Name_Type := NULL
79    , p_Desc_Flex_Name      IN  BIS_VG_TYPES.Desc_Flex_Name_Type := NULL
80    , p_Lookup_Table_Name   IN  VARCHAR2                         := NULL
81    , p_Lookup_Type         IN  BIS_VG_TYPES.Lookup_Code_Type    := NULL
82    , p_View_Name           IN  BIS_VG_TYPES.View_Name_Type      := NULL
83    );
84 
85 --- ============================================================================
86 ---   IMPORTANT NOTE
87 ---     The following procedure and the mode is ONLY for test purposes only
88 ---     It should not be used by anybody except for testing
89 --- =============================================================================
90 
91 ---  ============================================================================
92 ---    PROCEDURE : set_mode
93 ---    PARAMETERS:
94 ---    1. p_mode               in View_Generator_Mode_Type
95 ---    2. x_return_status    error or normal
96 ---    3. x_error_Tbl        table of error messages
97 ---
98 ---    COMMENT   : sets the behaviour mode for the program.  Two versions for
99 --- 		backward compatibility.
100 ---    EXCEPTION : None
101 --- ============================================================================
102 PROCEDURE set_mode
103 (p_mode IN bis_vg_types.view_generator_mode_type);
104 
105 PROCEDURE set_mode
106 (p_mode IN bis_vg_types.view_generator_mode_type
107 , x_return_status       OUT NOCOPY VARCHAR2
108 , x_error_Tbl           OUT NOCOPY BIS_VG_UTIL.Error_Tbl_Type
109 
110 );
111 
112 --
113 --
114 --============================================================================
115 --  EXCEPTIONS and ERROR MESSAGES
116 --  ==========================================================================
117 
118   NO_WAREHOUSE_LINK_FOUND      EXCEPTION;
119   NO_VIEW_NAME_PASSED          EXCEPTION;
120   CANNOT_PRUNE_NON_EDW_VIEW    EXCEPTION;
121   NO_COLUMNS_SELECTED          EXCEPTION;
122 
123   GENERATOR_NO_VIEWS   CONSTANT VARCHAR2(50):= 'BIS_VG_UNDEFINED_VIEW';
124 
125 
126   MISMATCHED_TAG_EXCEPTION EXCEPTION;
127   MISMATCHED_TAG_EXCEPTION_MSG CONSTANT VARCHAR2(50) := 'BIS_VG_MISMATCHED_TAG_MSG';
128 ---
129   INVALID_TAG_EXCEPTION EXCEPTION;
130   INVALID_TAG_EXCEPTION_MSG CONSTANT VARCHAR2(50) := 'BIS_VG_INVALID_TAG_MSG';
131 ---
132 --  ==========================================================================
133 --  CONSTANTS
134 --  ==========================================================================
135 
136 
137 END BIS_VIEW_GENERATOR_PVT;