KeyedSummary (clover-android-sdk 293 API)

java.lang.Object
- com.clover.sdk.GenericParcelable
- - com.clover.sdk.v3.report.KeyedSummary

All Implemented Interfaces:

Parcelable, JSONifiable, Validator
```
public class KeyedSummary
extends GenericParcelable
implements Validator, JSONifiable
```
This is an auto-generated Clover data object.
An object containing all of the fields of a Summary plus one additional key (groupByString). This object is useful for mapping the result set of a SQL query which selects Summaries using a GROUP BY clause.

Fields

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface KeyedSummary.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`	`KeyedSummary.Constraints`

Field Summary

Fields
Modifier and Type Field and Description

static Parcelable.Creator<KeyedSummary> CREATOR

static JSONifiable.Creator<KeyedSummary> 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<KeyedSummary>`	`CREATOR`
`static JSONifiable.Creator<KeyedSummary>`	`JSON_CREATOR`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`KeyedSummary()` Constructs a new empty instance.
`protected`	`KeyedSummary(boolean noInit)` Constructs a new empty instance.
	`KeyedSummary(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.
	`KeyedSummary(KeyedSummary src)` Constructs a new instance that is a deep copy of the source instance.
	`KeyedSummary(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`	`clearAmount()` Clears the 'amount' field, the 'has' method for this field will now return false
`void`	`clearGroupByField()` Clears the 'groupByField' field, the 'has' method for this field will now return false
`void`	`clearNum()` Clears the 'num' field, the 'has' method for this field will now return false
`void`	`clearServiceChargeAmount()` Clears the 'serviceChargeAmount' field, the 'has' method for this field will now return false
`void`	`clearTaxAmount()` Clears the 'taxAmount' field, the 'has' method for this field will now return false
`void`	`clearTipAmount()` Clears the 'tipAmount' field, the 'has' method for this field will now return false
`boolean`	`containsChanges()` Returns true if this instance has any changes.
`KeyedSummary`	`copyChanges()` Create a copy of this instance that contains only fields that were set after the constructor was called.
`Long`	`getAmount()` Total amount
`protected GenericClient`	`getGenericClient()`
`String`	`getGroupByField()` Group by field
`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`	`getNum()` Number of rows
`Long`	`getServiceChargeAmount()` total service charge amount
`Long`	`getTaxAmount()` total tax amount
`Long`	`getTipAmount()` Total tip amount
`boolean`	`hasAmount()` Checks whether the 'amount' field has been set, however the value could be null
`boolean`	`hasGroupByField()` Checks whether the 'groupByField' field has been set, however the value could be null
`boolean`	`hasNum()` Checks whether the 'num' field has been set, however the value could be null
`boolean`	`hasServiceChargeAmount()` Checks whether the 'serviceChargeAmount' field has been set, however the value could be null
`boolean`	`hasTaxAmount()` Checks whether the 'taxAmount' field has been set, however the value could be null
`boolean`	`hasTipAmount()` Checks whether the 'tipAmount' field has been set, however the value could be null
`boolean`	`isNotNullAmount()` Checks whether the 'amount' field is set and is not null
`boolean`	`isNotNullGroupByField()` Checks whether the 'groupByField' field is set and is not null
`boolean`	`isNotNullNum()` Checks whether the 'num' field is set and is not null
`boolean`	`isNotNullServiceChargeAmount()` Checks whether the 'serviceChargeAmount' field is set and is not null
`boolean`	`isNotNullTaxAmount()` Checks whether the 'taxAmount' field is set and is not null
`boolean`	`isNotNullTipAmount()` Checks whether the 'tipAmount' field is set and is not null
`void`	`mergeChanges(KeyedSummary 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.
`KeyedSummary`	`setAmount(Long amount)` Sets the field 'amount'.
`KeyedSummary`	`setGroupByField(String groupByField)` Sets the field 'groupByField'.
`KeyedSummary`	`setNum(Long num)` Sets the field 'num'.
`KeyedSummary`	`setServiceChargeAmount(Long serviceChargeAmount)` Sets the field 'serviceChargeAmount'.
`KeyedSummary`	`setTaxAmount(Long taxAmount)` Sets the field 'taxAmount'.
`KeyedSummary`	`setTipAmount(Long tipAmount)` Sets the field 'tipAmount'.
`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<KeyedSummary> CREATOR
```
  - JSON_CREATOR
```
public static final JSONifiable.Creator<KeyedSummary> JSON_CREATOR
```
- Constructor Detail
  - KeyedSummary
```
public KeyedSummary()
```
    Constructs a new empty instance.
  - KeyedSummary
```
protected KeyedSummary(boolean noInit)
```
    Constructs a new empty instance.
  - KeyedSummary
```
public KeyedSummary(String json)
             throws IllegalArgumentException
```
    Constructs a new instance from the given JSON String.
    
    Throws:
    
    IllegalArgumentException
  - KeyedSummary
```
public KeyedSummary(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.
  - KeyedSummary
```
public KeyedSummary(KeyedSummary src)
```
    Constructs a new instance that is a deep copy of the source instance. It does not copy the bundle or changelog.
- Method Detail
  - getGroupByField
```
public String getGroupByField()
```
    Group by field
  - getNum
```
public Long getNum()
```
    Number of rows
  - getAmount
```
public Long getAmount()
```
    Total amount
  - getTipAmount
```
public Long getTipAmount()
```
    Total tip amount
  - getTaxAmount
```
public Long getTaxAmount()
```
    total tax amount
  - getServiceChargeAmount
```
public Long getServiceChargeAmount()
```
    total service charge amount
  - 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
  - isNotNullGroupByField
```
public boolean isNotNullGroupByField()
```
    Checks whether the 'groupByField' field is set and is not null
  - isNotNullNum
```
public boolean isNotNullNum()
```
    Checks whether the 'num' field is set and is not null
  - isNotNullAmount
```
public boolean isNotNullAmount()
```
    Checks whether the 'amount' field is set and is not null
  - isNotNullTipAmount
```
public boolean isNotNullTipAmount()
```
    Checks whether the 'tipAmount' field is set and is not null
  - isNotNullTaxAmount
```
public boolean isNotNullTaxAmount()
```
    Checks whether the 'taxAmount' field is set and is not null
  - isNotNullServiceChargeAmount
```
public boolean isNotNullServiceChargeAmount()
```
    Checks whether the 'serviceChargeAmount' field is set and is not null
  - hasGroupByField
```
public boolean hasGroupByField()
```
    Checks whether the 'groupByField' field has been set, however the value could be null
  - hasNum
```
public boolean hasNum()
```
    Checks whether the 'num' field has been set, however the value could be null
  - hasAmount
```
public boolean hasAmount()
```
    Checks whether the 'amount' field has been set, however the value could be null
  - hasTipAmount
```
public boolean hasTipAmount()
```
    Checks whether the 'tipAmount' field has been set, however the value could be null
  - hasTaxAmount
```
public boolean hasTaxAmount()
```
    Checks whether the 'taxAmount' field has been set, however the value could be null
  - hasServiceChargeAmount
```
public boolean hasServiceChargeAmount()
```
    Checks whether the 'serviceChargeAmount' field has been set, however the value could be null
  - setGroupByField
```
public KeyedSummary setGroupByField(String groupByField)
```
    Sets the field 'groupByField'.
  - setNum
```
public KeyedSummary setNum(Long num)
```
    Sets the field 'num'.
  - setAmount
```
public KeyedSummary setAmount(Long amount)
```
    Sets the field 'amount'.
  - setTipAmount
```
public KeyedSummary setTipAmount(Long tipAmount)
```
    Sets the field 'tipAmount'.
  - setTaxAmount
```
public KeyedSummary setTaxAmount(Long taxAmount)
```
    Sets the field 'taxAmount'.
  - setServiceChargeAmount
```
public KeyedSummary setServiceChargeAmount(Long serviceChargeAmount)
```
    Sets the field 'serviceChargeAmount'.
  - clearGroupByField
```
public void clearGroupByField()
```
    Clears the 'groupByField' field, the 'has' method for this field will now return false
  - clearNum
```
public void clearNum()
```
    Clears the 'num' field, the 'has' method for this field will now return false
  - clearAmount
```
public void clearAmount()
```
    Clears the 'amount' field, the 'has' method for this field will now return false
  - clearTipAmount
```
public void clearTipAmount()
```
    Clears the 'tipAmount' field, the 'has' method for this field will now return false
  - clearTaxAmount
```
public void clearTaxAmount()
```
    Clears the 'taxAmount' field, the 'has' method for this field will now return false
  - clearServiceChargeAmount
```
public void clearServiceChargeAmount()
```
    Clears the 'serviceChargeAmount' 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 KeyedSummary copyChanges()
```
    Create a copy of this instance that contains only fields that were set after the constructor was called.
  - mergeChanges
```
public void mergeChanges(KeyedSummary src)
```
    Copy all the changed fields from the given source to this instance.

Class KeyedSummary

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

KeyedSummary

KeyedSummary

KeyedSummary

KeyedSummary

KeyedSummary

Method Detail

getGroupByField

getNum

getAmount

getTipAmount

getTaxAmount

getServiceChargeAmount

getGenericClient

getJSONObject

validate

isNotNullGroupByField

isNotNullNum

isNotNullAmount

isNotNullTipAmount

isNotNullTaxAmount

isNotNullServiceChargeAmount

hasGroupByField

hasNum

hasAmount

hasTipAmount

hasTaxAmount

hasServiceChargeAmount

setGroupByField

setNum

setAmount

setTipAmount

setTaxAmount

setServiceChargeAmount

clearGroupByField

clearNum

clearAmount

clearTipAmount

clearTaxAmount

clearServiceChargeAmount

containsChanges

resetChangeLog

copyChanges

mergeChanges