office-gobmx/autodoc/inc/ary/entity.hxx
2010-10-27 13:05:40 +01:00

84 lines
2 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef ARY_ENTITY_HXX
#define ARY_ENTITY_HXX
// BASE CLASSES
#include <ary/object.hxx>
namespace ary
{
/** Interface for every class, whose objects are searchable within the
Autodoc Repository by an id.
@todo
Possibly make ->Set_Id() less public accessible.
*/
class Entity : public Object
{
public:
virtual ~Entity() {}
Rid Id() const;
/// @attention Must be used only by ->ary::stg::Storage<>
void Set_Id(
Rid i_nId );
protected:
Entity() : nId(0) {}
private:
// DATA
Rid nId;
};
inline Rid
Entity::Id() const
{
return nId;
}
inline void
Entity::Set_Id(Rid i_nId)
{
nId = i_nId;
}
} // namespace ary
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */