src/client-api/src/include/common/spdm/DMTreeFactory.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 #ifndef INCL_DEVICE_MANAGER
  36 #define INCL_DEVICE_MANAGER
  37 /** @cond DEV */
  38
  39 #include "spdm/DMTree.h"
  40 #include "base/globalsdef.h"
  41
  42 BEGIN_NAMESPACE
  43
  44 /**
  45  * DeviceManager is an abstract class that must be implemented on a platform
  46  * specific basis. The current interface allows a client to retrieve a platform
  47  * specific DMTreeManager instance. Since this class has access to the
  48  * management properties repository, it is bound to the underlying system. In
  49  * this use case, the DeviceManager can be seen as a factory for DMTreeManager
  50  * objects. Note that the DMTreeManager instance returned is created with the
  51  * standard C++ new operator and must be deleted by the caller with the
  52  * standard C++ delete operator
  53 */
  54 class DMTreeFactory {
  55     public:
  56
  57         /*
  58          * Constructor
  59          */
  60         DMTreeFactory();
  61
  62         /*
  63          * Creates and returns the DMTreeManager that represents the management
  64          * tree under the root specified. In case of error, NULL is returned.
  65          *
  66          * The DMTreeManager is created with the 'new' C++ operator and must be
  67          * discarded by the caller with the operator 'delete'.
  68          */
  69         static DMTree* getDMTree(const char*  node);
  70 };
  71
  72
  73 END_NAMESPACE
  74
  75 /** @endcond */
  76 #endif