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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_sdbc_XRef_idl__
  20 #define __com_sun_star_sdbc_XRef_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/sdbc/SQLException.idl>
  25
  26  module com {  module sun {  module star {  module sdbc {
  27
  28
  29 /** is the reference to a SQL structured type value in the database.  A
  30     Ref can be saved to persistent storage.  A Ref is dereferenced by
  31     passing it as a parameter to a SQL statement and executing the
  32     statement.
  33  */
  34 published interface XRef: com::sun::star::uno::XInterface
  35 {
  36
  37     /** gets the fully-qualified SQL structured type name of the referenced item.
  38         @returns
  39             the base type name
  40         @throws SQLException
  41             if a database access error occurs.
  42      */
  43     string getBaseTypeName() raises (SQLException);
  44 };
  45
  46
  47 }; }; }; };
  48
  49 /*===========================================================================
  50 ===========================================================================*/
  51 #endif
  52
  53 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */