xref: /aoo42x/main/offapi/com/sun/star/sdbc/ColumnSearch.idl (revision cdf0e10c)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * 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_sdbc_ColumnSearch_idl__
#define __com_sun_star_sdbc_ColumnSearch_idl__

 module com {  module sun {  module star {  module sdbc {


/** indicates in which way a column can be used in the WHERE search.
 */
published constants ColumnSearch
{
	//-------------------------------------------------------------------------

	/** A possible value for column <code>SEARCHABLE</code> in the
			 <type scope="com::sun::star::sdbc">XResultSet</type>
			 object returned by the method
			 <member  scope="com::sun::star::sdbc">XDatabaseMetaData::getTypeInfo()</member>
			 .
			 <p>
			 Indicates that
			 <code>WHERE</code>
			 search clauses are not supported
			 for this type.
	 */
	const long NONE = 0;
	//-------------------------------------------------------------------------

	/** A possible value for column <code>SEARCHABLE</code> in the
			 <type scope="com::sun::star::sdbc">XResultSet</type>
			 object returned by the method
			 <member  scope="com::sun::star::sdbc">XDatabaseMetaData::getTypeInfo()</member>
			 .
			 <p>
			 Indicates that the only
			 <code>WHERE</code>
			 search clause that can
			 be based on this type is
			 <code>WHERE...LIKE</code>
			 .
	 */
	const long CHAR = 1;
	//-------------------------------------------------------------------------

	/** A possible value for column <code>SEARCHABLE</code> in the
			 <type scope="com::sun::star::sdbc">XResultSet</type>
			 object returned by the method
			 <member  scope="com::sun::star::sdbc">XDatabaseMetaData::getTypeInfo()</member>
			 .
			 <p>
			 Indicates that one can base all
			 <code>WHERE</code>
			 search clauses
			 except
			 <code>WHERE...LIKE</code>
			 on this data type.
	 */
	const long BASIC = 2;
	//-------------------------------------------------------------------------

	/** A possible value for column
			<code>SEARCHABLE</code>
			in the
			<type scope="com::sun::star::sdbc">XResultSet</type>
			object returned by the method
			<member  scope="com::sun::star::sdbc">XDatabaseMetaData::getTypeInfo()</member>
			.
			<p>
			Indicates that all
			<code>WHERE</code>
			search clauses can be
			based on this type.
	 */
	const long FULL  = 3;
};

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

}; }; }; };

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