offapi/com/sun/star/document/XDocumentRevisionListPersistence.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: XDocumentRevisionListPersistence.idl,v $
  10  * $Revision: 1.4 $
  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_document_XDocumentRevisionListPersistence_idl__
  31 #define __com_sun_star_document_XDocumentRevisionListPersistence_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_embed_XStorage_idl__
  38 #include <com/sun/star/embed/XStorage.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_util_RevisionTag_idl__
  42 #include <com/sun/star/util/RevisionTag.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_io_IOException_idl__
  46 #include <com/sun/star/io/IOException.idl>
  47 #endif
  48
  49 #ifndef __com_sun_star_container_NoSuchElementException_idl__
  50 #include <com/sun/star/io/NoSuchElementException.idl>
  51 #endif
  52
  53 #ifndef __com_sun_star_uno_Exception_idl__
  54 #include <com/sun/star/uno/Exception.idl>
  55 #endif
  56
  57 //=============================================================================
  58
  59 module com {  module sun {  module star {  module document {
  60
  61 //=============================================================================
  62 /** interface to load or store a list of document revisions from or to a document
  63     using the packed XML file format
  64  */
  65 interface XDocumentRevisionListPersistence: com::sun::star::uno::XInterface
  66 {
  67     //-------------------------------------------------------------------------
  68      /** Loads a list of available revisions from a storage
  69         <p>
  70         This method does not load any revision itself
  71         </p>
  72      */
  73     sequence < ::com::sun::star::util::RevisionTag > load( [in] ::com::sun::star::embed::XStorage Storage)
  74         raises( com::sun::star::container::NoSuchElementException,
  75                 com::sun::star::io::IOException,
  76                 com::sun::star::uno::Exception );
  77
  78     //-------------------------------------------------------------------------
  79      /** Stores a list of available revisions to a storage
  80         <p>
  81         This method does not store revisions themselves
  82         </p>
  83      */
  84     void store( [in] ::com::sun::star::embed::XStorage Storage, [in] sequence < ::com::sun::star::util::RevisionTag > List )
  85         raises( com::sun::star::io::IOException,
  86                 com::sun::star::uno::Exception );
  87 };
  88
  89 //=============================================================================
  90
  91 }; }; }; };
  92
  93 #endif