xref: /aoo41x/main/offapi/com/sun/star/sdbc/ProcedureColumn.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_ProcedureColumn_idl__
#define __com_sun_star_sdbc_ProcedureColumn_idl__

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


/** indicates the type of a procedure column.
 */
published constants ProcedureColumn
{

	/** indicates that the type of the column is unknown. A possible value for
			 the column
			 <code>COLUMN_TYPE</code>
			 in the
			 <type scope="com::sun::star::sdbc">XResultSet</type>
			 returned by the method
			 <member scope="com::sun::star::sdbc">XDatabaseMetaData::getProcedureColumns()</member>
			 .
	 */
	const long UNKNOWN		 	= 0;
    //-------------------------------------------------------------------------

	/** indicates that the column stores IN parameters.
			 A possible value for the column
		     <code>COLUMN_TYPE</code>
			 in the
			 <type scope="com::sun::star::sdbc">XResultSet</type>
			 returned by the method
			 <member scope="com::sun::star::sdbc">XDatabaseMetaData::getProcedureColumns()</member>
			 .
	 */
	const long IN				= 1;
    //-------------------------------------------------------------------------

	/** indicates that the column stores INOUT parameters.
			 A possible value for the column
		     <code>COLUMN_TYPE</code>
			 in the
			 <type scope="com::sun::star::sdbc">XResultSet</type>
			 returned by the method
			 <member scope="com::sun::star::sdbc">XDatabaseMetaData::getProcedureColumns()</member>
			 .
	 */
	const long INOUT		 	= 2;
    //-------------------------------------------------------------------------

	/** indicates that the column stores results.
			 A possible value for the column
		     <code>COLUMN_TYPE</code>
			 in the
			 <type scope="com::sun::star::sdbc">XResultSet</type>
			 returned by the method
			 <member scope="com::sun::star::sdbc">XDatabaseMetaData::getProcedureColumns()</member>
			 .
	 */
	const long RESULT 			= 3;
    //-------------------------------------------------------------------------

	/** indicates that the column stores OUT parameters.
			 A possible value for the column
		     <code>COLUMN_TYPE</code>
			 in the
			 <type scope="com::sun::star::sdbc">XResultSet</type>
			 returned by the method
			 <member scope="com::sun::star::sdbc">XDatabaseMetaData::getProcedureColumns()</member>
			 .
	 */
	const long OUT		 		= 4;
    //-------------------------------------------------------------------------

	/** Indicates that the column stores return values.
			 A possible value for the column
		     <code>COLUMN_TYPE</code>
			 in the
			 <type scope="com::sun::star::sdbc">XResultSet</type>
			 returned by the method
			 <member scope="com::sun::star::sdbc">XDatabaseMetaData::getProcedureColumns()</member>
			 .
	 */
	const long RETURN 			= 5;
};

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

}; }; }; };

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