Package com.clover.sdk.v3.report

Class SalesSummarySection

java.lang.Object

com.clover.sdk.GenericParcelable

com.clover.sdk.v3.report.SalesSummarySection

All Implemented Interfaces:

Parcelable, JSONifiable, Validator

public class SalesSummarySection
extends GenericParcelable
implements Validator, JSONifiable

This is an auto-generated Clover data object.

Combines a collection of rows with a total to form a section of sales summaries.

Fields

• rows
• total

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SalesSummarySection.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<SalesSummarySection>	CREATOR
static JSONifiable.Creator<SalesSummarySection>	JSON_CREATOR

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

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

Modifier and Type	Method	Description
void	clearRows()	Clears the 'rows' field, the 'has' method for this field will now return false
void	clearTotal()	Clears the 'total' field, the 'has' method for this field will now return false
boolean	containsChanges()	Returns true if this instance has any changes.
SalesSummarySection	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.
List<SalesSummary>	getRows()	The detail rows of a particular sales summary section
SalesSummary	getTotal()	The sum of the above rows
boolean	hasRows()	Checks whether the 'rows' field has been set, however the value could be null
boolean	hasTotal()	Checks whether the 'total' field has been set, however the value could be null
boolean	isNotEmptyRows()	Checks whether the 'rows' field is set and is not null and is not empty
boolean	isNotNullRows()	Checks whether the 'rows' field is set and is not null
boolean	isNotNullTotal()	Checks whether the 'total' field is set and is not null
void	mergeChanges(SalesSummarySection 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.
SalesSummarySection	setRows(List<SalesSummary> rows)	Sets the field 'rows'.
SalesSummarySection	setTotal(SalesSummary total)	Sets the field 'total'.
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<SalesSummarySection> CREATOR

JSON_CREATOR

public static final JSONifiable.Creator<SalesSummarySection> JSON_CREATOR

Constructor Detail

SalesSummarySection

public SalesSummarySection()

Constructs a new empty instance.

SalesSummarySection

protected SalesSummarySection(boolean noInit)

Constructs a new empty instance.

SalesSummarySection

public SalesSummarySection(String json)
                    throws IllegalArgumentException

Constructs a new instance from the given JSON String.

Throws:

IllegalArgumentException

SalesSummarySection

public SalesSummarySection(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.

SalesSummarySection

public SalesSummarySection(SalesSummarySection src)

Constructs a new instance that is a deep copy of the source instance. It does not copy the bundle or changelog.

Method Detail

getRows

public List<SalesSummary> getRows()

The detail rows of a particular sales summary section

getTotal

public SalesSummary getTotal()

The sum of the above rows

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

isNotNullRows

public boolean isNotNullRows()

Checks whether the 'rows' field is set and is not null

isNotEmptyRows

public boolean isNotEmptyRows()

Checks whether the 'rows' field is set and is not null and is not empty

isNotNullTotal

public boolean isNotNullTotal()

Checks whether the 'total' field is set and is not null

hasRows

public boolean hasRows()

Checks whether the 'rows' field has been set, however the value could be null

hasTotal

public boolean hasTotal()

Checks whether the 'total' field has been set, however the value could be null

setRows

public SalesSummarySection setRows(List<SalesSummary> rows)

Sets the field 'rows'. Nulls in the given List are skipped. List parameter is copied, so it will not reflect any changes, but objects inside it will.

setTotal

public SalesSummarySection setTotal(SalesSummary total)

Sets the field 'total'. The parameter is not copied so changes to it will be reflected in this instance and vice-versa.

clearRows

public void clearRows()

Clears the 'rows' field, the 'has' method for this field will now return false

clearTotal

public void clearTotal()

Clears the 'total' 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 SalesSummarySection copyChanges()

Create a copy of this instance that contains only fields that were set after the constructor was called.

mergeChanges

public void mergeChanges(SalesSummarySection src)

Copy all the changed fields from the given source to this instance.