1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
module com { module sun { module star { module sdbc {
published interface XSQLInput;
published interface XSQLOutput;
/** is used for the custom mapping of SQL user-defined types.
<p>
This interface must be implemented by a service that is
registered in a type mapping. It is expected that this interface
will normally be implemented by a tool. The methods in this interface
are called by the driver and are never called by a programmer
directly.
</p>
*/
published interface XSQLData: com::sun::star::uno::XInterface
{
/** returns the fully-qualified name of the SQL user-defined type
that this object represents.
<p>
This method is called by the SDBC driver to get the name of the
UDT instance that is being mapped to this instance of SQLData.
</p>
@returns
the name of the SQL type.
@throws SQLException
if a database access error occurs.
*/
string getSQLTypeName() raises (SQLException);
/** populates this object with data read from the database.
<p>
The implementation of the method must follow this protocol:
<br/>
It must read each of the attributes or elements of the SQL
type from the given input stream. This is done
by calling a method of the input stream to read each
item, in the order that they appear in the SQL definition
of the type. The method
<code>readSQL</code>
then assigns the data to appropriate fields or elements (of this
or other objects).
<br/>
Specifically, it must call the appropriate
<code>XSQLInput.readXXX</code>
method(s) to do the following:
for a Distinct Type, read its single data element;
for a Structured Type, read a value for each attribute of the SQL type.
</p>
<p>
The SDBC driver initializes the input stream with a type map
before calling this method, which is used by the appropriate
<code>SQLInput.readXXX</code>
method on the stream.
</p>
@param stream
the input SQL data stream
@param typeName
the SQL type of the value on the data stream
@throws SQLException
if a database access error occurs.
@see com::sun::star::sdbc::XSQLInput
*/
void readSQL([in]XSQLInput stream, [in]string typeName)
raises (SQLException);
/** writes this object to the given SQL data stream.
<p>
The implementation of the method must follow this protocol:
<br/>
It must write each of the attributes of the SQL type to the given output
stream. This is done by calling a method of the output stream to write
each item, in the order that they appear in the SQL definition of the type.
Specifically, it must call the appropriate
<code>XSQLOutput.writeXXX</code>
method(s) to do the following:<br>
for a Distinct Type, write its single data element;
for a Structured Type, write a value for each attribute of the SQL type.
</p>
@param stream
the output SQL data stream
@throws SQLException
if a database access error occurs.
@see com::sun::star::sdbc::XSQLOutput
*/
void writeSQL([in]XSQLOutput stream) raises (SQLException);
};
}; }; }; };
/*===========================================================================
===========================================================================*/
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
