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