src/include/common/spds/SyncItemStatus.h

00001 /*
00002  * Funambol is a mobile platform developed by Funambol, Inc. 
00003  * Copyright (C) 2003 - 2007 Funambol, Inc.
00004  * 
00005  * This program is free software; you can redistribute it and/or modify it under
00006  * the terms of the GNU Affero General Public License version 3 as published by
00007  * the Free Software Foundation with the addition of the following permission 
00008  * added to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED
00009  * WORK IN WHICH THE COPYRIGHT IS OWNED BY FUNAMBOL, FUNAMBOL DISCLAIMS THE 
00010  * WARRANTY OF NON INFRINGEMENT  OF THIRD PARTY RIGHTS.
00011  * 
00012  * This program is distributed in the hope that it will be useful, but WITHOUT
00013  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
00014  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
00015  * details.
00016  * 
00017  * You should have received a copy of the GNU Affero General Public License 
00018  * along with this program; if not, see http://www.gnu.org/licenses or write to
00019  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
00020  * MA 02110-1301 USA.
00021  * 
00022  * You can contact Funambol, Inc. headquarters at 643 Bair Island Road, Suite 
00023  * 305, Redwood City, CA 94063, USA, or at email address info@funambol.com.
00024  * 
00025  * The interactive user interfaces in modified source and object code versions
00026  * of this program must display Appropriate Legal Notices, as required under
00027  * Section 5 of the GNU Affero General Public License version 3.
00028  * 
00029  * In accordance with Section 7(b) of the GNU Affero General Public License
00030  * version 3, these Appropriate Legal Notices must retain the display of the
00031  * "Powered by Funambol" logo. If the display of the logo is not reasonably 
00032  * feasible for technical reasons, the Appropriate Legal Notices must display
00033  * the words "Powered by Funambol".
00034  */
00035 
00036  #ifndef INCL_SYNC_ITEM_STATUS
00037     #define INCL_SYNC_ITEM_STATUS
00038 
00040     #include "base/fscapi.h"
00041     #include "base/constants.h"
00042     #include "base/util/ArrayElement.h"
00043     #include "spds/constants.h"
00044 #include "base/globalsdef.h"
00045 
00046 BEGIN_NAMESPACE
00047 
00048 
00049     class SyncItemStatus : public ArrayElement {
00050 
00051     private:
00052 
00053         int      cmdID ;
00054         int      msgRef;
00055         int      cmdRef;
00056         char*  cmd   ;
00057         char*  key   ;
00058         int      data  ;
00059 
00060     public:
00061         /*
00062          * Default constructor
00063          */
00064         SyncItemStatus();
00065 
00066         /*
00067          * Constructs a new SyncItemStatus identified by the given key. The key must
00068          * not be longer than DIM_KEY_SYNC_ITEM_STATUS (see SPDS Constants).
00069          *
00070          * @param key - the key
00071          */
00072         SyncItemStatus(char*  key);
00073 
00074         ~SyncItemStatus();
00075 
00076         /*
00077          * Returns the SyncItemStatus's key. If key is NULL, the internal buffer is
00078          * returned; if key is not NULL, the value is copied in the caller
00079          * allocated buffer and the given buffer pointer is returned.
00080          */
00081         const char* getKey();
00082 
00083         /*
00084          * Changes the SyncItemStatus key. The key must not be longer than DIM_KEY_SYNC_ITEM_STATUS
00085          * (see SPDS Constants).
00086          *
00087          * @param key - the key
00088          */
00089         void setKey(const char* key);
00090 
00091          /*
00092          * Returns the SyncItemStatus's command name. If cmd is NULL, the internal buffer is
00093          * returned; if cmd is not NULL, the value is copied in the caller
00094          * allocated buffer and the given buffer pointer is returned.
00095          */
00096         const char* getCmd();
00097 
00098         /*
00099          * Changes the SyncItemStatus cmd. The cmd must not be longer than DIM_COMMAND_SYNC_ITEM_STATUS
00100          * (see SPDS Constants).
00101          *
00102          * @param cmd - the cmd
00103          */
00104         void setCmd(const char* cmd);
00105 
00106 
00107         /*
00108          * Sets the SyncItemStatus data. The passed data are copied into an
00109          * internal variable.
00110          */
00111         void setData(int data);
00112 
00113         /*
00114          * Returns the SyncItemStatus data variable.
00115          */
00116         int getData();
00117 
00118 
00119         /*
00120          * Sets the SyncItemStatus command ID. The passed data are copied into an
00121          * internal variable.
00122          */
00123         void setCmdID(int cmdId);
00124 
00125         /*
00126          * Returns the SyncItemStatus command ID variable.
00127          */
00128         int getCmdID();
00129 
00130         /*
00131          * Sets the SyncItemStatus message referring. The passed data are copied into an
00132          * internal variable.
00133          */
00134         void setMsgRef(int msgRef);
00135 
00136         /*
00137          * Returns the SyncItemStatus message referring variable.
00138          */
00139         int getMsgRef();
00140 
00141         /*
00142          * Sets the SyncItemStatus command referring. The passed data are copied into an
00143          * internal variable.
00144          */
00145         void setCmdRef(int cmdRef);
00146 
00147         /*
00148          * Returns the SyncItemStatus command referring variable.
00149          */
00150         int getCmdRef();
00151 
00157         ArrayElement* clone();
00158 
00159     };
00160 
00161 
00162 END_NAMESPACE
00163 
00165 #endif

Generated on Tue Jun 10 17:20:21 2008 for Funambol C++ Client Library by  doxygen 1.5.2