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