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