xref: /aoo42x/main/offapi/com/sun/star/sdbc/XStruct.idl (revision cdf0e10c)
1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_sdbc_XStruct_idl__
28#define __com_sun_star_sdbc_XStruct_idl__
29
30#ifndef __com_sun_star_uno_XInterface_idl__
31#include <com/sun/star/uno/XInterface.idl>
32#endif
33
34 module com {  module sun {  module star {  module container {
35 published interface XNameAccess;
36};};};};
37
38#ifndef __com_sun_star_sdbc_SQLException_idl__
39#include <com/sun/star/sdbc/SQLException.idl>
40#endif
41
42 module com {  module sun {  module star {  module sdbc {
43
44
45/** is used for the standard mapping for a SQL structured type.
46
47
48	<p>
49	A
50	<code>Struct</code>
51	object contains a value for each attribute
52	of the SQL structured type that it represents.
53	By default, an instance of
54	<code>Struct</code>
55	is valid as long as the
56	application has a reference to it.
57	</p>
58 */
59published interface XStruct: com::sun::star::uno::XInterface
60{
61
62	/** retrieves the SQL type name of the SQL structured type
63		that this
64		<code>Struct</code>
65		object represents.
66		@returns
67			the name of the SQL type.
68		@throws SQLException
69			if a database access error occurs.
70	 */
71	string getSQLTypeName() raises (SQLException);
72
73  	//-------------------------------------------------------------------------
74
75	/** produces the ordered values of the attributes of the SQL
76		     structured type that this
77			 <code>Struct</code>
78			 object represents.
79		     <p>
80			 This method uses the given type map for customizations of the type
81			 mappings. If there is no entry in the given type map that matches or
82			 the given type map is
83			 <NULL/>
84			 , the structured type that this
85			 <code>Struct</code>
86			 object represents, the driver uses
87			 the connection type mapping.
88			 @param typeMap
89				is a map object that contains mappings of SQL type names to
90				services. If the
91				<code>typeMap</code>is
92				<NULL/>
93				, the type-map
94		   	    associated with the connection for customizations of the type-mappings
95				is used.
96		     @returns
97				an array containing the ordered attribute values.
98		     @throws SQLException
99				if a database access error occurs.
100	 */
101	sequence<any> getAttributes([in]com::sun::star::container::XNameAccess typeMap)
102		raises (SQLException);
103};
104
105//=============================================================================
106
107}; }; }; };
108
109/*===========================================================================
110===========================================================================*/
111#endif
112