1 /************************************************************************* 2 * 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * Copyright 2000, 2010 Oracle and/or its affiliates. 6 * 7 * OpenOffice.org - a multi-platform office productivity suite 8 * 9 * This file is part of OpenOffice.org. 10 * 11 * OpenOffice.org is free software: you can redistribute it and/or modify 12 * it under the terms of the GNU Lesser General Public License version 3 13 * only, as published by the Free Software Foundation. 14 * 15 * OpenOffice.org is distributed in the hope that it will be useful, 16 * but WITHOUT ANY WARRANTY; without even the implied warranty of 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 * GNU Lesser General Public License version 3 for more details 19 * (a copy is included in the LICENSE file that accompanied this code). 20 * 21 * You should have received a copy of the GNU Lesser General Public License 22 * version 3 along with OpenOffice.org. If not, see 23 * <http://www.openoffice.org/license.html> 24 * for a copy of the LGPLv3 License. 25 * 26 ************************************************************************/ 27 28 #ifndef ARY_ENTITY_HXX 29 #define ARY_ENTITY_HXX 30 31 // BASE CLASSES 32 #include <ary/object.hxx> 33 34 35 36 37 namespace ary 38 { 39 40 41 /** Interface for every class, whose objects are searchable within the 42 Autodoc Repository by an id. 43 44 @todo 45 Possibly make ->Set_Id() less public accessible. 46 */ 47 class Entity : public Object 48 { 49 public: 50 virtual ~Entity() {} 51 52 Rid Id() const; 53 54 /// @attention Must be used only by ->ary::stg::Storage<> 55 void Set_Id( 56 Rid i_nId ); 57 protected: 58 Entity() : nId(0) {} 59 private: 60 // DATA 61 Rid nId; 62 }; 63 64 65 inline Rid 66 Entity::Id() const 67 { 68 return nId; 69 } 70 71 inline void 72 Entity::Set_Id(Rid i_nId) 73 { 74 nId = i_nId; 75 } 76 77 78 79 80 } // namespace ary 81 #endif 82