public class PaymentsAndNonRevenueGroupedOverTime extends GenericParcelable implements Validator, JSONifiable
Holds summaries of payments, credits, refunds and non-revenue item sales grouped by a configurable time period, like by hour.
Modifier and Type | Class and Description |
---|---|
static interface |
PaymentsAndNonRevenueGroupedOverTime.Constraints |
JSONifiable.Creator<T>
Parcelable.ClassLoaderCreator<T>, Parcelable.Creator<T>
Modifier and Type | Field and Description |
---|---|
static Parcelable.Creator<PaymentsAndNonRevenueGroupedOverTime> |
CREATOR |
static JSONifiable.Creator<PaymentsAndNonRevenueGroupedOverTime> |
JSON_CREATOR |
CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE
Modifier | Constructor and Description |
---|---|
|
PaymentsAndNonRevenueGroupedOverTime()
Constructs a new empty instance.
|
protected |
PaymentsAndNonRevenueGroupedOverTime(boolean noInit)
Constructs a new empty instance.
|
|
PaymentsAndNonRevenueGroupedOverTime(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.
|
|
PaymentsAndNonRevenueGroupedOverTime(PaymentsAndNonRevenueGroupedOverTime src)
Constructs a new instance that is a deep copy of the source instance.
|
|
PaymentsAndNonRevenueGroupedOverTime(String json)
Constructs a new instance from the given JSON String.
|
Modifier and Type | Method and Description |
---|---|
void |
clearAuthorizations()
Clears the 'authorizations' field, the 'has' method for this field will now return false
|
void |
clearCardTypesSection()
Clears the 'cardTypesSection' field, the 'has' method for this field will now return false
|
void |
clearCashDepositSection()
Clears the 'cashDepositSection' field, the 'has' method for this field will now return false
|
void |
clearCredits()
Clears the 'credits' field, the 'has' method for this field will now return false
|
void |
clearDeclinedOfflinePaymentsSection()
Clears the 'declinedOfflinePaymentsSection' field, the 'has' method for this field will now return false
|
void |
clearDiscounts()
Clears the 'discounts' field, the 'has' method for this field will now return false
|
void |
clearNonRevenue()
Clears the 'nonRevenue' field, the 'has' method for this field will now return false
|
void |
clearOpenOrders()
Clears the 'openOrders' field, the 'has' method for this field will now return false
|
void |
clearPayments()
Clears the 'payments' field, the 'has' method for this field will now return false
|
void |
clearPeriod()
Clears the 'period' field, the 'has' method for this field will now return false
|
void |
clearRefunds()
Clears the 'refunds' field, the 'has' method for this field will now return false
|
void |
clearRevenueClasses()
Clears the 'revenueClasses' field, the 'has' method for this field will now return false
|
void |
clearSalesSummaries()
Clears the 'salesSummaries' field, the 'has' method for this field will now return false
|
void |
clearTendersSection()
Clears the 'tendersSection' field, the 'has' method for this field will now return false
|
void |
clearTop5Category()
Clears the 'top5Category' field, the 'has' method for this field will now return false
|
void |
clearTop5Items()
Clears the 'top5Items' field, the 'has' method for this field will now return false
|
void |
clearTop5RevenueClasses()
Clears the 'top5RevenueClasses' field, the 'has' method for this field will now return false
|
boolean |
containsChanges()
Returns true if this instance has any changes.
|
PaymentsAndNonRevenueGroupedOverTime |
copyChanges()
Create a copy of this instance that contains only fields that were set after the constructor was called.
|
SummarySection |
getAuthorizations()
Summaries grouped over time of authorizations.
|
ReportPaymentsV2Section |
getCardTypesSection()
Summary of payments and refunds by card type.
|
DeviceCashSummaryRow |
getCashDepositSection()
Summary and further details on cash transactions
|
SummarySection |
getCredits()
Summaries grouped over time of credits, also known as manual or naked refunds.
|
ReportPaymentsV2Row |
getDeclinedOfflinePaymentsSection()
Summary of declined offline payments
|
SummarySection |
getDiscounts()
Summaries grouped over time of discounts.
|
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.
|
SummarySection |
getNonRevenue()
Summaries grouped over time of sales of items marked non-revenue including modifiers and discounts.
|
SummarySection |
getOpenOrders()
Summaries grouped over time of open orders.
|
SummarySection |
getPayments()
Summaries grouped over time of payments.
|
TimePeriod |
getPeriod()
The time period that defines the size of the groups: hour, day, week, month, ungrouped.
|
SummarySection |
getRefunds()
Summaries grouped over time of refunds.
|
LabelSummarySection |
getRevenueClasses()
Full report of revenue items sold based on revenue classes AKA labels summary.
|
SalesSummarySection |
getSalesSummaries()
Summaries grouped over time of Gross Sales, Net Sales, Amount Collected and the other figures that contribute to their calculation like total Taxes, Discounts, Refunds, Service Charges, Tips, Non-revenue Items and Gift Card Activations.
|
ReportPaymentsV2Section |
getTendersSection()
Summary of payments and refunds by tender.
|
SummarySection |
getTop5Category()
Summaries grouped by category, showing top 5 category of line items sold in terms of revenue.
|
SummarySection |
getTop5Items()
Summaries grouped over time showing top 5 line items in terms of revenue.
|
SummarySection |
getTop5RevenueClasses()
Summaries grouped by revenue class, AKA labels, showing top 5 revenue class of items sold in terms of revenue.
|
boolean |
hasAuthorizations()
Checks whether the 'authorizations' field has been set, however the value could be null
|
boolean |
hasCardTypesSection()
Checks whether the 'cardTypesSection' field has been set, however the value could be null
|
boolean |
hasCashDepositSection()
Checks whether the 'cashDepositSection' field has been set, however the value could be null
|
boolean |
hasCredits()
Checks whether the 'credits' field has been set, however the value could be null
|
boolean |
hasDeclinedOfflinePaymentsSection()
Checks whether the 'declinedOfflinePaymentsSection' field has been set, however the value could be null
|
boolean |
hasDiscounts()
Checks whether the 'discounts' field has been set, however the value could be null
|
boolean |
hasNonRevenue()
Checks whether the 'nonRevenue' field has been set, however the value could be null
|
boolean |
hasOpenOrders()
Checks whether the 'openOrders' field has been set, however the value could be null
|
boolean |
hasPayments()
Checks whether the 'payments' field has been set, however the value could be null
|
boolean |
hasPeriod()
Checks whether the 'period' field has been set, however the value could be null
|
boolean |
hasRefunds()
Checks whether the 'refunds' field has been set, however the value could be null
|
boolean |
hasRevenueClasses()
Checks whether the 'revenueClasses' field has been set, however the value could be null
|
boolean |
hasSalesSummaries()
Checks whether the 'salesSummaries' field has been set, however the value could be null
|
boolean |
hasTendersSection()
Checks whether the 'tendersSection' field has been set, however the value could be null
|
boolean |
hasTop5Category()
Checks whether the 'top5Category' field has been set, however the value could be null
|
boolean |
hasTop5Items()
Checks whether the 'top5Items' field has been set, however the value could be null
|
boolean |
hasTop5RevenueClasses()
Checks whether the 'top5RevenueClasses' field has been set, however the value could be null
|
boolean |
isNotNullAuthorizations()
Checks whether the 'authorizations' field is set and is not null
|
boolean |
isNotNullCardTypesSection()
Checks whether the 'cardTypesSection' field is set and is not null
|
boolean |
isNotNullCashDepositSection()
Checks whether the 'cashDepositSection' field is set and is not null
|
boolean |
isNotNullCredits()
Checks whether the 'credits' field is set and is not null
|
boolean |
isNotNullDeclinedOfflinePaymentsSection()
Checks whether the 'declinedOfflinePaymentsSection' field is set and is not null
|
boolean |
isNotNullDiscounts()
Checks whether the 'discounts' field is set and is not null
|
boolean |
isNotNullNonRevenue()
Checks whether the 'nonRevenue' field is set and is not null
|
boolean |
isNotNullOpenOrders()
Checks whether the 'openOrders' field is set and is not null
|
boolean |
isNotNullPayments()
Checks whether the 'payments' field is set and is not null
|
boolean |
isNotNullPeriod()
Checks whether the 'period' field is set and is not null
|
boolean |
isNotNullRefunds()
Checks whether the 'refunds' field is set and is not null
|
boolean |
isNotNullRevenueClasses()
Checks whether the 'revenueClasses' field is set and is not null
|
boolean |
isNotNullSalesSummaries()
Checks whether the 'salesSummaries' field is set and is not null
|
boolean |
isNotNullTendersSection()
Checks whether the 'tendersSection' field is set and is not null
|
boolean |
isNotNullTop5Category()
Checks whether the 'top5Category' field is set and is not null
|
boolean |
isNotNullTop5Items()
Checks whether the 'top5Items' field is set and is not null
|
boolean |
isNotNullTop5RevenueClasses()
Checks whether the 'top5RevenueClasses' field is set and is not null
|
void |
mergeChanges(PaymentsAndNonRevenueGroupedOverTime 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.
|
PaymentsAndNonRevenueGroupedOverTime |
setAuthorizations(SummarySection authorizations)
Sets the field 'authorizations'.
|
PaymentsAndNonRevenueGroupedOverTime |
setCardTypesSection(ReportPaymentsV2Section cardTypesSection)
Sets the field 'cardTypesSection'.
|
PaymentsAndNonRevenueGroupedOverTime |
setCashDepositSection(DeviceCashSummaryRow cashDepositSection)
Sets the field 'cashDepositSection'.
|
PaymentsAndNonRevenueGroupedOverTime |
setCredits(SummarySection credits)
Sets the field 'credits'.
|
PaymentsAndNonRevenueGroupedOverTime |
setDeclinedOfflinePaymentsSection(ReportPaymentsV2Row declinedOfflinePaymentsSection)
Sets the field 'declinedOfflinePaymentsSection'.
|
PaymentsAndNonRevenueGroupedOverTime |
setDiscounts(SummarySection discounts)
Sets the field 'discounts'.
|
PaymentsAndNonRevenueGroupedOverTime |
setNonRevenue(SummarySection nonRevenue)
Sets the field 'nonRevenue'.
|
PaymentsAndNonRevenueGroupedOverTime |
setOpenOrders(SummarySection openOrders)
Sets the field 'openOrders'.
|
PaymentsAndNonRevenueGroupedOverTime |
setPayments(SummarySection payments)
Sets the field 'payments'.
|
PaymentsAndNonRevenueGroupedOverTime |
setPeriod(TimePeriod period)
Sets the field 'period'.
|
PaymentsAndNonRevenueGroupedOverTime |
setRefunds(SummarySection refunds)
Sets the field 'refunds'.
|
PaymentsAndNonRevenueGroupedOverTime |
setRevenueClasses(LabelSummarySection revenueClasses)
Sets the field 'revenueClasses'.
|
PaymentsAndNonRevenueGroupedOverTime |
setSalesSummaries(SalesSummarySection salesSummaries)
Sets the field 'salesSummaries'.
|
PaymentsAndNonRevenueGroupedOverTime |
setTendersSection(ReportPaymentsV2Section tendersSection)
Sets the field 'tendersSection'.
|
PaymentsAndNonRevenueGroupedOverTime |
setTop5Category(SummarySection top5Category)
Sets the field 'top5Category'.
|
PaymentsAndNonRevenueGroupedOverTime |
setTop5Items(SummarySection top5Items)
Sets the field 'top5Items'.
|
PaymentsAndNonRevenueGroupedOverTime |
setTop5RevenueClasses(SummarySection top5RevenueClasses)
Sets the field 'top5RevenueClasses'.
|
void |
validate() |
describeContents, getBundle, toString, writeToParcel
public static final Parcelable.Creator<PaymentsAndNonRevenueGroupedOverTime> CREATOR
public static final JSONifiable.Creator<PaymentsAndNonRevenueGroupedOverTime> JSON_CREATOR
public PaymentsAndNonRevenueGroupedOverTime()
protected PaymentsAndNonRevenueGroupedOverTime(boolean noInit)
public PaymentsAndNonRevenueGroupedOverTime(String json) throws IllegalArgumentException
IllegalArgumentException
public PaymentsAndNonRevenueGroupedOverTime(JSONObject jsonObject)
public PaymentsAndNonRevenueGroupedOverTime(PaymentsAndNonRevenueGroupedOverTime src)
public SalesSummarySection getSalesSummaries()
public SummarySection getPayments()
public SummarySection getNonRevenue()
public SummarySection getCredits()
public SummarySection getRefunds()
public SummarySection getAuthorizations()
public SummarySection getDiscounts()
public SummarySection getOpenOrders()
public SummarySection getTop5Items()
public SummarySection getTop5Category()
public SummarySection getTop5RevenueClasses()
public TimePeriod getPeriod()
public ReportPaymentsV2Section getTendersSection()
public LabelSummarySection getRevenueClasses()
public ReportPaymentsV2Section getCardTypesSection()
public DeviceCashSummaryRow getCashDepositSection()
public ReportPaymentsV2Row getDeclinedOfflinePaymentsSection()
protected GenericClient getGenericClient()
getGenericClient
in class GenericParcelable
public JSONObject getJSONObject()
getJSONObject
in interface JSONifiable
public boolean isNotNullSalesSummaries()
public boolean isNotNullPayments()
public boolean isNotNullNonRevenue()
public boolean isNotNullCredits()
public boolean isNotNullRefunds()
public boolean isNotNullAuthorizations()
public boolean isNotNullDiscounts()
public boolean isNotNullOpenOrders()
public boolean isNotNullTop5Items()
public boolean isNotNullTop5Category()
public boolean isNotNullTop5RevenueClasses()
public boolean isNotNullPeriod()
public boolean isNotNullTendersSection()
public boolean isNotNullRevenueClasses()
public boolean isNotNullCardTypesSection()
public boolean isNotNullCashDepositSection()
public boolean isNotNullDeclinedOfflinePaymentsSection()
public boolean hasSalesSummaries()
public boolean hasPayments()
public boolean hasNonRevenue()
public boolean hasCredits()
public boolean hasRefunds()
public boolean hasAuthorizations()
public boolean hasDiscounts()
public boolean hasOpenOrders()
public boolean hasTop5Items()
public boolean hasTop5Category()
public boolean hasTop5RevenueClasses()
public boolean hasPeriod()
public boolean hasTendersSection()
public boolean hasRevenueClasses()
public boolean hasCardTypesSection()
public boolean hasCashDepositSection()
public boolean hasDeclinedOfflinePaymentsSection()
public PaymentsAndNonRevenueGroupedOverTime setSalesSummaries(SalesSummarySection salesSummaries)
public PaymentsAndNonRevenueGroupedOverTime setPayments(SummarySection payments)
public PaymentsAndNonRevenueGroupedOverTime setNonRevenue(SummarySection nonRevenue)
public PaymentsAndNonRevenueGroupedOverTime setCredits(SummarySection credits)
public PaymentsAndNonRevenueGroupedOverTime setRefunds(SummarySection refunds)
public PaymentsAndNonRevenueGroupedOverTime setAuthorizations(SummarySection authorizations)
public PaymentsAndNonRevenueGroupedOverTime setDiscounts(SummarySection discounts)
public PaymentsAndNonRevenueGroupedOverTime setOpenOrders(SummarySection openOrders)
public PaymentsAndNonRevenueGroupedOverTime setTop5Items(SummarySection top5Items)
public PaymentsAndNonRevenueGroupedOverTime setTop5Category(SummarySection top5Category)
public PaymentsAndNonRevenueGroupedOverTime setTop5RevenueClasses(SummarySection top5RevenueClasses)
public PaymentsAndNonRevenueGroupedOverTime setPeriod(TimePeriod period)
public PaymentsAndNonRevenueGroupedOverTime setTendersSection(ReportPaymentsV2Section tendersSection)
public PaymentsAndNonRevenueGroupedOverTime setRevenueClasses(LabelSummarySection revenueClasses)
public PaymentsAndNonRevenueGroupedOverTime setCardTypesSection(ReportPaymentsV2Section cardTypesSection)
public PaymentsAndNonRevenueGroupedOverTime setCashDepositSection(DeviceCashSummaryRow cashDepositSection)
public PaymentsAndNonRevenueGroupedOverTime setDeclinedOfflinePaymentsSection(ReportPaymentsV2Row declinedOfflinePaymentsSection)
public void clearSalesSummaries()
public void clearPayments()
public void clearNonRevenue()
public void clearCredits()
public void clearRefunds()
public void clearAuthorizations()
public void clearDiscounts()
public void clearOpenOrders()
public void clearTop5Items()
public void clearTop5Category()
public void clearTop5RevenueClasses()
public void clearPeriod()
public void clearTendersSection()
public void clearRevenueClasses()
public void clearCardTypesSection()
public void clearCashDepositSection()
public void clearDeclinedOfflinePaymentsSection()
public boolean containsChanges()
public void resetChangeLog()
public PaymentsAndNonRevenueGroupedOverTime copyChanges()
public void mergeChanges(PaymentsAndNonRevenueGroupedOverTime src)