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
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.
18 #ifndef REVIEW_CONTENT_H_
19 #define REVIEW_CONTENT_H_
22 #include "common/HereMaps_global.h"
23 #ifndef TIZEN_MIGRATION
24 #include <FBaseDateTime.h>
27 #include "finder/BaseContent.h"
29 HERE_MAPS_BEGIN_NAMESPACE
35 * This typedef defines a list or review content items as a type.
37 typedef std::vector<ReviewContent> ReviewContentList;
40 * This class encapsulates the content of a review related to a place.
44 class EXPORT_API ReviewContent : public BaseContent
49 * This method is the default constructor.
54 * This method is the copy constructor.
56 * @param rRhs An object whose contents are to be copied to the instance
59 ReviewContent(const ReviewContent& rRhs);
62 * This method is the (virtual) destructor.
64 virtual ~ReviewContent();
67 * This is the assignment operator.
69 * @param rRhs An object whose contents are to be copied to the given
72 * @return A reference to the given instance of the class after its contents
75 ReviewContent& operator=(const ReviewContent& rRhs);
78 * This method retrieves the review date as a string.
80 * @return A string containing the date of the review.
82 String GetDateTime() const;
85 * This method retrieves the review title.
87 * @return A string containing the review title.
89 String GetTitle() const;
92 * This method retrieves the review rating.
94 * @return A double containing the retrieved value of rating.
96 double GetRating() const;
99 * This method retrieves the review description (text).
101 * @return A string containing the review
102 * description (text).
104 String GetDescription() const;
107 * This method retrieves a link to the website of the user, who submitted
110 * @return An object representing a link to the website of the user, who submitted
113 LinkObject GetUser() const;
116 * This method retrieves the BCP 47 identifier of the language used in the
119 * @return A string containing the identifier of the language used in the
122 String GetLanguage() const;
125 * This method sets the review date as a string.
127 * @param rDateTime A constant reference to a string containing the date of
130 void SetDateTime(const String &rDateTime);
133 * This method sets the review title.
135 * @param rTitle A constant reference to a string containing the review
138 void SetTitle(const String& rTitle);
141 * This method sets the review rating.
143 * @param dRating A double containing the retrieved value of rating.
145 void SetRating(double dRating);
148 * This method sets the review description (text).
150 * @param sText A constant reference to a string containing the review
151 * description (text).
153 void SetDescription(const String& sText);
156 * This method sets a link to the website of the user, who submitted
159 * @param cUser A constant reference to an object representing a link to the
160 * website of the user, who submitted the review.
162 void SetUser(const LinkObject& cUser);
165 * This method sets the BCP 47 identifier of the language used in the
168 * @param sLanguage A constant reference to a string containing the
169 * identifier of the language used in the review.
171 void SetLanguage(const String& sLanguage);
174 class ReviewContentImpl;
175 ReviewContentImpl* m_pImpl;
177 friend class JsonParser;
180 HERE_MAPS_END_NAMESPACE
182 #endif // REVIEW_CONTENT_H_