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