src/r_saved_message.h

   1 ///
   2 /// \file       r_saved_message.h
   3 ///             Blackberry database record parser class for saved email
   4 ///             message records.
   5 ///
   6
   7 /*
   8     Copyright (C) 2005-2012, Net Direct Inc. (http://www.netdirect.ca/)
   9     Copyright (C) 2007, Brian Edginton (edge@edginton.net)
  10
  11     This program is free software; you can redistribute it and/or modify
  12     it under the terms of the GNU General Public License as published by
  13     the Free Software Foundation; either version 2 of the License, or
  14     (at your option) any later version.
  15
  16     This program is distributed in the hope that it will be useful,
  17     but WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  19
  20     See the GNU General Public License in the COPYING file at the
  21     root directory of this project for more details.
  22 */
  23
  24 #ifndef __BARRY_RECORD_SAVED_MESSAGE_H__
  25 #define __BARRY_RECORD_SAVED_MESSAGE_H__
  26
  27 #include "dll.h"
  28 #include "r_message_base.h"
  29
  30 namespace Barry {
  31
  32 //
  33 // NOTE:  All classes here must be container-safe!  Perhaps add sorting
  34 //        operators in the future.
  35 //
  36
  37 /// \addtogroup RecordParserClasses
  38 /// @{
  39
  40 class BXEXPORT SavedMessage : public MessageBase
  41 {
  42 public:
  43         SavedMessage()
  44         {
  45                 Clear();
  46         }
  47
  48         void Clear()
  49         {
  50                 MessageBase::Clear();
  51
  52                 RecType = GetDefaultRecType();
  53                 RecordId = 0;
  54         }
  55
  56         // database name
  57         static const char * GetDBName() { return "Saved Email Messages"; }
  58         static uint8_t GetDefaultRecType() { return 3; }
  59
  60         // Generic Field Handle support
  61         static const std::vector<FieldHandle<SavedMessage> >& GetFieldHandles();
  62 };
  63
  64 BXEXPORT inline std::ostream& operator<<(std::ostream &os, const SavedMessage &msg) {
  65         msg.Dump(os);
  66         return os;
  67 }
  68
  69 /// @}
  70
  71 } // namespace Barry
  72
  73 #endif // __BARRY_RECORD_SAVED_MESSAGE_H__
  74
  75