offapi/com/sun/star/embed/XPersistanceHolder.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XPersistanceHolder.idl,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_embed_XPersistanceHolder_idl__
  31 #define __com_sun_star_embed_XPersistanceHolder_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_io_IOException_idl__
  38 #include <com/sun/star/io/IOException.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_io_XStream_idl__
  42 #include <com/sun/star/io/XStream.idl>
  43 #endif
  44
  45 //=============================================================================
  46
  47  module com {  module sun {  module star {  module embed {
  48
  49 //=============================================================================
  50 /** allows to disconnect an object from its persistence.
  51  */
  52 interface XPersistanceHolder: com::sun::star::uno::XInterface
  53 {
  54     //-------------------------------------------------------------------------
  55     /** disconnects the object from the persistance.
  56
  57         @throws com::sun::star::io::IOException
  58             in case of io problems
  59
  60         @throws com::sun::star::uno::Exception
  61             in case of other problems
  62      */
  63     void disconnectPersistence()
  64         raises( ::com::sun::star::io::IOException,
  65                 ::com::sun::star::uno::Exception );
  66
  67     //-------------------------------------------------------------------------
  68     /** connects the object to a persistance.
  69
  70         @param xStream
  71             a stream that specify the persistance
  72
  73         @throws com::sun::star::io::IOException
  74             in case of io problems
  75
  76         @throws com::sun::star::uno::Exception
  77             in case of other problems
  78      */
  79     void connectPersistance(
  80             [in] ::com::sun::star::io::XStream xStream )
  81         raises( ::com::sun::star::io::IOException,
  82                 ::com::sun::star::uno::Exception );
  83
  84 };
  85
  86 //=============================================================================
  87
  88 }; }; }; };
  89
  90 #endif
  91