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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
|
/*************************************************************************
*
* $RCSfile: XPersistObject.idl,v $
*
* $Revision: 1.8 $
*
* last change: $Author: mi $ $Date: 2002-10-03 12:44:00 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (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.openoffice.org/license.html.
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************/
#ifndef __com_sun_star_io_XPersistObject_idl__
#define __com_sun_star_io_XPersistObject_idl__
#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif
#ifndef __com_sun_star_io_IOException_idl__
#include <com/sun/star/io/IOException.idl>
#endif
//=============================================================================
module com { module sun { module star { module io {
interface XObjectInputStream;
interface XObjectOutputStream;
//=============================================================================
/** allows to make UNO objects persistent
<p>Every UNO object, that wants to be serializable, should implement
this interface. The object stores stores itself, when the
write method is called.
<p>
The object needs to be created before it deserializes
itself again (by using the read method). Therefor it must be
createable by name via a factory, which is in general
the global service manager. The create and read mechanism
is implemented by the <type>com::sun::star::io::ObjectInputStream</type>.
<p>The serialization format (the series of strings, integers, objects) must
be specified at the specification of the concrete service.
<p>The interface does not support any special versioning mechanism.
@see com::sun::star::io::XObjectOutputStream
@see com::sun::star::io::XObjectInputStream
*/
interface XPersistObject: com::sun::star::uno::XInterface
{
//-------------------------------------------------------------------------
/** gives the service name of the object
@returns
the service name that specifies the behavior and the
persistent data format of this implementation.
<p>This name is used to create such an object by a factory
during deserialization. </p>
@see com::sun::star::lang::XServiceInfo::getAvailableServiceNames
*/
string getServiceName();
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::io::XPersistObject::write
/** writes all the persistent data of the object to the stream.
<p>The implementation
must write the data in the order documented in the service specification.
@param OutStream the stream, the data shall be written to. The stream
supports simple types and other XPersistObject implementations.
*/
void write( [in] com::sun::star::io::XObjectOutputStream OutStream )
raises( com::sun::star::io::IOException );
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::io::XPersistObject::read
/** reads all the persistent data of the object from the stream.
<p>In case
other XPersistObjects are read from the stream, the implementation uses a factory
to create these objects (in general the global service manager).
<p> The implementation must read the data in the order documented at
the service specification.
@param InStream the stream, the data shall be read from.
*/
void read( [in] com::sun::star::io::XObjectInputStream InStream )
raises( com::sun::star::io::IOException );
};
//=============================================================================
}; }; }; };
/*=============================================================================
$Log: not supported by cvs2svn $
Revision 1.7.2.1 2002/06/05 16:38:41 jbu
documentation reviewed
Revision 1.7 2002/01/18 13:41:36 jbu
#96701# DataInputStream.idl DataOutputStream.idl MarkableInputStream.idl MarkableOutputStream.idl ObjectInputStream.idl ObjectOutputStream.idl Pipe.idl Pump.idl XDataInputStream.idl XDataOutputStream.idl XInputStream.idl XOutputStream.idl XPersistObject.idl
Revision 1.6 2001/03/16 15:10:36 jsc
remove interfaceheader with uik and remove [const] in method definitions
Revision 1.5 2000/12/11 16:09:49 mi
documentation syntax fixed and some minor semantic documentation fixes
Revision 1.4 2000/11/08 12:28:36 mi
moved from api
Revision 1.1.1.1 2000/09/18 23:35:24 hjs
initial import
Revision 1.5 2000/09/11 11:52:31 mi
documentation merged from XML
Revision 1.3 2000/02/17 17:19:43 mi
proofreading in layouted version
Revision 1.2 2000/02/07 11:24:38 mi
zu #70728# missing documentation marked
Revision 1.1.1.1 1999/11/11 09:48:43 jsc
new
=============================================================================*/
#endif
|
