DBA Data[Home] [Help]

PACKAGE: APPS.JTF_GRIDDB

Source


1 PACKAGE jtf_gridDB AUTHID CURRENT_USER as
2 /* $Header: JTFGRDDS.pls 120.1.12010000.2 2008/11/04 19:26:15 dbowles ship $ */
3   -------
4   -- Version 11.5.3 - 1.92 09-AUG-2000
5   -------
6   type dataSetType is table of jtf_dbstring_utils.maxString%TYPE
7    index by binary_integer;
8 
9   dataSet dataSetType;
10 
11   type colDefRecType is record
12   (
13      gridName                  varchar2(256)
14     ,grid_datasource_name      varchar2(30)  -- datasource
15     ,grid_col_alias            varchar2(30)        -- col_name
16     ,db_col_name               varchar2(255)
17     ,data_type_code            varchar2(30)       -- data_type
18     ,query_seq                 number(3)
19     ,sortable_flag             varchar2(1)
20     ,sort_asc_by_default_flag  varchar2(1)  -- sortAscending
21     ,visible_flag              varchar2(1)
22     ,freeze_visible_flag       varchar2(1)  --is_vis_flag_customizable
23     ,display_index             integer  -- not display_seq
24     ,display_type_code         varchar2(30)
25     ,display_format_type_code  varchar2(30)
26     ,display_hsize             number(6)  -- display_width
27     ,header_alignment_code     varchar2(30)
28     ,cell_alignment_code       varchar2(30)
29     ,display_format_mask       varchar2(255)
30     ,checkbox_checked_value    varchar2(255)
31     ,checkbox_unchecked_value  varchar2(255)
32     ,checkbox_other_values     varchar2(1)
33     ,db_currency_code_col      varchar2(30)
34     ,db_currency_col_alias     varchar2(30)
35     ,label_text                varchar2(80)
36     ,db_sort_column            varchar2(255)
37     ,fire_post_query_flag      varchar2(1)
38     ,image_description_col     varchar2(255)
39     ,SQL_colAlias              varchar2(30) -- keeps track of the SQL column
40                                             -- alias for this columnAlias.
41   );
42 
43   type colDefTabType is table of colDefRecType
44     index by binary_integer;
45 
46   type tabDefRecType is record
47   (
48      gridName              varchar2(256)
49     ,title_text            varchar2(80)
50     ,colCount              pls_integer
51     ,rowCount              pls_integer
52     ,moreRowsExists        varchar2(1)
53     ,SQLStatement          jtf_dbstring_utils.maxString%TYPE
54     ,SQLCursor             integer
55     ,grid_datasource_name  varchar2(30)  -- datasource
56     ,db_view_name          varchar2(30)  --tab_name
57     ,default_row_height    number(2) -- lines / row
58     ,max_queried_rows      number(5)
59     ,where_clause          varchar2(32767)
60     ,grid_sort_col_alias1  varchar2(30)  -- sort_column
61     ,grid_sort_col_alias2  varchar2(30)  -- sort_column
62     ,grid_sort_col_alias3  varchar2(30)  -- sort_column
63     ,alt_color_code        varchar2(30)
64     ,alt_color_interval    number(1)
65     ,custom_grid_id        number
66     ,custom_grid_name      varchar2(80)
67     ,public_flag           varchar2(1)
68     ,owner                 number(15)
69     ,hasWhereClauseChanged varchar2(1)
70     ,hasBindVarsChanged    varchar2(1)
71     ,refreshFlag           varchar2(1)
72     ,fetchSize             pls_integer
73   );
74 
75   type tabDefTabType is table of tabDefRecType
76     index by binary_integer;
77 
78   function  getFetchSize return number;
79   procedure setFetchSize(rows in number);
80 
81   function  isMoreRowsAvailable(gridName in varchar2
82                                ,p_serverInitDate in date) return varchar2;
83 
84 
85   function  fetchDataSet(gridName in varchar2
86                         ,p_serverInitDate in date) return dataSet%TYPE;
87   procedure init(gridName       in varchar2
88                 ,dataSource     in varchar2
89                 ,customGridId   in out nocopy number
90                 ,customGridName in out nocopy varchar2
91                 ,outPutStream   out nocopy jtf_dbstream_utils.streamType
92                 ,x_serverInitDate out nocopy date );
93 
94   procedure reset(gridName in varchar2, p_serverInitDate in date);
95   procedure refresh(gridName in varchar2, p_serverInitDate in date);
96 
97   procedure setSortCol(gridName       in varchar2
98                       ,col_alias1     in varchar2
99                       ,sort_asc_flag1 in varchar2
100                       ,col_alias2     in varchar2
101                       ,sort_asc_flag2 in varchar2
102                       ,col_alias3     in varchar2
103                       ,sort_asc_flag3 in varchar2
104                       ,p_serverInitDate in date);
105 
106   function  getWhereClause(gridName in varchar2
107                           ,p_serverInitDate in date) return varchar2;
108   procedure setWhereClause(gridName in varchar2, whereClause in varchar2
109                            ,p_serverInitDate in date);
110   function  findColumnIndex(gridName in varchar2,grid_col_alias in varchar2
111                             ,p_serverInitDate in date) return integer;
112   function  findColumnAlias(gridName in varchar2,columnIndex in integer
113                            ,p_serverInitDate in date) return varchar2;
114   function  getSQLStatement(gridName in varchar2
115                            ,p_serverInitDate in date) return varchar2;
116 
117   procedure setBindVariable(gridName in varchar2, variableName in varchar2, variableValue in varchar2, p_serverInitDate in date);
118   procedure setBindVariable(gridName in varchar2, variableName in varchar2, variableValue in date, p_serverInitDate in date);
119   procedure setBindVariable(gridName in varchar2, variableName in varchar2, variableValue in number, p_serverInitDate in date);
120   procedure removeAllBindVariables(gridName in varchar2
121                                   , p_serverInitDate in date);
122 
123   function getCharBindVariableValue(gridName in varchar2,
124                                     variableName in varchar2
125                                    ,p_serverInitDate in date) return varchar2;
126   function getDateBindVariableValue(gridName in varchar2
127                                    , variableName in varchar2
128                                    ,p_serverInitDate in date) return date;
129   function getNumberBindVariableValue(gridName in varchar2,
130                                       variableName in varchar2
131                                       ,p_serverInitDate in date) return number;
132 
133   function  getCharProperty(gridName in varchar2, propertyType in varchar2 ,p_serverInitDate in date) return varchar2;
134   procedure setCharProperty(gridName in varchar2, propertyType in varchar2, propertyValue in varchar2 ,p_serverInitDate in date);
135 
136   function  getColumnDefs(gridName in varchar2 ,p_serverInitDate in date) return colDefTabType;
137   function  findTableDefIndex(gridName in varchar2 ,p_serverInitDate in date) return binary_integer;
138 
139   procedure saveSerializedTableDef(gridName     in varchar2
140                                  ,dataSource   in varchar2
141                                  ,customGridId in out nocopy number
142                                  ,customGridName in out nocopy varchar2
143                                  ,defaultFlag in boolean
144                                  ,publicFlag  in boolean
145                                  ,inputStream jtf_dbstream_utils.streamType
146                                  ,successFlag out nocopy boolean
147                                  ,p_serverInitDate in date);
148 
149   function deleteCustomizations(gridName    in varchar2
150                                ,customGridId in number
151                                ,p_serverInitDate in date) return boolean;
152 
153   function getVersion return VARCHAR2;
154   procedure debug(p_debug_tbl IN JTF_DEBUG_PUB.debug_tbl_type
155                                  := JTF_DEBUG_PUB.G_MISS_DEBUG_TBL,
156                   p_gridname              IN   varchar2 := NULL,
157                   x_path                  OUT NOCOPY varchar2,
158                   x_filename              OUT NOCOPY  varchar2,
159  		  X_Return_Status         OUT NOCOPY  VARCHAR2,
160   		  X_Msg_Count             OUT NOCOPY  NUMBER,
161   		  X_Msg_Data              OUT NOCOPY  VARCHAR2);
162 
163 --  function getFormatMask(currency_code varchar2) return varchar2 deterministic;
164 
165   function  getGridFetchSize(gridName in varchar2, p_serverInitDate in date) return number;
166   procedure setGridFetchSize(gridName in varchar2, rows in number, p_serverInitDate in date);
167 
168 
169   procedure getSortCol(gridName       in varchar2
170                       ,p_serverInitDate in date
171                       ,sort_col1      out nocopy varchar2
172                       ,sort_asc_flag1 out nocopy varchar2
173                       ,sort_col2      out nocopy varchar2
174                       ,sort_asc_flag2 out nocopy varchar2
175                       ,sort_col3      out nocopy varchar2
176                       ,sort_asc_flag3 out nocopy varchar2
177                      );
178 
179   procedure getTableDefInfo(gridName       in varchar2
180                       ,p_serverInitDate in date
181                       ,x_sort_col1      out nocopy varchar2
182                       ,x_sort_col2      out nocopy varchar2
183                       ,x_sort_col3 out nocopy varchar2
184                       ,x_fetchSize      out nocopy number
185                      );
186 /** this function is invoked only from populate and refresh methods.
187     this function catches any "invalid package" exception and tries to recompile  them before throwing an error.
188 */
189 
190 function fetchFirstSet(gridName in varchar2
191                       ,p_serverInitDate in date) return dataSet%TYPE;
192 END jtf_gridDB;