AggregateRating (clover-android-sdk 293 API)

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 and 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>, Parcelable.Creator<T>

Nested Classes
Modifier and Type	Class and Description
`static interface`	`AggregateRating.Constraints`

Field Summary

Fields
Modifier and Type Field and 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

Fields
Modifier and Type	Field and Description
`static Parcelable.Creator<AggregateRating>`	`CREATOR`
`static JSONifiable.Creator<AggregateRating>`	`JSON_CREATOR`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`AggregateRating()` Constructs a new empty instance.
	`AggregateRating(AggregateRating src)` Constructs a new instance that is a deep copy of the source instance.
`protected`	`AggregateRating(boolean noInit)` Constructs a new empty instance.
	`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(String json)` Constructs a new instance from the given JSON String.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clearReviewCount()` Clears the 'reviewCount' field, the 'has' method for this field will now return false
`void`	`clearTotalStars()` Clears the 'totalStars' field, the 'has' method for this field will now return false
`void`	`clearWeightedRating()` Clears the 'weightedRating' field, the 'has' method for this field will now return false
`boolean`	`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 app
`Long`	`getTotalStars()` Sum of the number of stars this app has received for all of its reviews
`Double`	`getWeightedRating()` Weighted Rating for this App
`boolean`	`hasReviewCount()` Checks whether the 'reviewCount' field has been set, however the value could be null
`boolean`	`hasTotalStars()` Checks whether the 'totalStars' field has been set, however the value could be null
`boolean`	`hasWeightedRating()` Checks whether the 'weightedRating' field has been set, however the value could be null
`boolean`	`isNotNullReviewCount()` Checks whether the 'reviewCount' field is set and is not null
`boolean`	`isNotNullTotalStars()` Checks whether the 'totalStars' field is set and is not null
`boolean`	`isNotNullWeightedRating()` Checks whether the 'weightedRating' field is set and is not null
`void`	`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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- 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 class GenericParcelable
  - 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 interface JSONifiable
  - validate
```
public void validate()
```
    Specified by:
    
    validate in interface Validator
  - 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.

Class AggregateRating

Fields

Nested Class Summary

Nested classes/interfaces inherited from interface com.clover.sdk.JSONifiable

Nested classes/interfaces inherited from interface android.os.Parcelable

Field Summary

Fields inherited from interface android.os.Parcelable

Constructor Summary

Method Summary

Methods inherited from class com.clover.sdk.GenericParcelable

Methods inherited from class java.lang.Object

Field Detail

CREATOR

JSON_CREATOR

Constructor Detail

AggregateRating

AggregateRating

AggregateRating

AggregateRating

AggregateRating

Method Detail

getReviewCount

getTotalStars

getWeightedRating

getGenericClient

getJSONObject

validate

isNotNullReviewCount

isNotNullTotalStars

isNotNullWeightedRating

hasReviewCount

hasTotalStars

hasWeightedRating

setReviewCount

setTotalStars

setWeightedRating

clearReviewCount

clearTotalStars

clearWeightedRating

containsChanges

resetChangeLog

copyChanges

mergeChanges