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_DELETE 00038 #define INCL_DELETE 00039 /** @cond DEV */ 00040 00041 #include "base/fscapi.h" 00042 #include "syncml/core/ModificationCommand.h" 00043 00044 #define DELETE_COMMAND_NAME "Delete" 00045 #include "base/globalsdef.h" 00046 00047 BEGIN_NAMESPACE 00048 00049 class Delete : public ModificationCommand { 00050 00051 // ------------------------------------------------------------ Private data 00052 private: 00053 char* COMMAND_NAME; 00054 bool archive; 00055 bool sftDel; 00056 00057 // ---------------------------------------------------------- Public data 00058 public: 00059 00060 Delete(); 00061 ~Delete(); 00062 00063 /** 00064 * Creates a new Delete object with the given command identifier, 00065 * noResponse, archiveData, softDelete, credential, meta and array of item 00066 * 00067 * @param cmdID the command identifier - NOT NULL 00068 * @param noResp true if no response is required 00069 * @param archive true if the deleted data should be archived 00070 * @param sftDel true if this is a "soft delete". If set to false, then 00071 * this delete command is a "hard delete" 00072 * @param cred the authentication credential 00073 * @param meta the meta data 00074 * @param items the array of item - NOT NULL 00075 * 00076 */ 00077 Delete(CmdID* cmdID, 00078 bool noResp, 00079 bool archive, 00080 bool sftDel, 00081 Cred* cred, 00082 Meta* meta, 00083 ArrayList* items); 00084 00085 /** 00086 * Gets the command name property 00087 * 00088 * @return the command name property 00089 */ 00090 const char* getName(); 00091 00092 /** 00093 * Gets the Archive property 00094 * 00095 * @return true if the deleted data should be archived 00096 */ 00097 bool isArchive(); 00098 00099 /** 00100 * Gets the Boolean archive property 00101 * 00102 * @return archive the Boolean archive property 00103 */ 00104 bool getArchive(); 00105 00106 /** 00107 * Sets the archive property 00108 * 00109 * @param archive the Boolean archive object 00110 */ 00111 void setArchive(bool archive); 00112 00113 /** 00114 * Gets the SftDel property 00115 * 00116 * @return <b>true</b> if this is a "Soft delete" 00117 * <b>false</b> if this is a "hard delete" 00118 */ 00119 bool isSftDel(); 00120 00121 bool getSftDel(); 00122 00123 00124 void setSftDel(bool sftDel); 00125 00126 ArrayElement* clone(); 00127 00128 }; 00129 00130 00131 END_NAMESPACE 00132 00133 /** @endcond */ 00134 #endif