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

   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_XPersistanceHolder_idl__
  28 #define __com_sun_star_embed_XPersistanceHolder_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_io_IOException_idl__
  35 #include <com/sun/star/io/IOException.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_io_XStream_idl__
  39 #include <com/sun/star/io/XStream.idl>
  40 #endif
  41
  42 //=============================================================================
  43
  44  module com {  module sun {  module star {  module embed {
  45
  46 //=============================================================================
  47 /** allows to disconnect an object from its persistence.
  48  */
  49 published interface XPersistanceHolder: com::sun::star::uno::XInterface
  50 {
  51     //-------------------------------------------------------------------------
  52     /** disconnects the object from the persistance.
  53
  54         @throws com::sun::star::io::IOException
  55             in case of io problems
  56
  57         @throws com::sun::star::uno::Exception
  58             in case of other problems
  59      */
  60     void disconnectPersistence()
  61         raises( ::com::sun::star::io::IOException,
  62                 ::com::sun::star::uno::Exception );
  63
  64     //-------------------------------------------------------------------------
  65     /** connects the object to a persistance.
  66
  67         @param xStream
  68             a stream that specify the persistance
  69
  70         @throws com::sun::star::io::IOException
  71             in case of io problems
  72
  73         @throws com::sun::star::uno::Exception
  74             in case of other problems
  75      */
  76     void connectPersistance(
  77             [in] ::com::sun::star::io::XStream xStream )
  78         raises( ::com::sun::star::io::IOException,
  79                 ::com::sun::star::uno::Exception );
  80
  81 };
  82
  83 //=============================================================================
  84
  85 }; }; }; };
  86
  87 #endif
  88