Package com.clover.sdk.v3.report
Class SummarySection
- java.lang.Object
-
- com.clover.sdk.GenericParcelable
-
- com.clover.sdk.v3.report.SummarySection
-
- All Implemented Interfaces:
Parcelable
,JSONifiable
,Validator
public class SummarySection 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 in payments API's
Fields
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
SummarySection.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<SummarySection>
CREATOR
static JSONifiable.Creator<SummarySection>
JSON_CREATOR
-
Fields inherited from interface android.os.Parcelable
CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE
-
-
Constructor Summary
Constructors Modifier Constructor Description SummarySection()
Constructs a new empty instance.protected
SummarySection(boolean noInit)
Constructs a new empty instance.SummarySection(SummarySection src)
Constructs a new instance that is a deep copy of the source instance.SummarySection(String json)
Constructs a new instance from the given JSON String.SummarySection(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
clearMajorLabelsExist()
Clears the 'majorLabelsExist' field, the 'has' method for this field will now return falsevoid
clearRows()
Clears the 'rows' field, the 'has' method for this field will now return falsevoid
clearTotal()
Clears the 'total' field, the 'has' method for this field will now return falseboolean
containsChanges()
Returns true if this instance has any changes.SummarySection
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.Boolean
getMajorLabelsExist()
Optional flag used for revenue class to indicate whether the merchant has any labels marked 'Show in Reporting?'List<Summary>
getRows()
The detail rows of a particular section of a payments APISummary
getTotal()
The sum of the above rowsboolean
hasMajorLabelsExist()
Checks whether the 'majorLabelsExist' field has been set, however the value could be nullboolean
hasRows()
Checks whether the 'rows' field has been set, however the value could be nullboolean
hasTotal()
Checks whether the 'total' field has been set, however the value could be nullboolean
isNotEmptyRows()
Checks whether the 'rows' field is set and is not null and is not emptyboolean
isNotNullMajorLabelsExist()
Checks whether the 'majorLabelsExist' field is set and is not nullboolean
isNotNullRows()
Checks whether the 'rows' field is set and is not nullboolean
isNotNullTotal()
Checks whether the 'total' field is set and is not nullvoid
mergeChanges(SummarySection 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.SummarySection
setMajorLabelsExist(Boolean majorLabelsExist)
Sets the field 'majorLabelsExist'.SummarySection
setRows(List<Summary> rows)
Sets the field 'rows'.SummarySection
setTotal(Summary total)
Sets the field 'total'.void
validate()
-
Methods inherited from class com.clover.sdk.GenericParcelable
describeContents, getBundle, toString, writeToParcel
-
-
-
-
Field Detail
-
CREATOR
public static final Parcelable.Creator<SummarySection> CREATOR
-
JSON_CREATOR
public static final JSONifiable.Creator<SummarySection> JSON_CREATOR
-
-
Constructor Detail
-
SummarySection
public SummarySection()
Constructs a new empty instance.
-
SummarySection
protected SummarySection(boolean noInit)
Constructs a new empty instance.
-
SummarySection
public SummarySection(String json) throws IllegalArgumentException
Constructs a new instance from the given JSON String.- Throws:
IllegalArgumentException
-
SummarySection
public SummarySection(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.
-
SummarySection
public SummarySection(SummarySection src)
Constructs a new instance that is a deep copy of the source instance. It does not copy the bundle or changelog.
-
-
Method Detail
-
getTotal
public Summary getTotal()
The sum of the above rows
-
getMajorLabelsExist
public Boolean getMajorLabelsExist()
Optional flag used for revenue class to indicate whether the merchant has any labels marked 'Show in Reporting?'
-
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
-
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
-
isNotNullMajorLabelsExist
public boolean isNotNullMajorLabelsExist()
Checks whether the 'majorLabelsExist' 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
-
hasMajorLabelsExist
public boolean hasMajorLabelsExist()
Checks whether the 'majorLabelsExist' field has been set, however the value could be null
-
setRows
public SummarySection setRows(List<Summary> 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 SummarySection setTotal(Summary total)
Sets the field 'total'. The parameter is not copied so changes to it will be reflected in this instance and vice-versa.
-
setMajorLabelsExist
public SummarySection setMajorLabelsExist(Boolean majorLabelsExist)
Sets the field 'majorLabelsExist'.
-
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
-
clearMajorLabelsExist
public void clearMajorLabelsExist()
Clears the 'majorLabelsExist' 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 SummarySection copyChanges()
Create a copy of this instance that contains only fields that were set after the constructor was called.
-
mergeChanges
public void mergeChanges(SummarySection src)
Copy all the changed fields from the given source to this instance.
-
-