offapi/com/sun/star/sdbc/XStruct.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
  20  module com {  module sun {  module star {  module container {
  21  published interface XNameAccess;
  22 };};};};
  23
  24  module com {  module sun {  module star {  module sdbc {
  25
  26
  27 /** is used for the standard mapping for a SQL structured type.
  28
  29
  30     <p>
  31     A
  32     <code>Struct</code>
  33     object contains a value for each attribute
  34     of the SQL structured type that it represents.
  35     By default, an instance of
  36     <code>Struct</code>
  37     is valid as long as the
  38     application has a reference to it.
  39     </p>
  40  */
  41 published interface XStruct: com::sun::star::uno::XInterface
  42 {
  43
  44     /** retrieves the SQL type name of the SQL structured type
  45         that this
  46         <code>Struct</code>
  47         object represents.
  48         @returns
  49             the name of the SQL type.
  50         @throws SQLException
  51             if a database access error occurs.
  52      */
  53     string getSQLTypeName() raises (SQLException);
  54
  55
  56     /** produces the ordered values of the attributes of the SQL
  57              structured type that this
  58              <code>Struct</code>
  59              object represents.
  60              <p>
  61              This method uses the given type map for customizations of the type
  62              mappings. If there is no entry in the given type map that matches or
  63              the given type map is
  64              `NULL`
  65              , the structured type that this
  66              <code>Struct</code>
  67              object represents, the driver uses
  68              the connection type mapping.
  69              @param typeMap
  70                 is a map object that contains mappings of SQL type names to
  71                 services. If the
  72                 <code>typeMap</code>is
  73                 `NULL`
  74                 , the type-map
  75                    associated with the connection for customizations of the type-mappings
  76                 is used.
  77              @returns
  78                 an array containing the ordered attribute values.
  79              @throws SQLException
  80                 if a database access error occurs.
  81      */
  82     sequence<any> getAttributes([in]com::sun::star::container::XNameAccess typeMap)
  83         raises (SQLException);
  84 };
  85
  86
  87 }; }; }; };
  88
  89 /*===========================================================================
  90 ===========================================================================*/
  91
  92 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */