Try our conversational search powered by Generative AI!

AI OnAI Off

Class IReturnOrderFormExtensions

NOTE: This is a pre-release API that is UNSTABLE and might not satisfy the compatibility requirements as denoted by its associated normal version.

Extensions for IReturnOrderForm.

Inheritance
System.Object
IReturnOrderFormExtensions
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: EPiServer.Commerce.Order
Assembly: EPiServer.Business.Commerce.dll
Version: 12.17.2
Syntax
public static class IReturnOrderFormExtensions

Methods

CanCreateExchangeOrder(IReturnOrderForm)

Checks whether it can create an exchange order from a IReturnOrderForm.

Declaration
public static bool CanCreateExchangeOrder(this IReturnOrderForm returnForm)
Parameters
Type Name Description
IReturnOrderForm returnForm

The return order form.
Returns
Type Description
System.Boolean

GetAllReturnLineItems(IReturnOrderForm)

Gets all line items for the IReturnOrderForm.

Declaration
public static IEnumerable<IReturnLineItem> GetAllReturnLineItems(this IReturnOrderForm returnForm)
Parameters
Type Name Description
IReturnOrderForm returnForm

The return order form.
Returns
Type Description
System.Collections.Generic.IEnumerable<IReturnLineItem>

An System.Collections.Generic.IEnumerable<T>.

GetTotal(IReturnOrderForm, IMarket, Currency)

Gets the total for the return order form.

Declaration
public static Money GetTotal(this IReturnOrderForm returnOrderForm, IMarket market, Currency currency)
Parameters
Type Name Description
IReturnOrderForm returnOrderForm

The return order form.
IMarket market

The market to be used in the calculation.
Currency currency

The currency to be used in the calculation.
Returns
Type Description
Money

The total for the return order form.

GetTotal(IReturnOrderForm, IMarket, Currency, IReturnOrderFormCalculator)

Gets the total for the return order form.

Declaration
public static Money GetTotal(this IReturnOrderForm returnOrderForm, IMarket market, Currency currency, IReturnOrderFormCalculator returnOrderFormCalculator)
Parameters
Type Name Description
IReturnOrderForm returnOrderForm

The return order form.
IMarket market

The market to be used in the calculation.
Currency currency

The currency to be used in the calculation.
IReturnOrderFormCalculator returnOrderFormCalculator

The return order form calculator.
Returns
Type Description
Money

The total for the return order form.

IsAwaitingCompletion(IReturnOrderForm)

Checks whether a IReturnOrderForm is awaiting completion.

Declaration
public static bool IsAwaitingCompletion(this IReturnOrderForm returnForm)
Parameters
Type Name Description
IReturnOrderForm returnForm

The return order form.
Returns
Type Description
System.Boolean

IsAwaitingStockReturn(IReturnOrderForm)

Checks whether a IReturnOrderForm is awaiting stock return.

Declaration
public static bool IsAwaitingStockReturn(this IReturnOrderForm returnForm)
Parameters
Type Name Description
IReturnOrderForm returnForm

The return order form.
Returns
Type Description
System.Boolean

IsCancellable(IReturnOrderForm)

Checks whether a IReturnOrderForm is cancellable.

Declaration
public static bool IsCancellable(this IReturnOrderForm returnForm)
Parameters
Type Name Description
IReturnOrderForm returnForm

The return order form.
Returns
Type Description
System.Boolean

IsEditable(IReturnOrderForm)

Checks whether a IReturnOrderForm is editable.

Declaration
public static bool IsEditable(this IReturnOrderForm returnForm)
Parameters
Type Name Description
IReturnOrderForm returnForm

The return order form.
Returns
Type Description
System.Boolean