offapi/com/sun/star/sdbc/XRef.idl

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