xref: /trunk/main/offapi/com/sun/star/sdbc/XRef.idl (revision d1766043)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_sdbc_XRef_idl__
24#define __com_sun_star_sdbc_XRef_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30#ifndef __com_sun_star_sdbc_SQLException_idl__
31#include <com/sun/star/sdbc/SQLException.idl>
32#endif
33
34 module com {  module sun {  module star {  module sdbc {
35
36
37/** is the reference to a SQL structured type value in the database.  A
38	Ref can be saved to persistent storage.  A Ref is dereferenced by
39	passing it as a parameter to a SQL statement and executing the
40	statement.
41 */
42published interface XRef: com::sun::star::uno::XInterface
43{
44	//-------------------------------------------------------------------------
45
46	/** gets the fully-qualified SQL structured type name of the referenced item.
47		@returns
48			the base type name
49		@throws SQLException
50			if a database access error occurs.
51	 */
52	string getBaseTypeName() raises (SQLException);
53};
54
55//=============================================================================
56
57}; }; }; };
58
59/*===========================================================================
60===========================================================================*/
61#endif
62