Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: document ::

unpublished interface XDocumentRecovery
Usage Restrictions
not published
Description
is the interface to be implemented by documents who wish to participate in the document emergency-save / recovery process.

Methods' Summary
wasModifiedSinceLastSave determines whether the document has been modified since the last call to storeToRecoveryFile.  
storeToRecoveryFile does an emergency save of the document  
recoverFromFile recovers the document after a previous emergency or session save.  
Methods' Details
wasModifiedSinceLastSave
boolean
wasModifiedSinceLastSave();

Description
determines whether the document has been modified since the last call to storeToRecoveryFile.

If storeToRecoveryFile has not been called before, this method returns whether the document has been modified since it has been loaded respectively created.

When saving a session, either in case of a emergency (when OpenOffice.org crashed), or during a periodic session save as configured by the user, storeToRecoveryFile is called for every document where wasModifiedSinceLastSave returns true.

It's allowed to implement this method sloppy, by returning true in cases where it is not sure whether the document actually has been modified. So, the most simple implementation could simply delegate this call to ::com::sun::star::util::XModifiable::isModified. (Well, actually that's the second simple implementation, the most simple one would, still egitimately, always return true.)

However, in such a case, the document might be saved more often than needed. In particular during the periodic session save, this might become a problem when saving is expensive, for a single document or the sum of all open documents.

storeToRecoveryFile
void
storeToRecoveryFile( [in] string  TargetLocation,
[in] sequence< ::com::sun::star::beans::PropertyValue >  MediaDescriptor )
raises( ::com::sun::star::io::IOException,
::com::sun::star::lang::WrappedTargetException );

Description
does an emergency save of the document

A default implementation of this method could simply delegate this call to ::com::sun::star::frame::XStorable::storeToURL.

Parameter TargetLocation
specifies the URL of the location to which the document should be emergency-saved.
Parameter MediaDescriptor
contains additional arguments for the save process, for instance an StatusIndicator.
See also
MediaDescriptor
recoverFromFile
void
recoverFromFile( [in] string  SourceLocation,
[in] string  SalvagedFile,
[in] sequence< ::com::sun::star::beans::PropertyValue >  MediaDescriptor )
raises( ::com::sun::star::io::IOException,
::com::sun::star::lang::WrappedTargetException );

Description
recovers the document after a previous emergency or session save.

The document itself has previously been created, but not loaded (via ::com::sun::star::frame::XLoadable::load) or initialized (via ::com::sun::star::frame::XLoadable::initNew).

Upon successful return, the document must be fully initialized. In particular, the caller is not responsible for calling ::com::sun::star::frame::XModel::attachResource. Instead, the implementation is responsible to do so, if required.

A default implementation of this method could simply delegate this call to ::com::sun::star::frame:::XLodable::load, followed by ::com::sun::star::frame::XModel::attachResource.

Parameter SourceLocation
specifies the URL of the location to which the document was previously emergency-saved.
Parameter SalvagedFile
specifies the original URL of the file which had been emergency-saved. If this is empty, then the file should be recovered from its original location.
Parameter MediaDescriptor
contains additional arguments for the load process, for instance an StatusIndicator.
See also
MediaDescriptor
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.