1*d1766043SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4*d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5*d1766043SAndrew Rist * distributed with this work for additional information
6*d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9*d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10*d1766043SAndrew Rist *
11*d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12*d1766043SAndrew Rist *
13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14*d1766043SAndrew Rist * software distributed under the License is distributed on an
15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17*d1766043SAndrew Rist * specific language governing permissions and limitations
18*d1766043SAndrew Rist * under the License.
19*d1766043SAndrew Rist *
20*d1766043SAndrew Rist *************************************************************/
21*d1766043SAndrew Rist
22*d1766043SAndrew Rist
23cdf0e10cSrcweir#ifndef __com_sun_star_embed_XCommonEmbedPersist_idl__
24cdf0e10cSrcweir#define __com_sun_star_embed_XCommonEmbedPersist_idl__
25cdf0e10cSrcweir
26cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__
27cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl>
28cdf0e10cSrcweir#endif
29cdf0e10cSrcweir
30cdf0e10cSrcweir#ifndef __com_sun_star_embed_XStorage_idl__
31cdf0e10cSrcweir#include <com/sun/star/embed/XStorage.idl>
32cdf0e10cSrcweir#endif
33cdf0e10cSrcweir
34cdf0e10cSrcweir#ifndef __com_sun_star_io_IOException_idl__
35cdf0e10cSrcweir#include <com/sun/star/io/IOException.idl>
36cdf0e10cSrcweir#endif
37cdf0e10cSrcweir
38cdf0e10cSrcweir#ifndef __com_sun_star_embed_WrongStateException_idl__
39cdf0e10cSrcweir#include <com/sun/star/embed/WrongStateException.idl>
40cdf0e10cSrcweir#endif
41cdf0e10cSrcweir
42cdf0e10cSrcweir#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
43cdf0e10cSrcweir#include <com/sun/star/lang/IllegalArgumentException.idl>
44cdf0e10cSrcweir#endif
45cdf0e10cSrcweir
46cdf0e10cSrcweir#ifndef __com_sun_star_beans_PropertyValue_idl__
47cdf0e10cSrcweir#include <com/sun/star/beans/PropertyValue.idl>
48cdf0e10cSrcweir#endif
49cdf0e10cSrcweir
50cdf0e10cSrcweir//============================================================================
51cdf0e10cSrcweir
52cdf0e10cSrcweir module com {  module sun {  module star {  module embed {
53cdf0e10cSrcweir
54cdf0e10cSrcweir//============================================================================
55cdf0e10cSrcweir/** specifies common implementation for embedded objects and links
56cdf0e10cSrcweir	persistence.
57cdf0e10cSrcweir */
58cdf0e10cSrcweirpublished interface XCommonEmbedPersist: com::sun::star::uno::XInterface
59cdf0e10cSrcweir{
60cdf0e10cSrcweir 	//------------------------------------------------------------------------
61cdf0e10cSrcweir    /** lets the object or the link store itself.
62cdf0e10cSrcweir
63cdf0e10cSrcweir        @throws com::sun::star::embed::WrongStateException
64cdf0e10cSrcweir			the object is in wrong state
65cdf0e10cSrcweir
66cdf0e10cSrcweir        @throws com::sun::star::io::IOException
67cdf0e10cSrcweir			in case of io problems during saving
68cdf0e10cSrcweir
69cdf0e10cSrcweir        @throws com::sun::star::uno::Exception
70cdf0e10cSrcweir			in case of other problems
71cdf0e10cSrcweir	 */
72cdf0e10cSrcweir	void storeOwn()
73cdf0e10cSrcweir		raises( ::com::sun::star::embed::WrongStateException,
74cdf0e10cSrcweir				::com::sun::star::io::IOException,
75cdf0e10cSrcweir				::com::sun::star::uno::Exception );
76cdf0e10cSrcweir
77cdf0e10cSrcweir	//------------------------------------------------------------------------
78cdf0e10cSrcweir    /** allows to detect if the data store is read-only.
79cdf0e10cSrcweir
80cdf0e10cSrcweir        @returns
81cdf0e10cSrcweir            <TRUE/> if the data store is readonly or opened readonly
82cdf0e10cSrcweir            <FALSE/> otherwise
83cdf0e10cSrcweir
84cdf0e10cSrcweir        @throws com::sun::star::embed::WrongStateException
85cdf0e10cSrcweir			the object is in wrong state ( has no entry )
86cdf0e10cSrcweir	 */
87cdf0e10cSrcweir	boolean isReadonly()
88cdf0e10cSrcweir		raises( ::com::sun::star::embed::WrongStateException );
89cdf0e10cSrcweir
90cdf0e10cSrcweir	//------------------------------------------------------------------------
91cdf0e10cSrcweir    /** lets the object or the link reload itself.
92cdf0e10cSrcweir
93cdf0e10cSrcweir		<p>
94cdf0e10cSrcweir		If the object has persistance it will be reloaded from it's persistant
95cdf0e10cSrcweir		entry.
96cdf0e10cSrcweir		</p>
97cdf0e10cSrcweir
98cdf0e10cSrcweir        @param aMediaArgs
99cdf0e10cSrcweir            optional parameters for document reloading, see also
100cdf0e10cSrcweir			<type scope="com::sun::star::document">MediaDescriptor</type>
101cdf0e10cSrcweir
102cdf0e10cSrcweir        @param aObjectArgs
103cdf0e10cSrcweir            optional parameters for object reloading, see also
104cdf0e10cSrcweir			<type scope="com::sun::star::embed">EmbeddedObjectDescriptor</type>
105cdf0e10cSrcweir
106cdf0e10cSrcweir		@thrown ::com::sun::star::lang::IllegalArgumentException
107cdf0e10cSrcweir			one of arguments is illegal
108cdf0e10cSrcweir
109cdf0e10cSrcweir        @throws com::sun::star::embed::WrongStateException
110cdf0e10cSrcweir			the object is in wrong state
111cdf0e10cSrcweir
112cdf0e10cSrcweir        @throws com::sun::star::io::IOException
113cdf0e10cSrcweir			in case of io problems during opening\creation
114cdf0e10cSrcweir
115cdf0e10cSrcweir        @throws com::sun::star::uno::Exception
116cdf0e10cSrcweir			in case of other problems
117cdf0e10cSrcweir	 */
118cdf0e10cSrcweir	void reload(
119cdf0e10cSrcweir			[in] sequence< ::com::sun::star::beans::PropertyValue > aMediaArgs,
120cdf0e10cSrcweir			[in] sequence< ::com::sun::star::beans::PropertyValue > aObjectArgs )
121cdf0e10cSrcweir		raises( ::com::sun::star::lang::IllegalArgumentException,
122cdf0e10cSrcweir				::com::sun::star::embed::WrongStateException,
123cdf0e10cSrcweir				::com::sun::star::io::IOException,
124cdf0e10cSrcweir				::com::sun::star::uno::Exception );
125cdf0e10cSrcweir};
126cdf0e10cSrcweir
127cdf0e10cSrcweir//============================================================================
128cdf0e10cSrcweir
129cdf0e10cSrcweir}; }; }; };
130cdf0e10cSrcweir
131cdf0e10cSrcweir#endif
132cdf0e10cSrcweir
133