1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef _COM_SUN_STAR_XML_XIMPORTFILTER_IDL__
25#define _COM_SUN_STAR_XML_XIMPORTFILTER_IDL__
26
27#ifndef __com_sun_star_uno_RuntimeException_idl__
28#include <com/sun/star/uno/RuntimeException.idl>
29#endif
30
31#include <com/sun/star/uno/XInterface.idl>
32#include <com/sun/star/beans/PropertyValue.idl>
33#include <com/sun/star/xml/sax/XDocumentHandler.idl>
34#include <com/sun/star/lang/IllegalArgumentException.idl>
35
36//=============================================================================
37
38module com { module sun { module star { module xml {
39
40
41//=============================================================================
42
43/** interface to implement for an XML-based import filter.
44
45    @since OpenOffice 1.1.2
46 */
47published interface XImportFilter: com::sun::star::uno::XInterface
48{
49     /** performs the import.
50
51	 	<p>The source data (location indicated by <var>aSourceData</var>),
52			and the XML representation of the document must be generated by calls
53			to xocHandler (???) methods.
54
55      @param aSourceData
56          <type scope="com::sun::star::document">MediaDescriptor</type>
57          which defines the data source
58
59      @param msUserData
60          Sequence of strings which contains the userdata defined in the
61          TypeDetection.xml
62
63      @param xDocHandler
64          target for the XML document representation
65
66      @returns
67          <TRUE/> if import process is successful
68     */
69	boolean importer(
70			 [in] sequence< com::sun::star::beans::PropertyValue > aSourceData,
71			 [in] com::sun::star::xml::sax::XDocumentHandler xDocHandler,
72			 [in] sequence< string > msUserData )
73		raises( com::sun::star::lang::IllegalArgumentException );
74};
75
76}; }; }; };
77#endif
78