Class OrderReturnInfo
- Namespace
- Dynamicweb.Ecommerce.Orders
- Assembly
- Dynamicweb.Ecommerce.dll
Represents return information about order.
[Serializable]
public class OrderReturnInfo
- Inheritance
-
OrderReturnInfo
- Inherited Members
Constructors
OrderReturnInfo(OrderReturnOperationState, string, double)
Initializes a new instance of the OrderReturnInfo class.
public OrderReturnInfo(OrderReturnOperationState state, string message, double amount)
Parameters
state
OrderReturnOperationState- The return state.
message
string- The message.
amount
double- The amount to return.
OrderReturnInfo(OrderReturnOperationState, string, double, Guid)
Initializes a new instance of the OrderReturnInfo class.
public OrderReturnInfo(OrderReturnOperationState state, string message, double amount, Guid operationId)
Parameters
state
OrderReturnOperationState- The return state.
message
string- The message.
amount
double- The amount to return.
operationId
Guid- The ID of return operation.
Properties
Amount
Gets or sets the return amount.
public double Amount { get; set; }
Property Value
- double
- The return amount.
Id
Gets or sets the return operation ID.
public Guid Id { get; set; }
Property Value
Message
Gets or sets the message.
public string Message { get; set; }
Property Value
- string
- The message.
ReturnTime
Gets or sets the return time.
public DateTime ReturnTime { get; set; }
Property Value
- DateTime
- The return time.
State
Gets or sets the state.
public OrderReturnOperationState State { get; set; }
Property Value
- OrderReturnOperationState
- The state.
Methods
CheckIfOrderReturned(Order, ref double)
Checks if order is fully returned and calculate remaining amout to return
public static bool CheckIfOrderReturned(Order order, ref double amount)
Parameters
Returns
SaveReturnOperation(OrderReturnOperationState, string, double, Order)
Adds new operation to order and saves the order instance
public static void SaveReturnOperation(OrderReturnOperationState state, string message, double amount, Order order)
Parameters
state
OrderReturnOperationState- The return state.
message
string- The message.
amount
double- The amount to return.
order
Order- The order to return.
SaveReturnOperation(OrderReturnOperationState, string, double, Order, Guid)
Adds new operation to order and saves the order instance
public static void SaveReturnOperation(OrderReturnOperationState state, string message, double amount, Order order, Guid operationId)
Parameters
state
OrderReturnOperationState- The return state.
message
string- The message.
amount
double- The amount to return.
order
Order- The order to return.
operationId
Guid- The ID of return operation.