inc/engine/finder/LinkObject.h

   1 /*
   2  * Copyright (C) 2013 HERE Global B.V. All rights reserved.
   3  * This software, including documentation, is protected by copyright controlled by
   4  * HERE Global B.V. (“Software”). All rights are reserved. Copying, including reproducing,
   5  * storing, adapting or translating, any or all of this material requires the prior
   6  * written consent of HERE Global B.V. You may use this
   7  * Software in accordance with the terms and conditions defined in the
   8  * HERE Location Platform Services Terms and Conditions, available at
   9  * http://developer.here.com/terms-conditions-base
  10  *
  11  * As an additional permission to the above, you may distribute Software,
  12  * in object code format as part of an Application, according to, and subject to, terms and
  13  * conditions defined in the Tizen Software Development kit (“SDK”) License Agreement.
  14  * You may distribute such object code format Application under terms of your choice,
  15  * provided that the header and source files of the Software have not been modified.
  16  */
  17
  18 #ifndef LINKOBJECT_H_
  19 #define LINKOBJECT_H_
  20
  21 #include "common/HereMaps_global.h"
  22
  23 #ifndef TIZEN_MIGRATION
  24 #include <FBase.h>
  25 #endif
  26
  27 HERE_MAPS_BEGIN_NAMESPACE
  28
  29 /**
  30  * This class encapsulates a link that may be included in a search (result)
  31  * item.
  32  *
  33  * \ingroup finder
  34  */
  35 class EXPORT_API LinkObject
  36 {
  37 public:
  38
  39     /**
  40      * This method is the default constructor.
  41      */
  42     LinkObject();
  43
  44     /**
  45      * This method is the copy constructor.
  46      *
  47      * @param rRhs An object whose contents are to be copied to the instance
  48      *        being created.
  49      */
  50     LinkObject(const LinkObject& rRhs);
  51
  52     /**
  53      * This method is the destructor.
  54      */
  55     ~LinkObject();
  56
  57     /**
  58      * This is the assignment operator.
  59      *
  60      * @param rRhs An object whose contents are to be copied to the given
  61      *        instance.
  62      *
  63      * @return A reference to the given instance of the class after its contents
  64      *       have been updated.
  65      */
  66     LinkObject& operator=(const LinkObject& rRhs);
  67
  68     /**
  69      * This method retrieves the id of the resource to which the link points.
  70      *
  71      * @return A string containing the identifier of the object to which the
  72      *       link points.
  73      */
  74     String GetId() const;
  75
  76     /**
  77      * This method retrieves the title of the resource to which the link points.
  78      *
  79      * @return A string containing a localized title for the resource to which
  80      *        the link refers.
  81      */
  82     String GetTitle() const;
  83
  84     /**
  85      * This method retrieves the URI of the resource to which the link points.
  86      *
  87      * @return The URI for the resource to which the link refers.
  88      */
  89     String GetHref() const;
  90
  91     /**
  92      * This method retrieves the identifier of the type of the resource to which
  93      * the link points.
  94      *
  95      * @return A string containing the type identifier for the resource to which
  96      *       the link refers.
  97      */
  98     String GetType() const;
  99
 100     /**
 101      * This method retrieves the URI of the icon for the resource to which the
 102      * link points.
 103      *
 104      * @return The URI of the icon for the resource to which the link points.
 105      */
 106     String GetIconPath() const;
 107
 108     /**
 109      * This method sets the id of the resource to which the link points.
 110      *
 111      * @param rsIdentifier A constant reference to a string containing the
 112      *       identifier of the object to which the link points.
 113      */
 114     void SetId(const String& rsIdentifier);
 115
 116     /**
 117      * This method sets the title of the resource to which the link points.
 118      *
 119      * @param sTitle A constant reference to a string containing a localized
 120      *        title for the resource to which the link refers.
 121      */
 122     void SetTitle(const String& sTitle);
 123
 124     /**
 125      * This method sets the URI of the resource to which the link points.
 126      *
 127      * @param rHref A constant reference to an object holding the URI for the
 128      *       resource to which the link refers.
 129      */
 130     void SetHref(const String& rHref);
 131
 132     /**
 133      * This method sets the identifier of the type of the resource to which
 134      * the link points.
 135      *
 136      * @param sType A constant reference to a string containing the type
 137      *       identifier for the resource to which the link refers.
 138      */
 139     void SetType(const String& sType);
 140
 141     /**
 142      * This method sets the URI of the icon for the resource to which the
 143      * link points.
 144      *
 145      * @param A constant reference to an object containing the URI of the icon
 146      *        for the resource to which the link points.
 147      */
 148     void SetIconPath(const String& rIconUrl);
 149
 150 private:
 151     class LinkObjectImpl;
 152     LinkObjectImpl* m_pImpl;
 153
 154     friend class JsonParser;
 155 };
 156
 157 HERE_MAPS_END_NAMESPACE
 158
 159 #endif // LINKOBJECT_H_