INTEGRATION: CWS mav05 (1.1.2); FILE ADDED

2003/06/23 09:17:57 mav 1.1.2.1: #i15929# #110406# preliminary API for storages and embedded objects

1 files changed, 125 insertions, 0 deletions

diff --git a/offapi/com/sun/star/embed/XPersistanceHolder.idl b/offapi/com/sun/star/embed/XPersistanceHolder.idl
new file mode 100644
index 000000000000..4cb64033ae19
--- /dev/null
+++ b/offapi/com/sun/star/embed/XPersistanceHolder.idl
@@ -0,0 +1,125 @@
+/*************************************************************************
+ *
+ *  $RCSfile: XPersistanceHolder.idl,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: kz $ $Date: 2003-09-11 10:26:58 $
+ *
+ *  The Contents of this file are made available subject to the terms of
+ *  either of the following licenses
+ *
+ *         - GNU Lesser General Public License Version 2.1
+ *         - Sun Industry Standards Source License Version 1.1
+ *
+ *  Sun Microsystems Inc., October, 2000
+ *
+ *  GNU Lesser General Public License Version 2.1
+ *  =============================================
+ *  Copyright 2000 by Sun Microsystems, Inc.
+ *  901 San Antonio Road, Palo Alto, CA 94303, USA
+ *
+ *  This library is free software; you can redistribute it and/or
+ *  modify it under the terms of the GNU Lesser General Public
+ *  License version 2.1, as published by the Free Software Foundation.
+ *
+ *  This library 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 for more details.
+ *
+ *  You should have received a copy of the GNU Lesser General Public
+ *  License along with this library; if not, write to the Free Software
+ *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ *  MA  02111-1307  USA
+ *
+ *
+ *  Sun Industry Standards Source License Version 1.1
+ *  =================================================
+ *  The contents of this file are subject to the Sun Industry Standards
+ *  Source License Version 1.1 (the "License"); You may not use this file
+ *  except in compliance with the License. You may obtain a copy of the
+ *  License at http://www.openoffice.org/license.html.
+ *
+ *  Software provided under this License is provided on an "AS IS" basis,
+ *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
+ *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
+ *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
+ *  See the License for the specific provisions governing your rights and
+ *  obligations concerning the Software.
+ *
+ *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
+ *
+ *  Copyright: 2000 by Sun Microsystems, Inc.
+ *
+ *  All Rights Reserved.
+ *
+ *  Contributor(s): _______________________________________
+ *
+ *
+ ************************************************************************/
+#ifndef __com_sun_star_embed_XPersistanceHolder_idl__
+#define __com_sun_star_embed_XPersistanceHolder_idl__
+
+#ifndef __com_sun_star_uno_XInterface_idl__
+#include <com/sun/star/uno/XInterface.idl>
+#endif
+
+#ifndef __com_sun_star_io_IOException_idl__
+#include <com/sun/star/io/IOException.idl>
+#endif
+
+//=============================================================================
+
+ module com {  module sun {  module star {  module embed {
+
+//=============================================================================
+/** Allows to put an object in to "HandsOff" state.
+ */
+interface XPersistanceHolder: com::sun::star::uno::XInterface
+{
+    //-------------------------------------------------------------------------
+    /** Allows to put the object in to "HandsOff" state and back.
+
+        <p> In the "HandsOff" state the object should free all persistent resources.
+        So the persistent representation of the object is unusable.
+        </p>
+
+        <p>
+        The object should remember the location of the persistent representation to be able
+        to reconnect. For this purpose a storage in addition to XStorage interface must
+        support XPersistanceHolder itself. So the object will have to close all streams,
+        and put all storages to "HandsOff" states.
+        </p>
+
+        @param bHandsOff
+            <TRUE/>  - put the object in "HandsOff" state.
+            <FALSE/> - leave "HandsOff" state.
+
+        @throws com::sun::star::io::IOException
+            in case of io problems
+
+        @throws com::sun::star::uno::Exception
+            in case of other problems
+     */
+    void doHandsOff( [in] boolean bHandsOff )
+        raises( ::com::sun::star::io::IOException,
+                ::com::sun::star::uno::Exception );
+
+    //-------------------------------------------------------------------------
+    /** Allows to detect if the object is in "HandsOff" state.
+
+        @return
+            <TRUE/>  - the object in "HandsOff" state.
+            <FALSE/> - otherwise.
+     */
+    boolean isHandsOff();
+
+};
+
+//=============================================================================
+
+}; }; }; };
+
+#endif
+