xref: /aoo4110/main/offapi/com/sun/star/sdbc/XStruct.idl (revision b1cdbd2c) 
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_sdbc_XStruct_idl__
24#define __com_sun_star_sdbc_XStruct_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30 module com {  module sun {  module star {  module container {
31 published interface XNameAccess;
32};};};};
33
34#ifndef __com_sun_star_sdbc_SQLException_idl__
35#include <com/sun/star/sdbc/SQLException.idl>
36#endif
37
38 module com {  module sun {  module star {  module sdbc {
39
40
41/** is used for the standard mapping for a SQL structured type.
42
43
44	<p>
45	A
46	<code>Struct</code>
47	object contains a value for each attribute
48	of the SQL structured type that it represents.
49	By default, an instance of
50	<code>Struct</code>
51	is valid as long as the
52	application has a reference to it.
53	</p>
54 */
55published interface XStruct: com::sun::star::uno::XInterface
56{
57
58	/** retrieves the SQL type name of the SQL structured type
59		that this
60		<code>Struct</code>
61		object represents.
62		@returns
63			the name of the SQL type.
64		@throws SQLException
65			if a database access error occurs.
66	 */
67	string getSQLTypeName() raises (SQLException);
68
69  	//-------------------------------------------------------------------------
70
71	/** produces the ordered values of the attributes of the SQL
72		     structured type that this
73			 <code>Struct</code>
74			 object represents.
75		     <p>
76			 This method uses the given type map for customizations of the type
77			 mappings. If there is no entry in the given type map that matches or
78			 the given type map is
79			 <NULL/>
80			 , the structured type that this
81			 <code>Struct</code>
82			 object represents, the driver uses
83			 the connection type mapping.
84			 @param typeMap
85				is a map object that contains mappings of SQL type names to
86				services. If the
87				<code>typeMap</code>is
88				<NULL/>
89				, the type-map
90		   	    associated with the connection for customizations of the type-mappings
91				is used.
92		     @returns
93				an array containing the ordered attribute values.
94		     @throws SQLException
95				if a database access error occurs.
96	 */
97	sequence<any> getAttributes([in]com::sun::star::container::XNameAccess typeMap)
98		raises (SQLException);
99};
100
101//=============================================================================
102
103}; }; }; };
104
105/*===========================================================================
106===========================================================================*/
107#endif
108