Class OrderViewModelExtensions

Namespace

Dynamicweb.Ecommerce.Frontend

Assembly

Dynamicweb.Ecommerce.dll

Extensions for OrderViewModel providing helpers to filter and aggregate order lines.

public static class OrderViewModelExtensions

Inheritance

object

OrderViewModelExtensions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

All methods defensively handle null input and return an empty enumerable or 0 when the source data is unavailable.

Methods

GetBillingAddress(OrderViewModel)

Builds an AddressViewModel representing the customer's billing address based on the OrderViewModel.

public static AddressViewModel? GetBillingAddress(this OrderViewModel order)

Parameters

order OrderViewModel

The order view model. If null, null is returned.

Returns

AddressViewModel

A populated AddressViewModel for billing, or null if the order is null. The following fields are mapped:

• Address, Address2, Zip, City, Country, CountryCode, Company, State, Email, Phone, Name, HouseNumber

The AddressKind is set to Billing, and Active is set to true.

GetDeliveryAddress(OrderViewModel)

Builds an AddressViewModel representing the delivery/shipping address based on the OrderViewModel.

public static AddressViewModel? GetDeliveryAddress(this OrderViewModel order)

Parameters

order OrderViewModel

The order view model. If null, null is returned.

Returns

AddressViewModel

A populated AddressViewModel for delivery, or null if the order is null. The following fields are mapped:

• Address, Address2, Zip, City, Country, CountryCode, Company, State, Email, Phone, Name, HouseNumber

The AddressKind is set to Billing, and Active is set to true.

GetDiscountOrderLines(OrderViewModel)

Returns discount related order lines (Discount, ProductDiscount).

public static IEnumerable<OrderLineViewModel> GetDiscountOrderLines(this OrderViewModel order)

Parameters

order OrderViewModel

The order view model.

Returns

IEnumerable<OrderLineViewModel>

Enumerable of discount order lines or empty if unavailable.

GetOrderDiscounts(OrderViewModel)

Represents discounts applied at the order level. Returns order discount lines (Discount) that are not tied to a specific product or order line.

public static IEnumerable<OrderLineViewModel> GetOrderDiscounts(this OrderViewModel order)

Parameters

order OrderViewModel

The order view model.

Returns

IEnumerable<OrderLineViewModel>

Enumerable of order level discount lines or empty if unavailable.

GetOrderLineDiscounts(OrderViewModel)

Represents discounts applied to individual order lines/products. Returns discount lines (ProductDiscount) that are tied to a specific product line.

public static IEnumerable<OrderLineViewModel> GetOrderLineDiscounts(this OrderViewModel order)

Parameters

order OrderViewModel

The order view model.

Returns

IEnumerable<OrderLineViewModel>

Enumerable of product specific discount lines or empty if unavailable.

GetOrderLinesByTypes(OrderViewModel, IEnumerable<OrderLineType>)

Returns order lines matching any of the provided order line types.

public static IEnumerable<OrderLineViewModel> GetOrderLinesByTypes(this OrderViewModel order, IEnumerable<OrderLineType> orderLineTypes)

Parameters

order OrderViewModel

The order view model. If null an empty sequence is returned.

orderLineTypes IEnumerable<OrderLineType>

Collection of order line types to include. If null or empty an empty sequence is returned.

Returns

IEnumerable<OrderLineViewModel>

Enumerable of matching order lines, or empty if none / invalid input. Only lines with a non-null OrderLineType are evaluated.

GetProductOrderLines(OrderViewModel)

Returns product related order lines (Product, Fixed, GiftCard, PointProduct).

public static IEnumerable<OrderLineViewModel> GetProductOrderLines(this OrderViewModel order)

Parameters

order OrderViewModel

The order view model.

Returns

IEnumerable<OrderLineViewModel>

Enumerable of product order lines or empty if unavailable.

IsActiveCart(OrderViewModel)

Determines whether the specified order represents the currently active cart.

public static bool IsActiveCart(this OrderViewModel order)

Parameters

order OrderViewModel

The order view model.

Returns

bool

true if the order is the active cart; otherwise, false.

SumProductQuantities(OrderViewModel)

Calculates the total quantity of all order lines with type Product, Fixed, PointProduct or GiftCard.

public static double SumProductQuantities(this OrderViewModel order)

Parameters

order OrderViewModel

The order view model.

Returns

double

Total quantity across qualifying product lines, or 0 if input/order lines are null.

TryGetLedgerPaymentInfo(OrderViewModel, out LedgerPaymentInfoViewModel?)

Exposes the LedgerPaymentInfo of the OrderViewModel

public static bool TryGetLedgerPaymentInfo(this OrderViewModel order, out LedgerPaymentInfoViewModel? ledgerPaymentInfoViewModel)

Parameters

order OrderViewModel

The order view model

ledgerPaymentInfoViewModel LedgerPaymentInfoViewModel

The Ledger payment info view model

Returns

bool

true if a LedgerPaymentInfo was found using Id, false otherwise

TryGetOrderState(OrderViewModel, out OrderStateViewModel?)

Gets the order state information for the specified order.

public static bool TryGetOrderState(this OrderViewModel order, out OrderStateViewModel? state)

Parameters

order OrderViewModel

The order view model.

state OrderStateViewModel

The state view model.

Returns

bool

Order state view model or null if order or state ID is null.