src/client-api/src/include/common/syncml/core/Copy.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_COPY
  38 #define INCL_COPY
  39 /** @cond DEV */
  40
  41 #include "base/fscapi.h"
  42
  43 #include "syncml/core/ModificationCommand.h"
  44
  45 #define COPY_COMMAND_NAME "Copy"
  46 #include "base/globalsdef.h"
  47
  48 BEGIN_NAMESPACE
  49
  50 class Copy : public ModificationCommand {
  51
  52      // ------------------------------------------------------------ Private data
  53     private:
  54         char*  COMMAND_NAME;
  55
  56     // ---------------------------------------------------------- Public data
  57     public:
  58
  59         Copy();
  60         ~Copy();
  61
  62         /**
  63          * Creates a new Copy object with the given command identifier, noResponse,
  64          * credential, meta and array of item
  65          *
  66          * @param cmdID the command identifier - NOT NULL
  67          * @param noResp true if no response is required
  68          * @param cred the authentication credential
  69          * @param meta the meta data
  70          * @param items the array of item - NOT NULL
  71          *
  72          */
  73         Copy(CmdID* cmdID,
  74              bool noResp,
  75              Cred* cred,
  76              Meta* meta,
  77              ArrayList* items);
  78
  79        // ----------------------------------------------------------- Public methods
  80
  81         /**
  82          * Gets the command name property
  83          *
  84          * @return the command name property
  85          */
  86         const char* getName();
  87
  88         ArrayElement* clone();
  89 };
  90
  91
  92 END_NAMESPACE
  93
  94 /** @endcond */
  95 #endif