src/client-api/src/include/common/syncml/core/Map.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_MAP
  38 #define INCL_MAP
  39 /** @cond DEV */
  40
  41 #include "base/fscapi.h"
  42 #include "syncml/core/AbstractCommand.h"
  43 #include "syncml/core/ModificationCommand.h"
  44
  45 #define MAP_COMMAND_NAME "Map"
  46 #include "base/globalsdef.h"
  47
  48 BEGIN_NAMESPACE
  49
  50 class Map : public AbstractCommand {
  51
  52      // ------------------------------------------------------------ Private data
  53     private:
  54         char*  COMMAND_NAME;
  55         Target*    target;
  56         Source*    source;
  57         ArrayList* mapItems; //MapItem[]
  58         void initialize();
  59
  60     public:
  61
  62
  63         // ------------------------------------------------------------ Constructors
  64
  65         Map();
  66         ~Map();
  67
  68         /**
  69          * Creates a new Map commands from its constituent information.
  70          *
  71          * @param cmdID command identifier - NOT NULL
  72          * @param target the target - NOT NULL
  73          * @param source the source - NOT NULL
  74          * @param cred authentication credential - NULL ALLOWED
  75          * @param meta the associated meta data - NULL ALLOWED
  76          * @param mapItems the mapping items - NOT NULL
  77          *
  78          */
  79         Map(CmdID* cmdID,
  80             Target* target,
  81             Source* source,
  82             Cred* cred,
  83             Meta* meta,
  84             ArrayList* mapItems);
  85
  86         /**
  87          * Returns the target property
  88          * @return the target property
  89          *
  90          */
  91         Target* getTarget();
  92
  93         /**
  94          * Sets the target property
  95          *
  96          * @param target the target - NOT NULL
  97          *
  98          */
  99         void setTarget(Target* target);
 100
 101         /**
 102          * Returns the source property
 103          * @return the source property
 104          *
 105          */
 106         Source* getSource();
 107
 108         /**
 109          * Sets the source property
 110          *
 111          * @param source the source - NOT NULL
 112          *
 113          */
 114         void setSource(Source* source);
 115
 116         /**
 117          * Returns the map items
 118          *
 119          * @return the map items
 120          *
 121          */
 122         ArrayList* getMapItems();
 123
 124         /**
 125          * Sets the mapItems property
 126          *
 127          * @param mapItems the map items - NOT NULL
 128          *
 129          */
 130         void setMapItems(ArrayList* mapItems);
 131
 132         /**
 133          * Returns the command name
 134          *
 135          * @return the command name
 136          */
 137         const char* getName();
 138
 139         ArrayElement* clone();
 140 };
 141
 142
 143 END_NAMESPACE
 144
 145 /** @endcond */
 146 #endif