1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski#ifndef __offapcom_sun_star_document_XDocumentRecovery_idl__ 25*b1cdbd2cSJim Jagielski#define __offapcom_sun_star_document_XDocumentRecovery_idl__ 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski#include <com/sun/star/beans/PropertyValue.idl> 28*b1cdbd2cSJim Jagielski#include <com/sun/star/io/IOException.idl> 29*b1cdbd2cSJim Jagielski#include <com/sun/star/lang/WrappedTargetException.idl> 30*b1cdbd2cSJim Jagielski 31*b1cdbd2cSJim Jagielski//============================================================================= 32*b1cdbd2cSJim Jagielski 33*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module document { 34*b1cdbd2cSJim Jagielski 35*b1cdbd2cSJim Jagielski//============================================================================= 36*b1cdbd2cSJim Jagielski 37*b1cdbd2cSJim Jagielski/** is the interface to be implemented by documents who wish to participate in 38*b1cdbd2cSJim Jagielski the document emergency-save / recovery process. 39*b1cdbd2cSJim Jagielski */ 40*b1cdbd2cSJim Jagielskiinterface XDocumentRecovery 41*b1cdbd2cSJim Jagielski{ 42*b1cdbd2cSJim Jagielski /** determines whether the document has been modified since the last call to <member>storeToRecoveryFile</member>. 43*b1cdbd2cSJim Jagielski 44*b1cdbd2cSJim Jagielski <p>If <code>storeToRecoveryFile</code> has not been called before, this method returns whether the document 45*b1cdbd2cSJim Jagielski has been modified since it has been loaded respectively created.</p> 46*b1cdbd2cSJim Jagielski 47*b1cdbd2cSJim Jagielski <p>When saving a session, either in case of a emergency (when OpenOffice.org crashed), or during a 48*b1cdbd2cSJim Jagielski periodic session save as configured by the user, <member>storeToRecoveryFile</member> is called for every 49*b1cdbd2cSJim Jagielski document where <code>wasModifiedSinceLastSave</code> returns <TRUE/>.</p> 50*b1cdbd2cSJim Jagielski 51*b1cdbd2cSJim Jagielski <p>It's allowed to implement this method sloppy, by returning <TRUE/> in cases where it is not sure whether 52*b1cdbd2cSJim Jagielski the document actually has been modified. So, the most simple implementation could simply delegate this call 53*b1cdbd2cSJim Jagielski to <member scope="com::sun::star::util">XModifiable::isModified</member>. (Well, actually that's the 54*b1cdbd2cSJim Jagielski second simple implementation, the <em>most</em> simple one would, still egitimately, always return <TRUE/>.)</p> 55*b1cdbd2cSJim Jagielski 56*b1cdbd2cSJim Jagielski <p>However, in such a case, the document might be saved more often than needed. In particular during the 57*b1cdbd2cSJim Jagielski periodic session save, this might become a problem when saving is expensive, for a single document 58*b1cdbd2cSJim Jagielski or the sum of all open documents.</p> 59*b1cdbd2cSJim Jagielski */ 60*b1cdbd2cSJim Jagielski boolean wasModifiedSinceLastSave(); 61*b1cdbd2cSJim Jagielski 62*b1cdbd2cSJim Jagielski /** does an emergency save of the document 63*b1cdbd2cSJim Jagielski 64*b1cdbd2cSJim Jagielski <p>A default implementation of this method could simply delegate this call to 65*b1cdbd2cSJim Jagielski <member scope="com::sun::star::frame">XStorable::storeToURL</member>.</p> 66*b1cdbd2cSJim Jagielski 67*b1cdbd2cSJim Jagielski @param TargetLocation 68*b1cdbd2cSJim Jagielski specifies the URL of the location to which the document should be emergency-saved. 69*b1cdbd2cSJim Jagielski 70*b1cdbd2cSJim Jagielski @param MediaDescriptor 71*b1cdbd2cSJim Jagielski contains additional arguments for the save process, for instance an StatusIndicator. 72*b1cdbd2cSJim Jagielski 73*b1cdbd2cSJim Jagielski @see MediaDescriptor 74*b1cdbd2cSJim Jagielski */ 75*b1cdbd2cSJim Jagielski void storeToRecoveryFile( 76*b1cdbd2cSJim Jagielski [in] string TargetLocation, 77*b1cdbd2cSJim Jagielski [in] sequence< ::com::sun::star::beans::PropertyValue > MediaDescriptor 78*b1cdbd2cSJim Jagielski ) 79*b1cdbd2cSJim Jagielski raises ( ::com::sun::star::io::IOException, 80*b1cdbd2cSJim Jagielski ::com::sun::star::lang::WrappedTargetException 81*b1cdbd2cSJim Jagielski ); 82*b1cdbd2cSJim Jagielski 83*b1cdbd2cSJim Jagielski /** recovers the document after a previous emergency or session save. 84*b1cdbd2cSJim Jagielski 85*b1cdbd2cSJim Jagielski <p>The document itself has previously been created, but <em>not</em> loaded 86*b1cdbd2cSJim Jagielski (via <member scope="com::sun::star::frame">XLoadable::load</member>) or initialized (via 87*b1cdbd2cSJim Jagielski <member scope="com::sun::star::frame">XLoadable::initNew</member>).</p> 88*b1cdbd2cSJim Jagielski 89*b1cdbd2cSJim Jagielski <p>Upon successful return, the document must be fully initialized. In particular, the 90*b1cdbd2cSJim Jagielski caller is not responsible for calling <member scope="com::sun::star::frame">XModel::attachResource</member>. 91*b1cdbd2cSJim Jagielski Instead, the implementation is responsible to do so, if required.</p> 92*b1cdbd2cSJim Jagielski 93*b1cdbd2cSJim Jagielski <p>A default implementation of this method could simply delegate this call to 94*b1cdbd2cSJim Jagielski <member scope="::com::sun::star::frame:">XLodable::load</member>, followed by 95*b1cdbd2cSJim Jagielski <member scope="com::sun::star::frame">XModel::attachResource</member>.</p> 96*b1cdbd2cSJim Jagielski 97*b1cdbd2cSJim Jagielski @param SourceLocation 98*b1cdbd2cSJim Jagielski specifies the URL of the location to which the document was previously emergency-saved. 99*b1cdbd2cSJim Jagielski 100*b1cdbd2cSJim Jagielski @param SalvagedFile 101*b1cdbd2cSJim Jagielski specifies the original URL of the file which had been emergency-saved. If this is empty, 102*b1cdbd2cSJim Jagielski then the file should be recovered from its original location. 103*b1cdbd2cSJim Jagielski 104*b1cdbd2cSJim Jagielski @param MediaDescriptor 105*b1cdbd2cSJim Jagielski contains additional arguments for the load process, for instance an StatusIndicator. 106*b1cdbd2cSJim Jagielski 107*b1cdbd2cSJim Jagielski @see MediaDescriptor 108*b1cdbd2cSJim Jagielski */ 109*b1cdbd2cSJim Jagielski void recoverFromFile( 110*b1cdbd2cSJim Jagielski [in] string SourceLocation, 111*b1cdbd2cSJim Jagielski [in] string SalvagedFile, 112*b1cdbd2cSJim Jagielski [in] sequence< ::com::sun::star::beans::PropertyValue > MediaDescriptor 113*b1cdbd2cSJim Jagielski ) 114*b1cdbd2cSJim Jagielski raises ( ::com::sun::star::io::IOException, 115*b1cdbd2cSJim Jagielski ::com::sun::star::lang::WrappedTargetException 116*b1cdbd2cSJim Jagielski ); 117*b1cdbd2cSJim Jagielski}; 118*b1cdbd2cSJim Jagielski 119*b1cdbd2cSJim Jagielski//============================================================================= 120*b1cdbd2cSJim Jagielski 121*b1cdbd2cSJim Jagielski}; }; }; }; 122*b1cdbd2cSJim Jagielski 123*b1cdbd2cSJim Jagielski//============================================================================= 124*b1cdbd2cSJim Jagielski 125*b1cdbd2cSJim Jagielski#endif 126