src/include/common/spdm/ParentManagementNode.h

00001 /*
00002  * Funambol is a mobile platform developed by Funambol, Inc. 
00003  * Copyright (C) 2003 - 2007 Funambol, Inc.
00004  * 
00005  * This program is free software; you can redistribute it and/or modify it under
00006  * the terms of the GNU Affero General Public License version 3 as published by
00007  * the Free Software Foundation with the addition of the following permission 
00008  * added to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED
00009  * WORK IN WHICH THE COPYRIGHT IS OWNED BY FUNAMBOL, FUNAMBOL DISCLAIMS THE 
00010  * WARRANTY OF NON INFRINGEMENT  OF THIRD PARTY RIGHTS.
00011  * 
00012  * This program is distributed in the hope that it will be useful, but WITHOUT
00013  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
00014  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
00015  * details.
00016  * 
00017  * You should have received a copy of the GNU Affero General Public License 
00018  * along with this program; if not, see http://www.gnu.org/licenses or write to
00019  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
00020  * MA 02110-1301 USA.
00021  * 
00022  * You can contact Funambol, Inc. headquarters at 643 Bair Island Road, Suite 
00023  * 305, Redwood City, CA 94063, USA, or at email address info@funambol.com.
00024  * 
00025  * The interactive user interfaces in modified source and object code versions
00026  * of this program must display Appropriate Legal Notices, as required under
00027  * Section 5 of the GNU Affero General Public License version 3.
00028  * 
00029  * In accordance with Section 7(b) of the GNU Affero General Public License
00030  * version 3, these Appropriate Legal Notices must retain the display of the
00031  * "Powered by Funambol" logo. If the display of the logo is not reasonably 
00032  * feasible for technical reasons, the Appropriate Legal Notices must display
00033  * the words "Powered by Funambol".
00034  */
00035 
00036 
00037 
00038 #ifndef INCL_PARENT_MANAGEMENT_NODE
00039     #define INCL_PARENT_MANAGEMENT_NODE
00040 
00042     #include "base/fscapi.h"
00043     #include "base/util/ArrayList.h"
00044     #include "spdm/constants.h"
00045     #include "spdm/ManagementNode.h"
00046 
00047     /*
00048      * This class represents a management node with children. It gives a way to
00049      * handle children nodes. It currently ignores node's properties.
00050      *
00051      * See the design documents for more information.
00052      */
00053     class __declspec(dllexport) ParentManagementNode : public ManagementNode {
00054 
00055     protected:
00056         //
00057         // Children are dinamically allocated inside this class and given to
00058         // the list. The list will delete all created objects at descruction
00059         // time.
00060         //
00061         ArrayList children;
00062 
00063     public:
00064         /*
00065          * Constructor.
00066          *
00067          * @param parent - a ManagementNode is usually under the context of a
00068          *                 parent node.
00069          * @param name - the node name
00070          *
00071          */
00072         ParentManagementNode(char*  context, char*  name);
00073         ~ParentManagementNode();
00074 
00075 
00076         // ----------------------------------------------------- Virtual methods
00077 
00078         /*
00079          * It always returns an empty string
00080          *
00081          * @param property - the property name
00082          * @param buf - the buffer for the value
00083          * @param len - the buffer size
00084          */
00085         void getPropertyValue(const char*  property, const char* buf, int size);
00086 
00087 
00088         /*
00089          * It simply ignores the new value
00090          *
00091          * @param property - the property name
00092          * @param value - the property value (zero terminated string)
00093          */
00094         void setPropertyValue(const char*  property, const char* value);
00095 
00096         /*
00097          * Returns this node's children.
00098          *
00099          * The ManagementNode objects are created with the new operator and
00100          * must be discarded by the caller with the operator delete.
00101          *
00102          * @param children - the buffer where ManagementNode* must be stored
00103          * @param size - the size of the children buffer (number of ManagementNode*) in
00104          *               input; the number of children in output
00105          *
00106          */
00107         void getChildren(ManagementNode** children, int* size);
00108 
00109         ManagementNode* get(int i);
00110 
00111         /*
00112          * Returns how many children belong to this node.
00113          *
00114          */
00115         int getChildrenCount();
00116 
00117         /*
00118          * Adds a new child.
00119          *
00120          * @parent node the new node
00121          */
00122         void addChild(ManagementNode& node);
00123 
00124         /*
00125          * Creates a new ManagementNode with the exact content of this object.
00126          * The new instance MUST be created with the C++ new opertator.
00127          */
00128         ArrayElement* clone();
00129 
00135         ManagementNode* operator[] (int i);
00136 
00137 
00138         // -------------------------------------------------------- Private data
00139     };
00140 
00142 #endif

Generated on Thu Mar 6 14:25:04 2008 for Funambol C++ Client Library by  doxygen 1.5.2