src/client-api/src/include/common/syncml/core/TargetRef.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_TARGET_REF
  38 #define INCL_TARGET_REF
  39 /** @cond DEV */
  40
  41 #include "base/fscapi.h"
  42 #include "base/util/ArrayElement.h"
  43 #include "syncml/core/Target.h"
  44 #include "base/globalsdef.h"
  45
  46 BEGIN_NAMESPACE
  47
  48
  49
  50 class TargetRef : public ArrayElement{
  51
  52      // ------------------------------------------------------------ Private data
  53     private:
  54         char*  value;
  55         char*  query;
  56         Target* target;
  57
  58         void initialize();
  59
  60         /*
  61         * Used to set the query field in the clone method
  62         */
  63         void setQuery(const char* val);
  64
  65     // ---------------------------------------------------------- Protected data
  66     public:
  67
  68         TargetRef();
  69         ~TargetRef();
  70
  71          /**
  72          * Creates a new TargetRef object given the referenced value. A null value
  73          * is considered an empty string
  74          *
  75          * @param value the referenced value - NULL ALLOWED
  76          *
  77          */
  78         TargetRef(const char*  value);
  79
  80         /**
  81          * Creates a new TargetRef object from an existing target.
  82          *
  83          * @param target the target to extract the reference from - NOT NULL
  84          *
  85          *
  86          */
  87         TargetRef(Target* target);
  88
  89         // ---------------------------------------------------------- Public methods
  90
  91         /**
  92          * Returns the value
  93          *
  94          * @return the value
  95          */
  96         const char*  getValue();
  97
  98         /**
  99          * Sets the reference value. If value is null, the empty string is adopted.
 100          *
 101          * @param value the reference value - NULL
 102          */
 103         void setValue(const char*  value);
 104
 105         /**
 106          * Gets the Target property
 107          *
 108          * @return target the Target property
 109          */
 110         Target* getTarget();
 111
 112         /**
 113          * Sets the Target property
 114          *
 115          * @param target the Target property
 116          */
 117         void setTarget(Target* target);
 118
 119         ArrayElement* clone();
 120 };
 121
 122
 123 END_NAMESPACE
 124
 125 /** @endcond */
 126 #endif