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  /***
26   * Optional abstract base class for business objects. Implementations of
27   * business classes that inherit from this base class have access to internal
28   * properties of the view column from which they where created. <p>If digest
29   * classes that don't inherit from this base class need access to such
30   * properties (e.g. the UniversalId of the document), they can also do this in
31   * the concrete mapper, but it is recommended to use this base class.</p>
32   *
33   * @author <a href="mailto:kriede@users.sourceforge.net">Kurt Riede</a>
34   */
35  public abstract class BaseInstance {
36  
37      /*** The universalId of the notes document. */
38      private String universalId;
39  
40      /***
41       * Constructor.
42       */
43      public BaseInstance() {
44      }
45  
46      /***
47       * Constructor.
48       *
49       * @param instance another instance for copying data from.
50       */
51      public BaseInstance(final BaseInstance instance) {
52          // Don't copy unid!
53      }
54  
55      /***
56       * @return Returns the unid.
57       */
58      public final String getUnid() {
59          return universalId;
60      }
61  
62      /***
63       * @param unid The unid to set.
64       */
65      public final void setUnid(final String unid) {
66          this.universalId = unid;
67      }
68  }