src/client-api/src/include/common/client/MailSourceManagementNode.h

   1 /*
   2  * Funambol is a mobile platform developed by Funambol, Inc.
   3  * Copyright (C) 2003 - 2007 Funambol, Inc.
   4  *
   5  * This program is free software; you can redistribute it and/or modify it under
   6  * the terms of the GNU Affero General Public License version 3 as published by
   7  * the Free Software Foundation with the addition of the following permission
   8  * added to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED
   9  * WORK IN WHICH THE COPYRIGHT IS OWNED BY FUNAMBOL, FUNAMBOL DISCLAIMS THE
  10  * WARRANTY OF NON INFRINGEMENT  OF THIRD PARTY RIGHTS.
  11  *
  12  * This program is distributed in the hope that it will be useful, but WITHOUT
  13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  14  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  15  * details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program; if not, see http://www.gnu.org/licenses or write to
  19  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
  20  * MA 02110-1301 USA.
  21  *
  22  * You can contact Funambol, Inc. headquarters at 643 Bair Island Road, Suite
  23  * 305, Redwood City, CA 94063, USA, or at email address info@funambol.com.
  24  *
  25  * The interactive user interfaces in modified source and object code versions
  26  * of this program must display Appropriate Legal Notices, as required under
  27  * Section 5 of the GNU Affero General Public License version 3.
  28  *
  29  * In accordance with Section 7(b) of the GNU Affero General Public License
  30  * version 3, these Appropriate Legal Notices must retain the display of the
  31  * "Powered by Funambol" logo. If the display of the logo is not reasonably
  32  * feasible for technical reasons, the Appropriate Legal Notices must display
  33  * the words "Powered by Funambol".
  34  */
  35
  36 #ifndef INCL_MAIL_SOURCE_MANAGEMENT_NODE
  37 #define INCL_MAIL_SOURCE_MANAGEMENT_NODE
  38 /** @cond DEV */
  39
  40 #include "spdm/constants.h"
  41 #include "spdm/DeviceManagementNode.h"
  42 #include "spds/MailSyncSourceConfig.h"
  43 #include "base/globalsdef.h"
  44
  45 BEGIN_NAMESPACE
  46
  47
  48 class MailSourceManagementNode : public DeviceManagementNode {
  49
  50     public:
  51         // ------------------------------------------ Constructors & destructors
  52
  53         MailSourceManagementNode( const char*     context,
  54                                   const char*     name   );
  55
  56         MailSourceManagementNode( const char*     context,
  57                                   const char*     name   ,
  58                                   MailSyncSourceConfig& config );
  59
  60         ~MailSourceManagementNode();
  61
  62         // ------------------------------------------------------------- Methods
  63
  64         /**
  65          * Returns the mail configuration object from the cached value (if
  66          * refresh is false) or reading it from the DMT store (if refresh is
  67          * true);
  68          *
  69          * @param refresh should the node be read from the DMT ?
  70          */
  71         MailSyncSourceConfig& getMailSourceConfig(bool refresh);
  72
  73         /**
  74          * Sets the given mail source configuration object to the internal
  75          * cache and into the DMT.
  76          *
  77          * @param c the configuration object to store
  78          */
  79         void setMailSourceConfig(MailSyncSourceConfig& c);
  80
  81         ArrayElement* clone();
  82
  83         // -------------------------------------------------------- Data members
  84     private:
  85         MailSyncSourceConfig config;
  86 };
  87
  88
  89 END_NAMESPACE
  90
  91 /** @endcond */
  92 #endif