inc/engine/finder/RelatedItem.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 RELATED_ITEM_H_
  19 #define RELATED_ITEM_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 an item related to a place returned as part of a
  31  * response to a query.
  32  *
  33  * \ingroup finder
  34  */
  35 class EXPORT_API RelatedItem
  36 {
  37 public:
  38
  39     /**
  40      * This method is the default constructor.
  41      */
  42     RelatedItem();
  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     RelatedItem(const RelatedItem& rRhs);
  51
  52     /**
  53      * This method is the destructor.
  54      */
  55     ~RelatedItem();
  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     RelatedItem& operator=(const RelatedItem& rRhs);
  67
  68     /**
  69      * This method retrieves the title/name of the related/recommended item.
  70      *
  71      * @return A string containing the title or name.
  72      */
  73     String GetTitle() const;
  74
  75     /**
  76      * This method retrieves the type specifier for the related/recommended item.
  77      *
  78      * @return A string containing the type specifier for the
  79      *       related/recommended item.
  80      */
  81     String GetType() const;
  82
  83     /**
  84      * This method retrieves a hyperlink that refers to the resource
  85      * represented by the related/recommended item.
  86      *
  87      * @return A string containing a hyperlink that refers to the resource
  88      *        represented by the related/recommended item.
  89      */
  90     String GetHref() const;
  91
  92     /**
  93      * This method sets the title/name of the related/recommended item.
  94      *
  95      * @param sTitle A constant reference to a string containing the title or
  96      *        name.
  97      */
  98     void SetTitle(const String& sTitle);
  99
 100     /**
 101      * This method sets the type specifier for the related/recommended item.
 102      *
 103      * @param sType A constant reference to a string containing the type
 104      *       specifier for the related/recommended item.
 105      */
 106     void SetType(const String& sType);
 107
 108     /**
 109      * This method sets a hyperlink that refers to the resource
 110      * represented by the related/recommended item.
 111      *
 112      * @param uHref A constant reference to an object containing a hyperlink that
 113      *        refers to the resource represented by the related/recommended
 114      *        item.
 115      */
 116     void SetHref(const String& uHref);
 117
 118 private:
 119     class RelatedItemImpl;
 120     RelatedItemImpl* m_pImpl;
 121
 122     friend class JsonParser;
 123 };
 124
 125 HERE_MAPS_END_NAMESPACE
 126
 127 #endif // RELATED_ITEM_H_
 128