Class GetTotalsRequest


  • public class GetTotalsRequest
    extends Object
    It conveys information from the Sale System related to the scope and the format of the totals to be computed by the POI System. Content of the Get Totals Request message.
    • Constructor Detail

      • GetTotalsRequest

        public GetTotalsRequest()
    • Method Detail

      • totalDetails

        public GetTotalsRequest totalDetails​(List<GetTotalsRequest.TotalDetailsEnum> totalDetails)
        Indicates the hierarchical structure of the reconciliation result of the Sale to POI reconciliation. Required to present totals per value of element included in this cluster (POI Terminal, Sale Terminal, Cashier, Shift, TotalsGroupID). Possible values: * **OperatorID** * **POIID** * **SaleID** * **ShiftNumber** * **TotalsGroupID**
        Parameters:
        totalDetails - Indicates the hierarchical structure of the reconciliation result of the Sale to POI reconciliation. Required to present totals per value of element included in this cluster (POI Terminal, Sale Terminal, Cashier, Shift, TotalsGroupID). Possible values: * **OperatorID** * **POIID** * **SaleID** * **ShiftNumber** * **TotalsGroupID**
        Returns:
        the current GetTotalsRequest instance, allowing for method chaining
      • getTotalDetails

        public List<GetTotalsRequest.TotalDetailsEnum> getTotalDetails()
        Indicates the hierarchical structure of the reconciliation result of the Sale to POI reconciliation. Required to present totals per value of element included in this cluster (POI Terminal, Sale Terminal, Cashier, Shift, TotalsGroupID). Possible values: * **OperatorID** * **POIID** * **SaleID** * **ShiftNumber** * **TotalsGroupID**
        Returns:
        totalDetails Indicates the hierarchical structure of the reconciliation result of the Sale to POI reconciliation. Required to present totals per value of element included in this cluster (POI Terminal, Sale Terminal, Cashier, Shift, TotalsGroupID). Possible values: * **OperatorID** * **POIID** * **SaleID** * **ShiftNumber** * **TotalsGroupID**
      • setTotalDetails

        public void setTotalDetails​(List<GetTotalsRequest.TotalDetailsEnum> totalDetails)
        Indicates the hierarchical structure of the reconciliation result of the Sale to POI reconciliation. Required to present totals per value of element included in this cluster (POI Terminal, Sale Terminal, Cashier, Shift, TotalsGroupID). Possible values: * **OperatorID** * **POIID** * **SaleID** * **ShiftNumber** * **TotalsGroupID**
        Parameters:
        totalDetails - Indicates the hierarchical structure of the reconciliation result of the Sale to POI reconciliation. Required to present totals per value of element included in this cluster (POI Terminal, Sale Terminal, Cashier, Shift, TotalsGroupID). Possible values: * **OperatorID** * **POIID** * **SaleID** * **ShiftNumber** * **TotalsGroupID**
      • totalFilter

        public GetTotalsRequest totalFilter​(TotalFilter totalFilter)
        totalFilter
        Parameters:
        totalFilter -
        Returns:
        the current GetTotalsRequest instance, allowing for method chaining
      • getTotalFilter

        public TotalFilter getTotalFilter()
        Get totalFilter
        Returns:
        totalFilter
      • setTotalFilter

        public void setTotalFilter​(TotalFilter totalFilter)
        totalFilter
        Parameters:
        totalFilter -
      • includeNullValues

        public GetTotalsRequest includeNullValues​(boolean includeNullValues)
        Configures whether null values are explicitly serialized in the JSON payload. Default is false.
      • isIncludeNullValues

        public boolean isIncludeNullValues()
        Returns whether null values are explicitly serialized in the JSON payload.
      • setIncludeNullValues

        public void setIncludeNullValues​(boolean includeNullValues)
        Sets whether null values should be explicitly serialized in the JSON payload. Default is false.
      • equals

        public boolean equals​(Object o)
        Return true if this GetTotalsRequest object is equal to o.
        Overrides:
        equals in class Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object
      • getExplicitNulls

        public Map<String,​Object> getExplicitNulls()
        Returns a map of properties to be merged into the JSON payload as explicit null values.
      • fromJson

        public static GetTotalsRequest fromJson​(String jsonString)
                                         throws com.fasterxml.jackson.core.JsonProcessingException
        Create an instance of GetTotalsRequest given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of GetTotalsRequest
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to GetTotalsRequest
      • toJson

        public String toJson()
                      throws com.fasterxml.jackson.core.JsonProcessingException
        Convert an instance of GetTotalsRequest to an JSON string
        Returns:
        JSON string
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException