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 
00042 class Property : public ArrayElement {
00043 
00044     // ------------------------------------------------------- Private interface
00045 private:
00046 
00047     char*  propName;
00048     char*  dataType;
00049     long maxOccur;
00050     long maxSize;
00051     BOOL noTruncate;  // -1 undefined, 0 FALSE, 1 TRUE
00052     ArrayList* valEnums;
00053     char*  displayName;
00054     ArrayList* propParams;
00055 
00056 
00057 
00058     // ----------------------------------------------------- Protected interface
00059 protected:
00060 
00061 
00062 
00063 
00064     // -------------------------------------------------------- Public interface
00065 public:
00066 
00067     /*
00068      * Property constructor
00069      */
00070     Property();
00071 
00072     ~Property();
00073 
00074     /*
00075      * Property constructor
00076      *
00077      * @param p0
00078      * @param p1
00079      * @param p2
00080      * @param p3
00081      * @param p4
00082      * @param p5
00083      * @param p6
00084      * @param p7
00085      */
00086     Property(char*  p0, char*  p1, long p2, long p3, BOOL p4, ArrayList* p5, char*  p6, ArrayList* p7);
00087 
00088 
00089     /*
00090      * getDisplayName
00091      *
00092      */
00093     const char* getDisplayName();
00094 
00095     /*
00096      * getPropName
00097      *
00098      */
00099     const char* getPropName();
00100 
00101 
00102     /*
00103      * setPropName
00104      *
00105      * @param p0
00106      */
00107     void setPropName(const char* propName);
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      * getMaxOccur
00127      *
00128      */
00129     long getMaxOccur();
00130 
00131 
00132     /*
00133      * setMaxOccur
00134      *
00135      * @param p0
00136      */
00137     void setMaxOccur(long p0);
00138 
00139 
00140     /*
00141      * getMaxSize
00142      *
00143      */
00144     long getMaxSize();
00145 
00146 
00147     /*
00148      * setMaxSize
00149      *
00150      * @param p0
00151      */
00152     void setMaxSize(long p0);
00153 
00154 
00155     /*
00156      * setNoTruncate
00157      *
00158      * @param p0
00159      */
00160     void setNoTruncate(BOOL p0);
00161 
00162 
00163     /*
00164      * isNoTruncate
00165      *
00166      */
00167     BOOL isNoTruncate();
00168 
00169 
00170     /*
00171      * getNoTruncate
00172      *
00173      */
00174     BOOL getNoTruncate();
00175 
00176 
00177     /*
00178      * getValEnums
00179      *
00180      */
00181     ArrayList* getValEnums();
00182 
00183 
00184     /*
00185      * setValEnums
00186      *
00187      * @param p0
00188      */
00189     void setValEnums(ArrayList* p0);
00190 
00191 
00192     /*
00193      * setDisplayName
00194      *
00195      * @param p0
00196      */
00197     void setDisplayName(const char* p0);
00198 
00199 
00200     /*
00201      * getPropParams
00202      *
00203      */
00204     ArrayList* getPropParams();
00205 
00206 
00207     /*
00208      * setPropParams
00209      *
00210      * @param p0
00211      */
00212     void setPropParams(ArrayList* p0);
00213 
00214     /*
00215      * setPropParams
00216      *
00217      * @param p0
00218      */
00219     void setPropParams(ArrayList& p0);
00220 
00221 
00222     /*
00223      * Creates an exact copy of this Property
00224      *
00225      * @return the cloned instance
00226      */
00227     ArrayElement* clone();
00228 
00229 
00230 };
00231 
00232 
00234 #endif

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