src/include/common/syncml/core/PropParam.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 #ifndef INCL_PROPPARAM
00036 #define INCL_PROPPARAM
00037 
00039 #include "base/fscapi.h"
00040 #include "base/util/ArrayList.h"
00041 #include "base/globalsdef.h"
00042 
00043 BEGIN_NAMESPACE
00044 
00045 class PropParam : public ArrayElement {
00046 
00047     // ------------------------------------------------------- Private interface
00048 private:
00049 
00050     char*  paramName;
00051     char*  dataType;
00052     ArrayList* valEnums;
00053     char*  displayName;
00054 
00055 
00056 
00057     // ----------------------------------------------------- Protected interface
00058 protected:
00059 
00060 
00061 
00062 
00063     // -------------------------------------------------------- Public interface
00064 public:
00065 
00066 
00067     /*
00068      * PropParam constructor
00069      *
00070      */
00071     PropParam();
00072 
00073     ~PropParam();
00074 
00075 
00076     /*
00077      * PropParam constructor
00078      *
00079      * @param p0 prop name
00080      * @param p1 data type
00081      * @param p2 values enum
00082      * @param p3 display name
00083      */
00084     PropParam(char*  p0, char*  p1, ArrayList* p2, char*  p3);
00085 
00086 
00087 
00088     /*
00089      * getDisplayName
00090      *
00091      */
00092     const char* getDisplayName();
00093 
00094 
00095     /*
00096      * getParamName
00097      *
00098      */
00099     const char* getParamName();
00100 
00101 
00102     /*
00103      * setParamName
00104      *
00105      * @param p0
00106      */
00107     void setParamName(const char* p0);
00108 
00109 
00110     /*
00111      * getDataType
00112      *
00113      */
00114     const char* getDataType();
00115 
00116 
00117     /*
00118      * setDataType
00119      *
00120      * @param p0
00121      */
00122     void setDataType(const char* p0);
00123 
00124 
00125     /*
00126      * getValEnums
00127      *
00128      */
00129     ArrayList* getValEnums();
00130 
00131 
00132     /*
00133      * setValEnums
00134      *
00135      * @param p0
00136      */
00137     void setValEnums(ArrayList* p0);
00138 
00139 
00140     /*
00141      * setDisplayName
00142      *
00143      * @param p0
00144      */
00145     void setDisplayName(const char* p0);
00146 
00147     /*
00148      * Creates a clone of this instance
00149      *
00150      * @return the newly created instance
00151      */
00152     ArrayElement* clone();
00153 
00154 
00155 };
00156 
00157 
00158 
00159 END_NAMESPACE
00160 
00162 #endif

Generated on Tue Jun 10 17:20:22 2008 for Funambol C++ Client Library by  doxygen 1.5.2