summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/sdb/ResultColumn.idl
blob: 1bbaf6c61774cbd84ea2c91f6c689cc29fb17c8e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: ResultColumn.idl,v $
 * $Revision: 1.10 $
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_sdb_ResultColumn_idl__
#define __com_sun_star_sdb_ResultColumn_idl__

#ifndef __com_sun_star_sdbcx_Column_idl__
#include <com/sun/star/sdbcx/Column.idl>
#endif

#ifndef __com_sun_star_sdb_ColumnSettings_idl__
#include <com/sun/star/sdb/ColumnSettings.idl>
#endif

 module com {  module sun {  module star {  module sdb {


/** describes a column of a result set.
 */
published service ResultColumn
{
    service com::sun::star::sdbcx::Column;


    /** [optional], access to layout settings for a column.
     */
    service com::sun::star::sdb::ColumnSettings;


    /** indicates whether the column can be used in a Where clause.
     */
    [readonly, property] boolean IsSearchable;


    /** indicates whether values in the column are signed numbers.
     */
    [readonly, property] boolean IsSigned;


    /** indicates that a column is case sensitive.
     */
    [readonly, property] boolean IsCaseSensitive;


    /** indicates the column's normal max width in chars..
     */
    [readonly, property] long DisplaySize;


    /** gets the suggested column title for use in printouts and
        displays.
     */
    [readonly, property] string Label;


    /** indicates whether a column is definitely, not writable.
     */
    [readonly, property] boolean IsReadOnly;


    /** indicates whether it is possible for a write on the column to succeed.
     */
    [readonly, property] boolean IsWritable;


    /** indicates whether a write on the column will definitely succeed.
     */
    [readonly, property] boolean IsDefinitelyWritable;


    /** returns the fully-qualified name of the service whose instances
        are manufactured if the method
        <method scope="com::sun::star::sdbc">XRow::getObject)=</method>
        is called to retrieve a value from the column.
     */
    [readonly, property] string ServiceName;


    /** gets a column's table name.
     */
    [readonly, property] string TableName;


    /** gets a column's schema name.
     */
    [readonly, property] string SchemaName;


    /** gets a column's table's catalog name.
     */
    [readonly, property] string CatalogName;
};

//=============================================================================

}; }; }; };

/*===========================================================================
===========================================================================*/
#endif