xref: /aoo42x/main/offapi/com/sun/star/sdb/ResultColumn.idl (revision d1766043)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the 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