datastore.h

来自「funambol window mobile客户端源代码」· C头文件 代码 · 共 256 行

/*
 * Funambol is a mobile platform developed by Funambol, Inc. 
 * 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 Affero General Public License version 3 as published by
 * the Free Software Foundation with the addition of the following permission 
 * added to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED
 * WORK IN WHICH THE COPYRIGHT IS OWNED BY FUNAMBOL, FUNAMBOL DISCLAIMS THE 
 * WARRANTY OF NON INFRINGEMENT  OF THIRD PARTY RIGHTS.
 * 
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
 * details.
 * 
 * You should have received a copy of the GNU Affero General Public License 
 * along with this program; if not, see http://www.gnu.org/licenses or write to
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
 * MA 02110-1301 USA.
 * 
 * You can contact Funambol, Inc. headquarters at 643 Bair Island Road, Suite 
 * 305, Redwood City, CA 94063, USA, or at email address [e-mail].
 * 
 * The interactive user interfaces in modified source and object code versions
 * of this program must display Appropriate Legal Notices, as required under
 * Section 5 of the GNU Affero General Public License version 3.
 * 
 * In accordance with Section 7(b) of the GNU Affero General Public License
 * version 3, these Appropriate Legal Notices must retain the display of the
 * "Powered by Funambol" logo. If the display of the logo is not reasonably 
 * feasible for technical reasons, the Appropriate Legal Notices must display
 * the words "Powered by Funambol".
 */


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

#include "base/fscapi.h"
#include "base/util/ArrayList.h"
#include "syncml/core/SourceRef.h"
#include "syncml/core/ContentTypeInfo.h"
#include "syncml/core/DSMem.h"
#include "syncml/core/SyncCap.h"
#include "base/globalsdef.h"

BEGIN_NAMESPACE


class DataStore : public ArrayElement {

     // ------------------------------------------------------------ Private data
    private:
        SourceRef*       sourceRef;
        char*          displayName;
        long             maxGUIDSize;
        ContentTypeInfo* rxPref;
        ArrayList*       rx; // ContentTypeInfo[]
        ContentTypeInfo* txPref;
        ArrayList*       tx; // ContentTypeInfo[]
        ArrayList*       ctCaps;
        DSMem*           dsMem;
        SyncCap*         syncCap;

        void initialize();

    // ---------------------------------------------------------- Public data
    public:

        DataStore();
        ~DataStore();

        /**
         * Creates a new DataStore object with the given input information
         *
         * @param sourceRef specifies the source address from the associated
         *                  command - NOT NULL
         * @param displayName the display name
         * @param maxGUIDSize the maximum GUID size. Set to -1 if the Maximum GUID
         *                  size is unknown or unspecified. Otherwise, this
         *                  parameter should be a positive number.
         * @param rxPref the relative information received to the content type
         *               preferred - NOT NULL
         * @param rx an array of the relative info received to the content type
         *           supported - NOT NULL
         * @param txPref the relative information trasmitted
         *                  to the content type preferred - NOT NULL
         * @param tx an array of the relative info trasmitted to the content type
         *           supported - NOT NULL
         * @param dsMem the datastore memory info
         * @param syncCap the synchronization capabilities - NOT NULL
         *
         */
        DataStore(SourceRef* sourceRef,
                  char*  displayName,
                  long maxGUIDSize,
                  ContentTypeInfo* rxPref,
                  ArrayList* rx,
                  ContentTypeInfo* txPref,
                  ArrayList* tx,
                  ArrayList* ct_Caps,
                  DSMem* dsMem,
                  SyncCap* syncCap);

        /**
         * Gets the sourceRef properties
         *
         * @return the sourceRef properties
         */
        SourceRef* getSourceRef();

        /**
         * Sets the reference URI
         *
         * @param sourceRef the reference URI
         *
         */
        void setSourceRef(SourceRef* sourceRef);

        /**
         * Gets the displayName properties
         *
         * @return the displayName properties
         */
        const char* getDisplayName();

        /**
         * Sets the displayName property
         *
         * @param displayName the displauName property
         *
         */
        void setDisplayName(const char* displayName);

        /**
         * Gets the maxGUIDSize properties
         *
         * @return the maxGUIDSize properties
         */
        long getMaxGUIDSize();

        void setMaxGUIDSize(long maxGUIDSize);

        /**
         * Gets the ContentTypeInfo corresponds to <Rx-Pref> element
         *
         * @return the ContentTypeInfo corresponds to &l;tRx-Pref> element
         */
        ContentTypeInfo* getRxPref();

        /**
         * Sets the preferred type and version of a content type received by the device
         *
         * @param rxPref the preferred type and version of a content type
         */
        void setRxPref(ContentTypeInfo* rxPref);

        /**
         * Gets the ContentTypeInfo corresponds to <Rx> element
         *
         * @return the ContentTypeInfo corresponds to <Rx> element
         */
        ArrayList* getRx();

        /**
         * Sets the supported type and version of a content type received by the device
         *
         * @param rxCTI and array of supported type and version of a content type
         */
        void setRx(ArrayList* rxCTI);


        /**
         * Gets the ContentTypeInfo corresponds to <Tx-Pref> element
         *
         * @return the ContentTypeInfo corresponds to <Tx-Pref> element
         */
        ContentTypeInfo* getTxPref();

        /**
         * Sets the preferred type and version of a content type trasmitted by the device
         *
         * @param txPref the preferred type and version of a content type
         */
        void setTxPref(ContentTypeInfo* txPref);

        /**
         * Gets an array of ContentTypeInfo corresponds to <Tx> element
         *
         * @return an array of ContentTypeInfo corresponds to <Tx> element
         */
        ArrayList* getTx();

        /**
         * Sets the supported type and version of a content type trasmitted by the device
         *
         * @param txCTI and array of supported type and version of a content type
         */
        void setTx(ArrayList* txCTI);

        /**
         * Gets the datastore memory information.
         *
         * @return the datastore memory information.
         */
        DSMem* getDSMem();

        /**
         * Sets the datastore memory information
         *
         * @param dsMem the datastore memory information
         */
        void setDSMem(DSMem* dsMem);

        /**
         * Gets the synchronization capabilities of a datastore.
         *
         * @return the synchronization capabilities of a datastore.
         */
        SyncCap* getSyncCap();

        /**
         * Sets the synchronization capabilities of a datastore.
         *
         * @param syncCap the synchronization capabilities of a datastore
         *
         */
        void setSyncCap(SyncCap* syncCap);

        /**
         * Gets an array of CtCaps corresponds to <CTCap> element
         *
         * @return an array of CTCaps corresponds to <CTCap> element
         */
        ArrayList* getCtCaps();

        /**
         * Sets an array of CtCaps
         *
         * @param Ct_Caps an array of Ctcaps
         */
        void setCtCaps(ArrayList* Ct_Caps);


        ArrayElement* clone();

};


END_NAMESPACE

/** @endcond */
#endif