offapi/com/sun/star/document/XOOXMLDocumentPropertiesImporter.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: XOOXMLDocumentPropertiesImporter.idl,v $
  10  * $Revision: 1.2 $
  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_XOOXMLDocumentPropertiesImporter_idl__
  31 #define __com_sun_star_document_XOOXMLDocumentPropertiesImporter_idl__
  32
  33 #ifndef __com_sun_star_document_XDocumentProperties_idl__
  34 #include <com/sun/star/document/XDocumentProperties.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_xml_sax_SAXException_idl__
  42 #include <com/sun/star/xml/sax/SAXException.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  46 #include <com/sun/star/lang/IllegalArgumentException.idl>
  47 #endif
  48
  49 #ifndef __com_sun_star_uno_Exception_idl__
  50 #include <com/sun/star/uno/Exception.idl>
  51 #endif
  52
  53 //=============================================================================
  54
  55 module com { module sun { module star { module document {
  56
  57 //=============================================================================
  58 /** allows to import the document properties from OOXML fomat
  59  */
  60 interface XOOXMLDocumentPropertiesImporter: com::sun::star::uno::XInterface
  61 {
  62     // -----------------------------------------------------------------------
  63     /** allows to import the document properties from OOXML format
  64
  65         <p>
  66         The implementation should parse the document properties from OOXML
  67         format storage and set them to the target
  68         <type>XDocumentProperties</type> implementation.
  69         </p>
  70
  71         <p>
  72         The storage must represent OOXML format and support
  73         <type scope="com::sun::star::embed">XRelationshipAccess</type>
  74         interface. Please see
  75         <type scope="com::sun::star::embed">StorageFactory</type> for details
  76         regarding creation of such a storage.
  77         </p>
  78
  79         @param xSource
  80             the source storage representing OOXML document
  81
  82         @param xDocumentProperties
  83             the target <type>XDocumentProperties</type> interface implementation
  84
  85         @throws ::com::sun::star::lang::IllegalArgumentException
  86             the exception is thrown in case unexpected arguments are provided
  87
  88         @throws ::com::sun::star::xml::sax::SAXException
  89             the exception is thrown in case of parsing problems
  90
  91         @throws ::com::sun::star::uno::Exception
  92             the exception is thrown in case of other problems during the import
  93      */
  94
  95     void importProperties(
  96         [in] com::sun::star::embed::XStorage xSource,
  97         [in] com::sun::star::document::XDocumentProperties xDocumentProperties )
  98             raises( com::sun::star::lang::IllegalArgumentException,
  99                     com::sun::star::xml::sax::SAXException,
 100                     com::sun::star::uno::Exception );
 101 };
 102
 103 //=============================================================================
 104
 105 }; }; }; };
 106
 107 #endif
 108