syncbody.h

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

/*
 * 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_SYNC_BODY
#define INCL_SYNC_BODY
/** @cond DEV */

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

BEGIN_NAMESPACE


class SyncBody {

     // ------------------------------------------------------------ Private data
    private:
        ArrayList* commands;
        bool finalMsg;
        void initialize();
    public:

        SyncBody();
        ~SyncBody();

        /**
         * Create a new SyncBody object. The commands in <i>commands</i>
         * must be of the allowed types.
         *
         * @param commands The array elements must be an instance of one of these
         *                 classes: {@link Alert},  {@link Atomic}, {@link Copy},
         *                 {@link Exec}, {@link Get}, {@link Map}, {@link Put},
         *                 {@link Results}, {@link Search}, {@link Sequence},
         *                 {@link Status}, {@link Sync}
         * @param finalMsg is true if this is the final message that is being sent
         *
         */
        SyncBody(ArrayList* commands   , // AbstractCommand[]
                 bool       finalMsg);


        /**
         *
         *  @return the return value is guaranteed to be non-null. Also,
         *          the elements of the array are guaranteed to be non-null.
         *
         */
        ArrayList* getCommands();

        /**
         * Sets the sequenced commands. The given commands must be of the allowed
         * types.
         *
         * @param commands the commands - NOT NULL and o the allowed types
         *
         */
        void setCommands(ArrayList* commands);

        /**
         * Sets the message as final
         *
         * @param finalMsg the Boolean value of finalMsg property
         */
        void setFinalMsg(bool finalMsg);

        /**
         * Gets the value of finalMsg property
         *
         * @return true if this is the final message being sent, otherwise null
         *
         */
        bool getFinalMsg();

        SyncBody* clone();
};


END_NAMESPACE

/** @endcond */
#endif