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.map;
24  
25  import de.bea.domingo.DDocument;
26  
27  /***
28   * Mapper interface for mappers between business objects and Notes documents.
29   *
30   * @author <a href="mailto:kriede@users.sourceforge.net">Kurt Riede</a>
31   */
32  public interface Mapper {
33  
34      /***
35       * Maps a domingo document to a business object.
36       *
37       * @param document the domingo document to map
38       * @param object the business object
39       * @throws MappingException if an error occurred during mapping
40       */
41      void map(DDocument document, Object object) throws MappingException;
42  
43      /***
44       * Maps a business object to a domingo document.
45       *
46       * @param object the business object
47       * @param document the domingo document to map to
48       * @throws MappingException if an error occurred during mapping
49       */
50      void map(Object object, DDocument document) throws MappingException;
51  }