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