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_embed_XCommonEmbedPersist_idl__
28#define __com_sun_star_embed_XCommonEmbedPersist_idl__
29
30#ifndef __com_sun_star_uno_XInterface_idl__
31#include <com/sun/star/uno/XInterface.idl>
32#endif
33
34#ifndef __com_sun_star_embed_XStorage_idl__
35#include <com/sun/star/embed/XStorage.idl>
36#endif
37
38#ifndef __com_sun_star_io_IOException_idl__
39#include <com/sun/star/io/IOException.idl>
40#endif
41
42#ifndef __com_sun_star_embed_WrongStateException_idl__
43#include <com/sun/star/embed/WrongStateException.idl>
44#endif
45
46#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
47#include <com/sun/star/lang/IllegalArgumentException.idl>
48#endif
49
50#ifndef __com_sun_star_beans_PropertyValue_idl__
51#include <com/sun/star/beans/PropertyValue.idl>
52#endif
53
54//============================================================================
55
56 module com {  module sun {  module star {  module embed {
57
58//============================================================================
59/** specifies common implementation for embedded objects and links
60	persistence.
61 */
62published interface XCommonEmbedPersist: com::sun::star::uno::XInterface
63{
64 	//------------------------------------------------------------------------
65    /** lets the object or the link store itself.
66
67        @throws com::sun::star::embed::WrongStateException
68			the object is in wrong state
69
70        @throws com::sun::star::io::IOException
71			in case of io problems during saving
72
73        @throws com::sun::star::uno::Exception
74			in case of other problems
75	 */
76	void storeOwn()
77		raises( ::com::sun::star::embed::WrongStateException,
78				::com::sun::star::io::IOException,
79				::com::sun::star::uno::Exception );
80
81	//------------------------------------------------------------------------
82    /** allows to detect if the data store is read-only.
83
84        @returns
85            <TRUE/> if the data store is readonly or opened readonly
86            <FALSE/> otherwise
87
88        @throws com::sun::star::embed::WrongStateException
89			the object is in wrong state ( has no entry )
90	 */
91	boolean isReadonly()
92		raises( ::com::sun::star::embed::WrongStateException );
93
94	//------------------------------------------------------------------------
95    /** lets the object or the link reload itself.
96
97		<p>
98		If the object has persistance it will be reloaded from it's persistant
99		entry.
100		</p>
101
102        @param aMediaArgs
103            optional parameters for document reloading, see also
104			<type scope="com::sun::star::document">MediaDescriptor</type>
105
106        @param aObjectArgs
107            optional parameters for object reloading, see also
108			<type scope="com::sun::star::embed">EmbeddedObjectDescriptor</type>
109
110		@thrown ::com::sun::star::lang::IllegalArgumentException
111			one of arguments is illegal
112
113        @throws com::sun::star::embed::WrongStateException
114			the object is in wrong state
115
116        @throws com::sun::star::io::IOException
117			in case of io problems during opening\creation
118
119        @throws com::sun::star::uno::Exception
120			in case of other problems
121	 */
122	void reload(
123			[in] sequence< ::com::sun::star::beans::PropertyValue > aMediaArgs,
124			[in] sequence< ::com::sun::star::beans::PropertyValue > aObjectArgs )
125		raises( ::com::sun::star::lang::IllegalArgumentException,
126				::com::sun::star::embed::WrongStateException,
127				::com::sun::star::io::IOException,
128				::com::sun::star::uno::Exception );
129};
130
131//============================================================================
132
133}; }; }; };
134
135#endif
136
137