Package com.broadleafcommerce.order.web.endpoint.domain

Class ReadCustomerOrdersRequest

java.lang.Object
com.broadleafcommerce.order.web.endpoint.domain.ReadCustomerOrdersRequest
All Implemented Interfaces:
Serializable
public class ReadCustomerOrdersRequest extends Object implements Serializable
The request to read the customer Orders and its related data.
Author:
Dima Myroniuk (dmyroniuk)
See Also:

  • Constructor Details

    • ReadCustomerOrdersRequest

      public ReadCustomerOrdersRequest()

  • Method Details

    • addAttribute

      public void addAttribute(String name, Object value)

    • getAttribute

      public Map<String,Object> getAttribute()

    • getCustomerId

      @Nullable public String getCustomerId()
      The customer id to read the Orders.

    • getAccountId

      @Nullable public String getAccountId()
      The account id to read the Orders.

      This parameter is used only if the customerId is not null.

    • getCustomerEmail

      @Nullable public String getCustomerEmail()
      Read the Orders with the specified Order.getEmailAddress() excluding the orders with non-null customerId

      This parameter is used only if the customerId is null.

    • isFetchOrderFulfillments

      public boolean isFetchOrderFulfillments()
      If this value is true the CustomerOrderInfo.getFulfillments() will be populated with the associated OrderFulfillment. Defaults to true.

    • isFetchOrderFulfillmentItems

      public boolean isFetchOrderFulfillmentItems()
      If this value is true the order fulfillments will be fetched with the items. Defaults to false.

    • getJsonMap

      public Map<String,Object> getJsonMap()
      JSON data which isn't already stored in other fields.
      Returns:
      JSON object data

    • setCustomerId

      public void setCustomerId(@Nullable String customerId)
      The customer id to read the Orders.

    • setAccountId

      public void setAccountId(@Nullable String accountId)
      The account id to read the Orders.

      This parameter is used only if the customerId is not null.

    • setCustomerEmail

      public void setCustomerEmail(@Nullable String customerEmail)
      Read the Orders with the specified Order.getEmailAddress() excluding the orders with non-null customerId

      This parameter is used only if the customerId is null.

    • setFetchOrderFulfillments

      public void setFetchOrderFulfillments(boolean fetchOrderFulfillments)
      If this value is true the CustomerOrderInfo.getFulfillments() will be populated with the associated OrderFulfillment. Defaults to true.

    • setFetchOrderFulfillmentItems

      public void setFetchOrderFulfillmentItems(boolean fetchOrderFulfillmentItems)
      If this value is true the order fulfillments will be fetched with the items. Defaults to false.

    • setJsonMap

      public void setJsonMap(Map<String,Object> jsonMap)
      JSON data which isn't already stored in other fields.
      Parameters:
      jsonMap - JSON object data