src/client-api/src/include/common/syncml/core/Delete.h

   1 /*
   2  * Funambol is a mobile platform developed by Funambol, Inc.
   3  * Copyright (C) 2003 - 2007 Funambol, Inc.
   4  *
   5  * This program is free software; you can redistribute it and/or modify it under
   6  * the terms of the GNU Affero General Public License version 3 as published by
   7  * the Free Software Foundation with the addition of the following permission
   8  * added to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED
   9  * WORK IN WHICH THE COPYRIGHT IS OWNED BY FUNAMBOL, FUNAMBOL DISCLAIMS THE
  10  * WARRANTY OF NON INFRINGEMENT  OF THIRD PARTY RIGHTS.
  11  *
  12  * This program is distributed in the hope that it will be useful, but WITHOUT
  13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  14  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  15  * details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program; if not, see http://www.gnu.org/licenses or write to
  19  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
  20  * MA 02110-1301 USA.
  21  *
  22  * You can contact Funambol, Inc. headquarters at 643 Bair Island Road, Suite
  23  * 305, Redwood City, CA 94063, USA, or at email address info@funambol.com.
  24  *
  25  * The interactive user interfaces in modified source and object code versions
  26  * of this program must display Appropriate Legal Notices, as required under
  27  * Section 5 of the GNU Affero General Public License version 3.
  28  *
  29  * In accordance with Section 7(b) of the GNU Affero General Public License
  30  * version 3, these Appropriate Legal Notices must retain the display of the
  31  * "Powered by Funambol" logo. If the display of the logo is not reasonably
  32  * feasible for technical reasons, the Appropriate Legal Notices must display
  33  * the words "Powered by Funambol".
  34  */
  35
  36
  37 #ifndef INCL_DELETE
  38 #define INCL_DELETE
  39 /** @cond DEV */
  40
  41 #include "base/fscapi.h"
  42 #include "syncml/core/ModificationCommand.h"
  43
  44 #define DELETE_COMMAND_NAME "Delete"
  45 #include "base/globalsdef.h"
  46
  47 BEGIN_NAMESPACE
  48
  49 class Delete : public ModificationCommand {
  50
  51      // ------------------------------------------------------------ Private data
  52     private:
  53         char*  COMMAND_NAME;
  54         bool archive;
  55         bool sftDel;
  56
  57     // ---------------------------------------------------------- Public data
  58     public:
  59
  60         Delete();
  61         ~Delete();
  62
  63         /**
  64          * Creates a new Delete object with the given command identifier,
  65          * noResponse, archiveData, softDelete, credential, meta and array of item
  66          *
  67          * @param cmdID the command identifier - NOT NULL
  68          * @param noResp true if no response is required
  69          * @param archive true if the deleted data should be archived
  70          * @param sftDel true if this is a "soft delete". If set to false, then
  71          *                   this delete command is a "hard delete"
  72          * @param cred the authentication credential
  73          * @param meta the meta data
  74          * @param items the array of item - NOT NULL
  75          *
  76          */
  77         Delete(CmdID* cmdID,
  78                bool noResp,
  79                bool archive,
  80                bool sftDel,
  81                Cred* cred,
  82                Meta* meta,
  83                ArrayList* items);
  84
  85         /**
  86          * Gets the command name property
  87          *
  88          * @return the command name property
  89          */
  90         const char* getName();
  91
  92         /**
  93          * Gets the Archive property
  94          *
  95          * @return true if the deleted data should be archived
  96          */
  97         bool isArchive();
  98
  99         /**
 100          * Gets the Boolean archive property
 101          *
 102          * @return archive the Boolean archive property
 103          */
 104         bool getArchive();
 105
 106         /**
 107          * Sets the archive property
 108          *
 109          * @param archive the Boolean archive object
 110          */
 111         void setArchive(bool archive);
 112
 113         /**
 114          * Gets the SftDel property
 115          *
 116          * @return <b>true</b>  if this is a "Soft delete"
 117          *         <b>false</b> if this is a "hard delete"
 118          */
 119         bool isSftDel();
 120
 121         bool getSftDel();
 122
 123
 124         void setSftDel(bool sftDel);
 125
 126         ArrayElement* clone();
 127
 128 };
 129
 130
 131 END_NAMESPACE
 132
 133 /** @endcond */
 134 #endif