src/include/common/syncml/core/Property.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_PROPERTY
00036 #define INCL_PROPERTY
00037 
00039 #include "base/fscapi.h"
00040 #include "base/util/ArrayList.h"
00041 #include "base/globalsdef.h"
00042 
00043 BEGIN_NAMESPACE
00044 
00045 class Property : public ArrayElement {
00046 
00047     // ------------------------------------------------------- Private interface
00048 private:
00049 
00050     char*  propName;
00051     char*  dataType;
00052     long maxOccur;
00053     long maxSize;
00054     bool noTruncate;
00055     ArrayList* valEnums;
00056     char*  displayName;
00057     ArrayList* propParams;
00058 
00059 
00060 
00061     // ----------------------------------------------------- Protected interface
00062 protected:
00063 
00064 
00065 
00066 
00067     // -------------------------------------------------------- Public interface
00068 public:
00069 
00070     /*
00071      * Property constructor
00072      */
00073     Property();
00074 
00075     ~Property();
00076 
00077     /*
00078      * Property constructor
00079      *
00080      * @param propName
00081      * @param dataType
00082      * @param maxOccur
00083      * @param maxSize
00084      * @param noTruncate
00085      * @param valEnums
00086      * @param displayName
00087      * @param propParams
00088      */
00089     Property(char*  propName, char*  dataType, long maxOccur, 
00090         long maxSize, bool noTruncate, ArrayList* valEnums, 
00091         char*  displayName, ArrayList* propParams);
00092 
00093 
00094     /*
00095      * getDisplayName
00096      *
00097      */
00098     const char* getDisplayName();
00099 
00100     /*
00101      * getPropName
00102      *
00103      */
00104     const char* getPropName();
00105 
00106 
00107     /*
00108      * setPropName
00109      *
00110      * @param p0
00111      */
00112     void setPropName(const char* propName);
00113 
00114 
00115     /*
00116      * getDataType
00117      *
00118      */
00119     const char* getDataType();
00120 
00121 
00122     /*
00123      * setDataType
00124      *
00125      * @param p0
00126      */
00127     void setDataType(const char* p0);
00128 
00129 
00130     /*
00131      * getMaxOccur
00132      *
00133      */
00134     long getMaxOccur();
00135 
00136 
00137     /*
00138      * setMaxOccur
00139      *
00140      * @param p0
00141      */
00142     void setMaxOccur(long p0);
00143 
00144 
00145     /*
00146      * getMaxSize
00147      *
00148      */
00149     long getMaxSize();
00150 
00151 
00152     /*
00153      * setMaxSize
00154      *
00155      * @param p0
00156      */
00157     void setMaxSize(long p0);
00158 
00159 
00160     /*
00161      * setNoTruncate
00162      *
00163      * @param p0
00164      */
00165     void setNoTruncate(bool p0);
00166 
00167 
00168     /*
00169      * isNoTruncate
00170      *
00171      */
00172     bool isNoTruncate();
00173 
00174 
00175     /*
00176      * getNoTruncate
00177      *
00178      */
00179     bool getNoTruncate();
00180 
00181 
00182     /*
00183      * getValEnums
00184      *
00185      */
00186     ArrayList* getValEnums();
00187 
00188 
00189     /*
00190      * setValEnums
00191      *
00192      * @param p0
00193      */
00194     void setValEnums(ArrayList* p0);
00195 
00196 
00197     /*
00198      * setDisplayName
00199      *
00200      * @param p0
00201      */
00202     void setDisplayName(const char* p0);
00203 
00204 
00205     /*
00206      * getPropParams
00207      *
00208      */
00209     ArrayList* getPropParams();
00210 
00211 
00212     /*
00213      * setPropParams
00214      *
00215      * @param p0
00216      */
00217     void setPropParams(ArrayList* p0);
00218 
00219     /*
00220      * setPropParams
00221      *
00222      * @param p0
00223      */
00224     void setPropParams(ArrayList& p0);
00225 
00226 
00227     /*
00228      * Creates an exact copy of this Property
00229      *
00230      * @return the cloned instance
00231      */
00232     ArrayElement* clone();
00233 
00234 
00235 };
00236 
00237 
00238 
00239 END_NAMESPACE
00240 
00242 #endif

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