ctpropparam.h

funambol windows mobile plugin source code, the source code is taken from the funambol site

/*
 * Copyright (C) 2003-2007 Funambol, Inc
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY, TITLE, NONINFRINGEMENT or FITNESS FOR A PARTICULAR
 * PURPOSE.  See the GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
 * 02111-1307  USA
 */


#ifndef INCL_CTPROP_PARAM
#define INCL_CTPROP_PARAM
/** @cond DEV */

#include "base/fscapi.h"
#include "base/util/ArrayList.h"
#include "syncml/core/ContentTypeParameter.h"
#include "syncml/core/StringElement.h"

class CTPropParam : public ArrayElement{

     // ------------------------------------------------------------ Private data
    private:
        char*    propName;
        ArrayList* valEnum;       //String[]
        char*    displayName;
        char*    dataType;
        int size;
        ArrayList* ctParameters; //ContentTypeParameter[]

        void initialize();

    // ---------------------------------------------------------- Protected data
    public:
        CTPropParam();
        ~CTPropParam();

        CTPropParam(char*    propName,
                    ArrayList* valEnum,
                    char*    displayName,
                    ArrayList* ctParameters);


        /**
         * Creates a new ContentTypeProperty object with the given name, value and
         * display name
         *
         * @param propName corresponds to <PropName> element in the SyncML
         *                  specification - NOT NULL
         * @param dataType corresponds to <DataType> element in the SyncML
         *                  specification
         * @param size corresponds to <Size> element in the SyncML
         *                  specification
         * @param displayName corresponds to <DisplayName> element in the SyncML
         *                  specification
         * @param ctParameters the array of content type parameters - NOT NULL
         *
         */
        CTPropParam(char*  propName,
                           char*  dataType,
                           int size,
                           char*  displayName,
                           ArrayList* ctParameters);
        // ---------------------------------------------------------- Public methods

        /**
         * Gets the property name
         *
         * @return the property name
         */
        const char* getPropName();

        /**
         * Sets the property name
         *
         * @param propName the property name
         */
        void setPropName(const char* propName);

        /**
         * Gets the array of value for the property
         *
         * @return the array of value for the property
         */
        ArrayList* getValEnum();

        /**
         * Sets the array of enumerated value property
         *
         * @param valEnum the array of enumerated value property
         */
        void setValEnum(ArrayList* valEnum);

        /**
         * Gets the display name property
         *
         * @return the display name property
         */
        const char* getDisplayName();

        /**
         * Sets the display name of a given content type property
         *
         * @param displayName the display name of a given content type property
         */
        void setDisplayName(const char* displayName);

        /**
         * Gets the data type propeties
         *
         * @return the data type propeties
         */
        const char* getDataType();

        /**
         * Sets the data type of a given content type property
         *
         * @param dataType the data type of a given content type property
         */
        void setDataType(const char* dataType);

        /**
         * Gets the size propeties
         *
         * @return the size propeties
         */
        int getSize();

        /**
         * Sets the size of a given content type property
         *
         * @param size the size of a given content type property
         *
         */
        void setSize(int size);

        /**
         * Gets the array of ContentTypeParameter
         *
         * @return the size propeties
         */
        ArrayList* getContentTypeParameters();

        /**
         * Sets an array of content type properties
         *
         * @param ctParameters array of content type properties
         *
         */
        void setContentTypeParameters(ArrayList* ctParameters);

        ArrayElement* clone();
};

/** @endcond */
#endif