Package com.clover.sdk.v3.report
Class LabelSummarySection
- java.lang.Object
-
- com.clover.sdk.GenericParcelable
-
- com.clover.sdk.v3.report.LabelSummarySection
-
- All Implemented Interfaces:
Parcelable
,JSONifiable
,Validator
public class LabelSummarySection extends GenericParcelable implements Validator, JSONifiable
This is an auto-generated Clover data object.Summary of sales of items that have a label which has the 'Show in Reporting?' flag set
Fields
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
LabelSummarySection.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<LabelSummarySection>
CREATOR
static JSONifiable.Creator<LabelSummarySection>
JSON_CREATOR
-
Fields inherited from interface android.os.Parcelable
CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE
-
-
Constructor Summary
Constructors Modifier Constructor Description LabelSummarySection()
Constructs a new empty instance.protected
LabelSummarySection(boolean noInit)
Constructs a new empty instance.LabelSummarySection(LabelSummarySection src)
Constructs a new instance that is a deep copy of the source instance.LabelSummarySection(String json)
Constructs a new instance from the given JSON String.LabelSummarySection(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 falsevoid
clearWarnings()
Clears the 'warnings' field, the 'has' method for this field will now return falseboolean
containsChanges()
Returns true if this instance has any changes.LabelSummarySection
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()
Whether the merchant has any labels marked 'Show in Reporting?'List<LabelSummaryRow>
getRows()
Summary of sales of items that have a label which has the 'Show in Reporting?' flag setLabelSummaryRow
getTotal()
The sum of the above rowsList<String>
getWarnings()
List of warnings related to the items in this section, like perhaps an item appears under more than one label.boolean
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
hasWarnings()
Checks whether the 'warnings' 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
isNotEmptyWarnings()
Checks whether the 'warnings' 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 nullboolean
isNotNullWarnings()
Checks whether the 'warnings' field is set and is not nullvoid
mergeChanges(LabelSummarySection 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.LabelSummarySection
setMajorLabelsExist(Boolean majorLabelsExist)
Sets the field 'majorLabelsExist'.LabelSummarySection
setRows(List<LabelSummaryRow> rows)
Sets the field 'rows'.LabelSummarySection
setTotal(LabelSummaryRow total)
Sets the field 'total'.LabelSummarySection
setWarnings(List<String> warnings)
Sets the field 'warnings'.void
validate()
-
Methods inherited from class com.clover.sdk.GenericParcelable
describeContents, getBundle, toString, writeToParcel
-
-
-
-
Field Detail
-
CREATOR
public static final Parcelable.Creator<LabelSummarySection> CREATOR
-
JSON_CREATOR
public static final JSONifiable.Creator<LabelSummarySection> JSON_CREATOR
-
-
Constructor Detail
-
LabelSummarySection
public LabelSummarySection()
Constructs a new empty instance.
-
LabelSummarySection
protected LabelSummarySection(boolean noInit)
Constructs a new empty instance.
-
LabelSummarySection
public LabelSummarySection(String json) throws IllegalArgumentException
Constructs a new instance from the given JSON String.- Throws:
IllegalArgumentException
-
LabelSummarySection
public LabelSummarySection(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.
-
LabelSummarySection
public LabelSummarySection(LabelSummarySection 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<LabelSummaryRow> getRows()
Summary of sales of items that have a label which has the 'Show in Reporting?' flag set
-
getWarnings
public List<String> getWarnings()
List of warnings related to the items in this section, like perhaps an item appears under more than one label.
-
getTotal
public LabelSummaryRow getTotal()
The sum of the above rows
-
getMajorLabelsExist
public Boolean getMajorLabelsExist()
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
-
isNotNullWarnings
public boolean isNotNullWarnings()
Checks whether the 'warnings' field is set and is not null
-
isNotEmptyWarnings
public boolean isNotEmptyWarnings()
Checks whether the 'warnings' 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
-
hasWarnings
public boolean hasWarnings()
Checks whether the 'warnings' 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 LabelSummarySection setRows(List<LabelSummaryRow> 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.
-
setWarnings
public LabelSummarySection setWarnings(List<String> warnings)
Sets the field 'warnings'. 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 LabelSummarySection setTotal(LabelSummaryRow 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 LabelSummarySection 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
-
clearWarnings
public void clearWarnings()
Clears the 'warnings' 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 LabelSummarySection copyChanges()
Create a copy of this instance that contains only fields that were set after the constructor was called.
-
mergeChanges
public void mergeChanges(LabelSummarySection src)
Copy all the changed fields from the given source to this instance.
-
-