Don't miss out Virtual Happy Hour this Friday (April 26).

Try our conversational search powered by Generative AI!

AI OnAI Off

Class OrderStatusManager

OrderStatus manager acts as proxy between methods that call data layer functions and the facade layer. The methods here check whether the appropriate security is set and that the data is cached.

Inheritance
System.Object
OrderStatusManager
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: Mediachase.Commerce.Orders.Managers
Assembly: Mediachase.Commerce.dll
Version: 10.8.0
Syntax
public static class OrderStatusManager

Methods

CancelOrder(PaymentPlan)

Declaration
public static PaymentPlan CancelOrder(PaymentPlan plan)
Parameters
Type Name Description
PaymentPlan plan
Returns
Type Description
PaymentPlan

CancelOrder(PurchaseOrder)

Declaration
public static PurchaseOrder CancelOrder(PurchaseOrder purchaseOrder)
Parameters
Type Name Description
PurchaseOrder purchaseOrder
Returns
Type Description
PurchaseOrder

CancelOrderShipment(Shipment)

Declaration
public static Shipment CancelOrderShipment(Shipment shipment)
Parameters
Type Name Description
Shipment shipment
Returns
Type Description
Shipment

CompleteOrderShipment(Shipment)

Declaration
public static Shipment CompleteOrderShipment(Shipment shipment)
Parameters
Type Name Description
Shipment shipment
Returns
Type Description
Shipment

GetDefinedOrderStatuses()

Gets the order status.

Declaration
public static OrderStatusDto GetDefinedOrderStatuses()
Returns
Type Description
OrderStatusDto

GetOrderGroupStatus(IOrderGroup)

Gets OrderStatus of an order group.

Declaration
public static OrderStatus GetOrderGroupStatus(IOrderGroup orderGroup)
Parameters
Type Name Description
IOrderGroup orderGroup

The order group.
Returns
Type Description
OrderStatus

The order group status.

GetOrderGroupStatus(OrderGroup)

Gets the order group status.

Declaration
[Obsolete("This method is no longer used, use GetOrderGroupStatus(IOrderGroup) instead. Will remain at least until January 2018.")]
public static OrderStatus GetOrderGroupStatus(OrderGroup order)
Parameters
Type Name Description
OrderGroup order

The order.
Returns
Type Description
OrderStatus

GetOrderShipmentStatus(Shipment)

Gets the order shipment status.

Declaration
public static OrderShipmentStatus GetOrderShipmentStatus(Shipment shipment)
Parameters
Type Name Description
Shipment shipment

The shipment.
Returns
Type Description
OrderShipmentStatus

GetPurchaseOrderStatus(PaymentPlan)

Gets the purchase order status.

Declaration
public static OrderStatus GetPurchaseOrderStatus(PaymentPlan plan)
Parameters
Type Name Description
PaymentPlan plan

The plan.
Returns
Type Description
OrderStatus

GetPurchaseOrderStatus(PurchaseOrder)

Gets the purchase order status.

Declaration
public static OrderStatus GetPurchaseOrderStatus(PurchaseOrder purchaseOrder)
Parameters
Type Name Description
PurchaseOrder purchaseOrder

The purchase order.
Returns
Type Description
OrderStatus

HoldOrder(PaymentPlan)

Declaration
public static PaymentPlan HoldOrder(PaymentPlan plan)
Parameters
Type Name Description
PaymentPlan plan
Returns
Type Description
PaymentPlan

HoldOrder(PurchaseOrder)

Declaration
public static PurchaseOrder HoldOrder(PurchaseOrder purchaseOrder)
Parameters
Type Name Description
PurchaseOrder purchaseOrder
Returns
Type Description
PurchaseOrder

IsOrderCancellable(PaymentPlan)

Declaration
public static bool IsOrderCancellable(PaymentPlan plan)
Parameters
Type Name Description
PaymentPlan plan
Returns
Type Description
System.Boolean

IsOrderCancellable(PurchaseOrder)

Determines whether order can be cancelled.

Declaration
public static bool IsOrderCancellable(PurchaseOrder purchaseOrder)
Parameters
Type Name Description
PurchaseOrder purchaseOrder

The purchase order.
Returns
Type Description
System.Boolean

true if order can be cancelled; otherwise, false.

IsOrderHaveAwaitingReturnCompletable(PurchaseOrder)

Determines whether order has any awaiting completion return form

Declaration
public static bool IsOrderHaveAwaitingReturnCompletable(PurchaseOrder purchaseOrder)
Parameters
Type Name Description
PurchaseOrder purchaseOrder

The purchase order.
Returns
Type Description
System.Boolean

true if [is order awaiting return completable] [the specified purchase order]; otherwise, false.

IsOrderHaveAwaitingStockReturns(PurchaseOrder)

Determines whether the order has any waiting stock return form

Declaration
public static bool IsOrderHaveAwaitingStockReturns(PurchaseOrder purchaseOrder)
Parameters
Type Name Description
PurchaseOrder purchaseOrder

The purchase order.
Returns
Type Description
System.Boolean

true if [is order awaiting stock returns] [the specified purchase order]; otherwise, false.

IsOrderHoldable(PaymentPlan)

Declaration
public static bool IsOrderHoldable(PaymentPlan plan)
Parameters
Type Name Description
PaymentPlan plan
Returns
Type Description
System.Boolean

IsOrderHoldable(PurchaseOrder)

Determines if order can be put on hold.

Declaration
public static bool IsOrderHoldable(PurchaseOrder purchaseOrder)
Parameters
Type Name Description
PurchaseOrder purchaseOrder

The purchase order.
Returns
Type Description
System.Boolean

true if can be put on hold; otherwise, false.

IsOrderPaid(PaymentPlan)

Determines whether [is order paid] [the specified plan].

Declaration
public static bool IsOrderPaid(PaymentPlan plan)
Parameters
Type Name Description
PaymentPlan plan

The plan.
Returns
Type Description
System.Boolean

true if [is order paid] [the specified plan]; otherwise, false.

IsOrderPaid(PurchaseOrder)

Determines whether [is order paid] [the specified purchase order].

Declaration
public static bool IsOrderPaid(PurchaseOrder purchaseOrder)
Parameters
Type Name Description
PurchaseOrder purchaseOrder

The purchase order.
Returns
Type Description
System.Boolean

true if [is order paid] [the specified purchase order]; otherwise, false.

IsShipmentCancellable(Shipment)

Declaration
public static bool IsShipmentCancellable(Shipment shipment)
Parameters
Type Name Description
Shipment shipment
Returns
Type Description
System.Boolean

IsShipmentCompletable(Shipment)

Declaration
public static bool IsShipmentCompletable(Shipment shipment)
Parameters
Type Name Description
Shipment shipment
Returns
Type Description
System.Boolean

IsShipmentPackable(Shipment)

Declaration
public static bool IsShipmentPackable(Shipment shipment)
Parameters
Type Name Description
Shipment shipment
Returns
Type Description
System.Boolean

IsShipmentReleaseable(Shipment)

Declaration
public static bool IsShipmentReleaseable(Shipment shipment)
Parameters
Type Name Description
Shipment shipment
Returns
Type Description
System.Boolean

IsShipmentReturnable(Shipment)

Declaration
public static bool IsShipmentReturnable(Shipment shipment)
Parameters
Type Name Description
Shipment shipment
Returns
Type Description
System.Boolean

PickForPackingOrderShipment(Shipment)

Picks the shipment for packing.

Declaration
public static Shipment PickForPackingOrderShipment(Shipment shipment)
Parameters
Type Name Description
Shipment shipment

The shipment.
Returns
Type Description
Shipment

ProcessOrder(PurchaseOrder)

Declaration
public static PurchaseOrder ProcessOrder(PurchaseOrder purchaseOrder)
Parameters
Type Name Description
PurchaseOrder purchaseOrder
Returns
Type Description
PurchaseOrder

RecalculatePurchaseOrder(PaymentPlan)

Recalculates the purchase order.

Declaration
public static WorkflowResults RecalculatePurchaseOrder(PaymentPlan plan)
Parameters
Type Name Description
PaymentPlan plan

The plan.
Returns
Type Description
WorkflowResults

RecalculatePurchaseOrder(PaymentPlan, Boolean)

Recalculates the purchase order.

Declaration
public static WorkflowResults RecalculatePurchaseOrder(PaymentPlan plan, bool throwException)
Parameters
Type Name Description
PaymentPlan plan

The plan.
System.Boolean throwException

if set to true [throw exception].
Returns
Type Description
WorkflowResults

RecalculatePurchaseOrder(PurchaseOrder)

Recalculates the purchase order.

Declaration
public static WorkflowResults RecalculatePurchaseOrder(PurchaseOrder purchaseOrder)
Parameters
Type Name Description
PurchaseOrder purchaseOrder

The purchase order.
Returns
Type Description
WorkflowResults

RecalculatePurchaseOrder(PurchaseOrder, Boolean)

Recalculates the purchase order.

Declaration
public static WorkflowResults RecalculatePurchaseOrder(PurchaseOrder purchaseOrder, bool throwException)
Parameters
Type Name Description
PurchaseOrder purchaseOrder

The purchase order.
System.Boolean throwException

if set to true [throw exception].
Returns
Type Description
WorkflowResults

RecalculatePurchaseOrder(PurchaseOrder, Boolean, Dictionary<String, Object>)

Recalculates the purchase order.

Declaration
public static WorkflowResults RecalculatePurchaseOrder(PurchaseOrder purchaseOrder, bool throwException, Dictionary<string, object> param)
Parameters
Type Name Description
PurchaseOrder purchaseOrder

The purchase order.
System.Boolean throwException

if set to true [throw exception].
System.Collections.Generic.Dictionary<System.String, System.Object> param

The additional input parameters.
Returns
Type Description
WorkflowResults

ReleaseHoldOnOrder(PaymentPlan)

Declaration
public static PaymentPlan ReleaseHoldOnOrder(PaymentPlan plan)
Parameters
Type Name Description
PaymentPlan plan
Returns
Type Description
PaymentPlan

ReleaseHoldOnOrder(PurchaseOrder)

Declaration
public static PurchaseOrder ReleaseHoldOnOrder(PurchaseOrder purchaseOrder)
Parameters
Type Name Description
PurchaseOrder purchaseOrder
Returns
Type Description
PurchaseOrder

ReleaseOrderShipment(Shipment)

Declaration
public static Shipment ReleaseOrderShipment(Shipment shipment)
Parameters
Type Name Description
Shipment shipment
Returns
Type Description
Shipment

ReturnFromPackingOrderShipment(Shipment)

Returns the shipment from packing to release.

Declaration
public static Shipment ReturnFromPackingOrderShipment(Shipment shipment)
Parameters
Type Name Description
Shipment shipment

The shipment.
Returns
Type Description
Shipment

SaveOrderStatus(OrderStatusDto)

Saves changes in OrderStatusDto. Not implemented!

Declaration
public static void SaveOrderStatus(OrderStatusDto dto)
Parameters
Type Name Description
OrderStatusDto dto

The dto.