xref: /aoo42x/main/offapi/com/sun/star/embed/XCommonEmbedPersist.idl (revision cdf0e10c)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org 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 version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_embed_XCommonEmbedPersist_idl__
#define __com_sun_star_embed_XCommonEmbedPersist_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_embed_XStorage_idl__
#include <com/sun/star/embed/XStorage.idl>
#endif

#ifndef __com_sun_star_io_IOException_idl__
#include <com/sun/star/io/IOException.idl>
#endif

#ifndef __com_sun_star_embed_WrongStateException_idl__
#include <com/sun/star/embed/WrongStateException.idl>
#endif

#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
#endif

#ifndef __com_sun_star_beans_PropertyValue_idl__
#include <com/sun/star/beans/PropertyValue.idl>
#endif

//============================================================================

 module com {  module sun {  module star {  module embed {

//============================================================================
/** specifies common implementation for embedded objects and links
	persistence.
 */
published interface XCommonEmbedPersist: com::sun::star::uno::XInterface
{
 	//------------------------------------------------------------------------
    /** lets the object or the link store itself.

        @throws com::sun::star::embed::WrongStateException
			the object is in wrong state

        @throws com::sun::star::io::IOException
			in case of io problems during saving

        @throws com::sun::star::uno::Exception
			in case of other problems
	 */
	void storeOwn()
		raises( ::com::sun::star::embed::WrongStateException,
				::com::sun::star::io::IOException,
				::com::sun::star::uno::Exception );

	//------------------------------------------------------------------------
    /** allows to detect if the data store is read-only.

        @returns
            <TRUE/> if the data store is readonly or opened readonly
            <FALSE/> otherwise

        @throws com::sun::star::embed::WrongStateException
			the object is in wrong state ( has no entry )
	 */
	boolean isReadonly()
		raises( ::com::sun::star::embed::WrongStateException );

	//------------------------------------------------------------------------
    /** lets the object or the link reload itself.

		<p>
		If the object has persistance it will be reloaded from it's persistant
		entry.
		</p>

        @param aMediaArgs
            optional parameters for document reloading, see also
			<type scope="com::sun::star::document">MediaDescriptor</type>

        @param aObjectArgs
            optional parameters for object reloading, see also
			<type scope="com::sun::star::embed">EmbeddedObjectDescriptor</type>

		@thrown ::com::sun::star::lang::IllegalArgumentException
			one of arguments is illegal

        @throws com::sun::star::embed::WrongStateException
			the object is in wrong state

        @throws com::sun::star::io::IOException
			in case of io problems during opening\creation

        @throws com::sun::star::uno::Exception
			in case of other problems
	 */
	void reload(
			[in] sequence< ::com::sun::star::beans::PropertyValue > aMediaArgs,
			[in] sequence< ::com::sun::star::beans::PropertyValue > aObjectArgs )
		raises( ::com::sun::star::lang::IllegalArgumentException,
				::com::sun::star::embed::WrongStateException,
				::com::sun::star::io::IOException,
				::com::sun::star::uno::Exception );
};

//============================================================================

}; }; }; };

#endif