autodoc/inc/ary/entity.hxx

   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: entity.hxx,v $
  10  * $Revision: 1.3 $
  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
  31 #ifndef ARY_ENTITY_HXX
  32 #define ARY_ENTITY_HXX
  33
  34 // BASE CLASSES
  35 #include <ary/object.hxx>
  36
  37
  38
  39
  40 namespace ary
  41 {
  42
  43
  44 /** Interface for every class, whose objects are searchable within the
  45     Autodoc Repository by an id.
  46
  47     @todo
  48     Possibly make ->Set_Id() less public accessible.
  49 */
  50 class Entity : public Object
  51 {
  52   public:
  53     virtual             ~Entity() {}
  54
  55     Rid                 Id() const;
  56
  57     /// @attention Must be used only by ->ary::stg::Storage<>
  58     void                Set_Id(
  59                             Rid                 i_nId );
  60   protected:
  61                         Entity()      : nId(0) {}
  62   private:
  63     // DATA
  64     Rid                 nId;
  65 };
  66
  67
  68 inline Rid
  69 Entity::Id() const
  70 {
  71     return nId;
  72 }
  73
  74 inline void
  75 Entity::Set_Id(Rid i_nId)
  76 {
  77     nId = i_nId;
  78 }
  79
  80
  81
  82
  83 }   // namespace ary
  84 #endif