View Javadoc

1   /*
2    * This file is part of Domingo
3    * an Open Source Java-API to Lotus Notes/Domino
4    * hosted at http://domingo.sourceforge.net
5    *
6    * Copyright (c) 2003-2007 Beck et al. projects GmbH Munich, Germany (http://www.bea.de)
7    *
8    * This library is free software; you can redistribute it and/or
9    * modify it under the terms of the GNU Lesser General Public
10   * License as published by the Free Software Foundation; either
11   * version 2.1 of the License, or (at your option) any later version.
12   *
13   * This library is distributed in the hope that it will be useful,
14   * but WITHOUT ANY WARRANTY; without even the implied warranty of
15   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16   * Lesser General Public License for more details.
17   *
18   * You should have received a copy of the GNU Lesser General Public
19   * License along with this library; if not, write to the Free Software
20   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21   */
22  
23  package de.bea.domingo;
24  
25  /***
26   * Represents a Notes database.
27   *
28   * @author <a href=mailto:kriede@users.sourceforge.net>Kurt Riede</a>
29   */
30  public interface DDxlExporter extends DBase {
31  
32      /***
33       * Converts Domino data to DXL data.
34       *
35       * @param database The Domino data to be converted, in this case the entire database.
36       * @return The exported DXL.
37       * @throws DNotesException if the Domino data cannot be exported
38       */
39      String exportDxl(DDatabase database) throws DNotesException;
40  
41      /***
42       * Converts Domino data to DXL data.
43       *
44       * @param document The Domino data to be converted, in this case one document.
45       * @return The exported DXL.
46       * @throws DNotesException if the Domino data cannot be exported
47       */
48      String exportDxl(DDocument document) throws DNotesException;
49  
50      /***
51       * Converts Domino data to DXL data.
52       *
53       * @param documentCollection document The Domino data to be converted, in this case the documents in a document collection.
54       * @return The exported DXL.
55       * @throws DNotesException if the Domino data cannot be exported
56       */
57      String exportDxl(DDocumentCollection documentCollection) throws DNotesException;
58  
59      /***
60       * Indicates whether a !DOCTYPE statement is exported or not.
61       *
62       * @return <code>true</code> (default) to export a !DOCTYPE statement
63       */
64      boolean getOutputDOCTYPE();
65  
66      /***
67       * Indicates whether a !DOCTYPE statement is exported or not.
68       *
69       * @param flag <code>true</code> (default) to export a !DOCTYPE statement
70       */
71      void setOutputDoctype(boolean flag);
72  
73      /***
74       * The value of SYSTEM in the exported !DOCTYPE statement.
75       *
76       * @return system doctype
77       */
78      String getDoctypeSYSTEM();
79  
80      /***
81       * The value of SYSTEM in the exported !DOCTYPE statement.
82       *
83       * @param systemId system doctype
84       */
85      void setDoctypeSYSTEM(String systemId);
86  
87      /***
88       * @param flag <code>true</code> to convert bit maps <code>false</code>
89       *         (default) to leave bit maps in Notes format
90       */
91      void setConvertNotesBitmapsToGIF(final boolean flag);
92  
93      /***
94       * Indicates whether bit maps pasted in rich text items should be converted
95       * to GIF format.
96       *
97       * @return <code>true</code> to convert bit maps <code>false</code>
98       *         (default) to leave bit maps in Notes format
99       */
100      boolean getConvertNotesBitmapsToGIF();
101 }