contenttypeparameter.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_CONTENT_TYPE_PARAMETER
#define INCL_CONTENT_TYPE_PARAMETER
/** @cond DEV */

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

class ContentTypeParameter : public ArrayElement {

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

    // ---------------------------------------------------------- Protected data
    public:

        ContentTypeParameter();
        ~ContentTypeParameter();

        /**
         * Creates a new ContentTypeParameter object with the given name, value and
         * display name
         *
         * @param paramName corresponds to <ParamName> element in the SyncML
         *                  specification - NOT NULL
         * @param valEnum   corresponds to <ValEnum> element in the SyncML
         *                  specification
         * @param displayName corresponds to <DisplayName> element in the SyncML
         *                  specification
         *
         */
        ContentTypeParameter(char*  paramName,
                             ArrayList* valEnum,
                             char*  displayName);

        /**
         * Creates a new ContentTypeParameter object with the given name, data type,
         * size, display name
         *
         * @param paramName corresponds to <ParamName> 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
         *
         */
        ContentTypeParameter(char*  paramName,
                             char*  dataType,
                             int size,
                             char*  displayName);


        /**
         * Gets the parameter name propeties
         *
         * @return the parameter name propeties
         */
        const char* getParamName();

        /**
         * Sets the param name property
         *
         * @param paramName the param name property
         */
        void setParamName(const char* paramName);

        /**
         * Gets the array of value for parameter
         *
         * @return the array of value for parameter
         */
        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 propeties
         *
         * @return the display name propeties
         */
        const char* getDisplayName();

        /**
         * Sets the display name of a given content type parameter
         *
         * @param displayName the display name of a given content type parameter
         *
         */
        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 parameter
         *
         * @param dataType the data type of a given content type parameter
         *
         */
        void setDataType(const char* dataType);

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

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

        ArrayElement* clone();

};

/** @endcond */
#endif