status.h

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

/*
 * 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_STATUS
#define INCL_STATUS
/** @cond DEV */

#include "base/fscapi.h"
#include "syncml/core/ResponseCommand.h"
#include "syncml/core/Chal.h"
#include "syncml/core/Data.h"

#define STATUS_COMMAND_NAME "Status"
#include "base/globalsdef.h"

BEGIN_NAMESPACE

class Status : public ResponseCommand {

    private:
        char*   COMMAND_NAME;
        Chal*     chal;
        Data*     data;
        char*   cmd;

        void initialize();

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

        /**
         * For serialiazaion purposes
         */
        Status();
        ~Status();

        /**
         * Creates a new Status object.
         *
         * @param cmdID command identifier - NOT NULL
         * @param msgRef message reference
         * @param cmdRef command reference - NOT NULL
         * @param cmd command - NOT NULL
         * @param targetRefs target references. If null
         * @param sourceRefs source references. If null
         * @param cred authentication credentials
         * @param chal authentication challenge
         * @param data status data - NOT NULL
         * @param items command items - NOT NULL
         *
         *
         */
        Status(  CmdID*        cmdID     ,
                 const char*   msgRef    ,
                 const char*   cmdRef    ,
                 const char*   cmd       ,
                 ArrayList*    targetRefs,
                 ArrayList*    sourceRefs,
                 Cred*         cred      ,
                 Chal*         chal      ,
                 Data*         data      ,
                 ArrayList*    items     );


        /**
         * Returns the chal element
         *
         * @return the chal element
         *
         */
        Chal* getChal();

        /**
         * Sets the chal element
         *
         * @param chal the new chal
         */
        void setChal(Chal* chal);

        /**
         * Returns the status data
         *
         * @return the status data
         *
         */
        Data* getData();

        /**
         * Sets the status data
         *
         * @param data the new data
         *
         */
        void setData(Data* data);

        /**
         * Returns the cmd element
         *
         * @return the cmd element
         */
        const char* getCmd();

        /**
         * Sets the cmd element
         *
         * @param cmd the new cmd element - NOT NULL
         *
         */
        void setCmd(const char*  cmd);

        /**
         * Returns the status code as int
         *
         * @return the status code as int
         */
        int getStatusCode();

        /**
         * Returns the command name
         *
         * @return the command name
         */
        const char* getName();

        ArrayElement* clone();
};


END_NAMESPACE

/** @endcond */
#endif