xref: /AOO41X/main/offapi/com/sun/star/sdb/ResultColumn.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca) 
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_sdb_ResultColumn_idl__
24#define __com_sun_star_sdb_ResultColumn_idl__
25
26#ifndef __com_sun_star_sdbcx_Column_idl__
27#include <com/sun/star/sdbcx/Column.idl>
28#endif
29
30#ifndef __com_sun_star_sdb_ColumnSettings_idl__
31#include <com/sun/star/sdb/ColumnSettings.idl>
32#endif
33
34 module com {  module sun {  module star {  module sdb {
35
36
37/** describes a column of a result set.
38 */
39published service ResultColumn
40{
41    service com::sun::star::sdbcx::Column;
42
43
44    /** [optional], access to layout settings for a column.
45     */
46    service com::sun::star::sdb::ColumnSettings;
47
48
49    /** indicates whether the column can be used in a Where clause.
50     */
51    [readonly, property] boolean IsSearchable;
52
53
54    /** indicates whether values in the column are signed numbers.
55     */
56    [readonly, property] boolean IsSigned;
57
58
59    /** indicates that a column is case sensitive.
60     */
61    [readonly, property] boolean IsCaseSensitive;
62
63
64    /** indicates the column's normal max width in chars..
65     */
66    [readonly, property] long DisplaySize;
67
68
69    /** gets the suggested column title for use in printouts and
70        displays.
71     */
72    [readonly, property] string Label;
73
74
75    /** indicates whether a column is definitely, not writable.
76     */
77    [readonly, property] boolean IsReadOnly;
78
79
80    /** indicates whether it is possible for a write on the column to succeed.
81     */
82    [readonly, property] boolean IsWritable;
83
84
85    /** indicates whether a write on the column will definitely succeed.
86     */
87    [readonly, property] boolean IsDefinitelyWritable;
88
89
90    /** returns the fully-qualified name of the service whose instances
91        are manufactured if the method
92        <method scope="com::sun::star::sdbc">XRow::getObject)=</method>
93        is called to retrieve a value from the column.
94     */
95    [readonly, property] string ServiceName;
96
97
98    /** gets a column's table name.
99     */
100    [readonly, property] string TableName;
101
102
103    /** gets a column's schema name.
104     */
105    [readonly, property] string SchemaName;
106
107
108    /** gets a column's table's catalog name.
109     */
110    [readonly, property] string CatalogName;
111};
112
113//=============================================================================
114
115}; }; }; };
116
117/*===========================================================================
118===========================================================================*/
119#endif
120