Package com.clover.sdk.v3.apps
Class AggregateRating
- java.lang.Object
-
- com.clover.sdk.GenericParcelable
-
- com.clover.sdk.v3.apps.AggregateRating
-
- All Implemented Interfaces:
Parcelable
,JSONifiable
,Validator
public class AggregateRating extends GenericParcelable implements Validator, JSONifiable
This is an auto-generated Clover data object.Aggregate Ratings & Reviews information about a developer app. Clients can get the average rating of an app by dividing the total number of stars an app has received by the total number of times it has been reviewed.
Fields
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
AggregateRating.Constraints
-
Nested classes/interfaces inherited from interface com.clover.sdk.JSONifiable
JSONifiable.Creator<T>
-
Nested classes/interfaces inherited from interface android.os.Parcelable
Parcelable.ClassLoaderCreator<T extends Object>, Parcelable.Creator<T extends Object>
-
-
Field Summary
Fields Modifier and Type Field Description static Parcelable.Creator<AggregateRating>
CREATOR
static JSONifiable.Creator<AggregateRating>
JSON_CREATOR
-
Fields inherited from interface android.os.Parcelable
CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE
-
-
Constructor Summary
Constructors Modifier Constructor Description AggregateRating()
Constructs a new empty instance.protected
AggregateRating(boolean noInit)
Constructs a new empty instance.AggregateRating(AggregateRating src)
Constructs a new instance that is a deep copy of the source instance.AggregateRating(String json)
Constructs a new instance from the given JSON String.AggregateRating(JSONObject jsonObject)
Construct a new instance backed by the given JSONObject, the parameter is not copied so changes to it will be reflected in this instance and vice-versa.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
clearReviewCount()
Clears the 'reviewCount' field, the 'has' method for this field will now return falsevoid
clearTotalStars()
Clears the 'totalStars' field, the 'has' method for this field will now return falsevoid
clearWeightedRating()
Clears the 'weightedRating' field, the 'has' method for this field will now return falseboolean
containsChanges()
Returns true if this instance has any changes.AggregateRating
copyChanges()
Create a copy of this instance that contains only fields that were set after the constructor was called.protected GenericClient
getGenericClient()
JSONObject
getJSONObject()
Returns the internal JSONObject backing this instance, the return value is not a copy so changes to it will be reflected in this instance and vice-versa.Long
getReviewCount()
Total number of reviews that merchants have written about this appLong
getTotalStars()
Sum of the number of stars this app has received for all of its reviewsDouble
getWeightedRating()
Weighted Rating for this Appboolean
hasReviewCount()
Checks whether the 'reviewCount' field has been set, however the value could be nullboolean
hasTotalStars()
Checks whether the 'totalStars' field has been set, however the value could be nullboolean
hasWeightedRating()
Checks whether the 'weightedRating' field has been set, however the value could be nullboolean
isNotNullReviewCount()
Checks whether the 'reviewCount' field is set and is not nullboolean
isNotNullTotalStars()
Checks whether the 'totalStars' field is set and is not nullboolean
isNotNullWeightedRating()
Checks whether the 'weightedRating' field is set and is not nullvoid
mergeChanges(AggregateRating src)
Copy all the changed fields from the given source to this instance.void
resetChangeLog()
Reset the log of changes made to this instance, calling copyChanges() after this would return an empty instance.AggregateRating
setReviewCount(Long reviewCount)
Sets the field 'reviewCount'.AggregateRating
setTotalStars(Long totalStars)
Sets the field 'totalStars'.AggregateRating
setWeightedRating(Double weightedRating)
Sets the field 'weightedRating'.void
validate()
-
Methods inherited from class com.clover.sdk.GenericParcelable
describeContents, getBundle, toString, writeToParcel
-
-
-
-
Field Detail
-
CREATOR
public static final Parcelable.Creator<AggregateRating> CREATOR
-
JSON_CREATOR
public static final JSONifiable.Creator<AggregateRating> JSON_CREATOR
-
-
Constructor Detail
-
AggregateRating
public AggregateRating()
Constructs a new empty instance.
-
AggregateRating
protected AggregateRating(boolean noInit)
Constructs a new empty instance.
-
AggregateRating
public AggregateRating(String json) throws IllegalArgumentException
Constructs a new instance from the given JSON String.- Throws:
IllegalArgumentException
-
AggregateRating
public AggregateRating(JSONObject jsonObject)
Construct a new instance backed by the given JSONObject, the parameter is not copied so changes to it will be reflected in this instance and vice-versa.
-
AggregateRating
public AggregateRating(AggregateRating src)
Constructs a new instance that is a deep copy of the source instance. It does not copy the bundle or changelog.
-
-
Method Detail
-
getReviewCount
public Long getReviewCount()
Total number of reviews that merchants have written about this app
-
getTotalStars
public Long getTotalStars()
Sum of the number of stars this app has received for all of its reviews
-
getWeightedRating
public Double getWeightedRating()
Weighted Rating for this App
-
getGenericClient
protected GenericClient getGenericClient()
- Specified by:
getGenericClient
in classGenericParcelable
-
getJSONObject
public JSONObject getJSONObject()
Returns the internal JSONObject backing this instance, the return value is not a copy so changes to it will be reflected in this instance and vice-versa.- Specified by:
getJSONObject
in interfaceJSONifiable
-
isNotNullReviewCount
public boolean isNotNullReviewCount()
Checks whether the 'reviewCount' field is set and is not null
-
isNotNullTotalStars
public boolean isNotNullTotalStars()
Checks whether the 'totalStars' field is set and is not null
-
isNotNullWeightedRating
public boolean isNotNullWeightedRating()
Checks whether the 'weightedRating' field is set and is not null
-
hasReviewCount
public boolean hasReviewCount()
Checks whether the 'reviewCount' field has been set, however the value could be null
-
hasTotalStars
public boolean hasTotalStars()
Checks whether the 'totalStars' field has been set, however the value could be null
-
hasWeightedRating
public boolean hasWeightedRating()
Checks whether the 'weightedRating' field has been set, however the value could be null
-
setReviewCount
public AggregateRating setReviewCount(Long reviewCount)
Sets the field 'reviewCount'.
-
setTotalStars
public AggregateRating setTotalStars(Long totalStars)
Sets the field 'totalStars'.
-
setWeightedRating
public AggregateRating setWeightedRating(Double weightedRating)
Sets the field 'weightedRating'.
-
clearReviewCount
public void clearReviewCount()
Clears the 'reviewCount' field, the 'has' method for this field will now return false
-
clearTotalStars
public void clearTotalStars()
Clears the 'totalStars' field, the 'has' method for this field will now return false
-
clearWeightedRating
public void clearWeightedRating()
Clears the 'weightedRating' field, the 'has' method for this field will now return false
-
containsChanges
public boolean containsChanges()
Returns true if this instance has any changes.
-
resetChangeLog
public void resetChangeLog()
Reset the log of changes made to this instance, calling copyChanges() after this would return an empty instance.
-
copyChanges
public AggregateRating copyChanges()
Create a copy of this instance that contains only fields that were set after the constructor was called.
-
mergeChanges
public void mergeChanges(AggregateRating src)
Copy all the changed fields from the given source to this instance.
-
-