xref: /aoo41x/main/offapi/com/sun/star/sdbc/XRef.idl (revision cdf0e10c)
1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_sdbc_XRef_idl__
28#define __com_sun_star_sdbc_XRef_idl__
29
30#ifndef __com_sun_star_uno_XInterface_idl__
31#include <com/sun/star/uno/XInterface.idl>
32#endif
33
34#ifndef __com_sun_star_sdbc_SQLException_idl__
35#include <com/sun/star/sdbc/SQLException.idl>
36#endif
37
38 module com {  module sun {  module star {  module sdbc {
39
40
41/** is the reference to a SQL structured type value in the database.  A
42	Ref can be saved to persistent storage.  A Ref is dereferenced by
43	passing it as a parameter to a SQL statement and executing the
44	statement.
45 */
46published interface XRef: com::sun::star::uno::XInterface
47{
48	//-------------------------------------------------------------------------
49
50	/** gets the fully-qualified SQL structured type name of the referenced item.
51		@returns
52			the base type name
53		@throws SQLException
54			if a database access error occurs.
55	 */
56	string getBaseTypeName() raises (SQLException);
57};
58
59//=============================================================================
60
61}; }; }; };
62
63/*===========================================================================
64===========================================================================*/
65#endif
66