offapi/com/sun/star/sdbc/XStruct.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: XStruct.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_XStruct_idl__
  31 #define __com_sun_star_sdbc_XStruct_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37  module com {  module sun {  module star {  module container {
  38  published interface XNameAccess;
  39 };};};};
  40
  41 #ifndef __com_sun_star_sdbc_SQLException_idl__
  42 #include <com/sun/star/sdbc/SQLException.idl>
  43 #endif
  44
  45  module com {  module sun {  module star {  module sdbc {
  46
  47
  48 /** is used for the standard mapping for a SQL structured type.
  49
  50
  51     <p>
  52     A
  53     <code>Struct</code>
  54     object contains a value for each attribute
  55     of the SQL structured type that it represents.
  56     By default, an instance of
  57     <code>Struct</code>
  58     is valid as long as the
  59     application has a reference to it.
  60     </p>
  61  */
  62 published interface XStruct: com::sun::star::uno::XInterface
  63 {
  64
  65     /** retrieves the SQL type name of the SQL structured type
  66         that this
  67         <code>Struct</code>
  68         object represents.
  69         @returns
  70             the name of the SQL type.
  71         @throws SQLException
  72             if a database access error occurs.
  73      */
  74     string getSQLTypeName() raises (SQLException);
  75
  76       //-------------------------------------------------------------------------
  77
  78     /** produces the ordered values of the attributes of the SQL
  79              structured type that this
  80              <code>Struct</code>
  81              object represents.
  82              <p>
  83              This method uses the given type map for customizations of the type
  84              mappings. If there is no entry in the given type map that matches or
  85              the given type map is
  86              <NULL/>
  87              , the structured type that this
  88              <code>Struct</code>
  89              object represents, the driver uses
  90              the connection type mapping.
  91              @param typeMap
  92                 is a map object that contains mappings of SQL type names to
  93                 services. If the
  94                 <code>typeMap</code>is
  95                 <NULL/>
  96                 , the type-map
  97                    associated with the connection for customizations of the type-mappings
  98                 is used.
  99              @returns
 100                 an array containing the ordered attribute values.
 101              @throws SQLException
 102                 if a database access error occurs.
 103      */
 104     sequence<any> getAttributes([in]com::sun::star::container::XNameAccess typeMap)
 105         raises (SQLException);
 106 };
 107
 108 //=============================================================================
 109
 110 }; }; }; };
 111
 112 /*===========================================================================
 113 ===========================================================================*/
 114 #endif