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 00037 #ifndef INCL_SYNC_BODY 00038 #define INCL_SYNC_BODY 00039 /** @cond DEV */ 00040 00041 #include "base/fscapi.h" 00042 #include "base/util/ArrayList.h" 00043 #include "syncml/core/AbstractCommand.h" 00044 #include "base/globalsdef.h" 00045 00046 BEGIN_NAMESPACE 00047 00048 00049 class SyncBody { 00050 00051 // ------------------------------------------------------------ Private data 00052 private: 00053 ArrayList* commands; 00054 bool finalMsg; 00055 void initialize(); 00056 public: 00057 00058 SyncBody(); 00059 ~SyncBody(); 00060 00061 /** 00062 * Create a new SyncBody object. The commands in <i>commands</i> 00063 * must be of the allowed types. 00064 * 00065 * @param commands The array elements must be an instance of one of these 00066 * classes: {@link Alert}, {@link Atomic}, {@link Copy}, 00067 * {@link Exec}, {@link Get}, {@link Map}, {@link Put}, 00068 * {@link Results}, {@link Search}, {@link Sequence}, 00069 * {@link Status}, {@link Sync} 00070 * @param finalMsg is true if this is the final message that is being sent 00071 * 00072 */ 00073 SyncBody(ArrayList* commands , // AbstractCommand[] 00074 bool finalMsg); 00075 00076 00077 /** 00078 * 00079 * @return the return value is guaranteed to be non-null. Also, 00080 * the elements of the array are guaranteed to be non-null. 00081 * 00082 */ 00083 ArrayList* getCommands(); 00084 00085 /** 00086 * Sets the sequenced commands. The given commands must be of the allowed 00087 * types. 00088 * 00089 * @param commands the commands - NOT NULL and o the allowed types 00090 * 00091 */ 00092 void setCommands(ArrayList* commands); 00093 00094 /** 00095 * Sets the message as final 00096 * 00097 * @param finalMsg the Boolean value of finalMsg property 00098 */ 00099 void setFinalMsg(bool finalMsg); 00100 00101 /** 00102 * Gets the value of finalMsg property 00103 * 00104 * @return true if this is the final message being sent, otherwise null 00105 * 00106 */ 00107 bool getFinalMsg(); 00108 00109 SyncBody* clone(); 00110 }; 00111 00112 00113 END_NAMESPACE 00114 00115 /** @endcond */ 00116 #endif