xref: /trunk/main/offapi/com/sun/star/frame/XStorable2.idl (revision 8e0daafc)
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_frame_XStorable2_idl__
24#define __com_sun_star_frame_XStorable2_idl__
25
26#ifndef __com_sun_star_frame_XStorable_idl__
27#include <com/sun/star/frame/XStorable.idl>
28#endif
29
30#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
31#include <com/sun/star/lang/IllegalArgumentException.idl>
32#endif
33
34#ifndef __com_sun_star_io_IOException_idl__
35#include <com/sun/star/io/IOException.idl>
36#endif
37
38#ifndef __com_sun_star_beans_PropertyValue_idl__
39#include <com/sun/star/beans/PropertyValue.idl>
40#endif
41
42
43//=============================================================================
44
45 module com {  module sun {  module star {  module frame {
46
47//=============================================================================
48/** extends <type>XStorable</type>.
49 */
50published interface XStorable2: XStorable
51{
52	/** stores the data to the URL from which it was loaded.
53
54		<p>
55			Only objects which know their locations can be stored.
56		</p>
57
58		<p>
59			This is an extension of the <method>XStorable::store()</method>.
60			This method allows to specify some additional parametes for
61			storing process.
62		</p>
63
64        @param lArguments
65            optional parameters for saving, can take values from subset of
66			<type scope="com::sun::star::document">MediaDescriptor</type>
67
68		@throws ::com::sun::star::lang::IllegalArgumentException
69			the optional parameters contain unacceptable for save entry
70
71        @throws com::sun::star::io::IOException
72            if an IO error occurred during save operation
73
74        @see XStorable::store
75	 */
76	void storeSelf(
77		[in] sequence<com::sun::star::beans::PropertyValue> lArguments )
78			raises( com::sun::star::lang::IllegalArgumentException,
79					com::sun::star::io::IOException );
80
81};
82
83//=============================================================================
84
85}; }; }; };
86
87#endif
88
89