src/DB/Savables/Channel.h

   1 /***************************************************************************
   2  *   Copyright (C) 2008 by Sverre Rabbelier                                *
   3  *   sverre@rabbelier.nl                                                   *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 3 of the License, or     *
   8  *   (at your option) any later version.                                   *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  19  ***************************************************************************/
  20 #pragma once
  21
  22 #include "SavableHeaders.h"
  23 #include "SavableTypes.h"
  24
  25 namespace mud
  26 {
  27         class ChannelManager;
  28
  29         class Channel : public Savable
  30         {
  31         public:
  32                 /*
  33                  * Getters
  34                  */
  35                 const std::string& getName() const;
  36                 const std::string& getDescription() const;
  37                 bool needLogin() const;
  38
  39                 /*
  40                  * Setters
  41                  */
  42                 void setName(const std::string& name);
  43                 void setDescription(const std::string& description);
  44                 void setNeedLogin(bool needLogin);
  45
  46                 /*
  47                  * Utilities
  48                  */
  49                 SavableManagerPtr getManager() const;
  50                 TableImplPtr getTable() const;
  51
  52                 /*
  53                  * Database operations
  54                  */
  55                 void Delete();
  56                 void Save();
  57                 void Discard();
  58                 bool Exists();
  59
  60         private:
  61                 friend class mud::ChannelManager; // For constructor
  62                 friend SmartPtrDelete(mud::Channel);
  63
  64                 SavableManagerPtr m_channel;
  65
  66                 /**
  67                  * Constructor
  68                  * @param channel The DB object
  69                  */
  70                 Channel(SavableManagerPtr channel);
  71
  72                 Channel(const Channel& rhs);
  73                 Channel operator=(const Channel& rhs);
  74
  75                 /** Destructor, unlocks the savable. */
  76                 ~Channel(void);
  77         };
  78 }