Class OrderGroupWorkflowManager

Inheritance

System.Object

OrderGroupWorkflowManager

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 OrderGroupWorkflowManager

Fields

CartCheckOutWorkflowName

Declaration

public const string CartCheckOutWorkflowName = "CartCheckout"

Field Value

Type	Description
System.String

CartPrepareWorkflowName

Declaration

public const string CartPrepareWorkflowName = "CartPrepare"

Field Value

Type	Description
System.String

CartValidateWorkflowName

Declaration

public const string CartValidateWorkflowName = "CartValidate"

Field Value

Type	Description
System.String

CheckAndReserveInstorePickupWorkflowName

Declaration

public const string CheckAndReserveInstorePickupWorkflowName = "CheckAndReserveInstorePickupWorkflow"

Field Value

Type	Description
System.String

OrderCalculateTotalsWorflowName

Declaration

[Obsolete("This field has a typo. Use OrderCalculateTotalsWorkflowName instead. Will be removed in version 10.", false)]
public const string OrderCalculateTotalsWorflowName = "RecalculateTotalsWorkflow"

Field Value

Type	Description
System.String

OrderCalculateTotalsWorkflowName

Declaration

public const string OrderCalculateTotalsWorkflowName = "RecalculateTotalsWorkflow"

Field Value

Type	Description
System.String

OrderCompleteShipmentWorflowName

Declaration

[Obsolete("This field has a typo. Use OrderCompleteShipmentWorkflowName instead. Will be removed in version 10.", false)]
public const string OrderCompleteShipmentWorflowName = "CompleteShipmentWorkflow"

Field Value

Type	Description
System.String

OrderCompleteShipmentWorkflowName

Declaration

public const string OrderCompleteShipmentWorkflowName = "CompleteShipmentWorkflow"

Field Value

Type	Description
System.String

OrderRecalculateWorkflowName

Declaration

public const string OrderRecalculateWorkflowName = "RecalculatePurchaseOrderWorkflow"

Field Value

Type	Description
System.String

OrderSaveChangesWorkflowName

Declaration

public const string OrderSaveChangesWorkflowName = "SaveChangesWorkflow"

Field Value

Type	Description
System.String

OrderSplitShipmentsWorflowName

Declaration

[Obsolete("This field has a typo. Use OrderSplitShipmentsWorkflowName instead. Will be removed in version 10.", false)]
public const string OrderSplitShipmentsWorflowName = "SplitShipmentsWorkflow"

Field Value

Type	Description
System.String

OrderSplitShipmentsWorkflowName

Declaration

public const string OrderSplitShipmentsWorkflowName = "SplitShipmentsWorkflow"

Field Value

Type	Description
System.String

ReturnFormCompleteWorkflowName

Declaration

public const string ReturnFormCompleteWorkflowName = "ReturnFormCompleteWorkflow"

Field Value

Type	Description
System.String

ReturnFormRecalculateWorkflowName

Declaration

public const string ReturnFormRecalculateWorkflowName = "ReturnFormRecalculateWorkflow"

Field Value

Type	Description
System.String

Methods

GetWarningsFromWorkflowResult(WorkflowResults)

Declaration

public static IEnumerable<string> GetWarningsFromWorkflowResult(WorkflowResults result)

Parameters

Type	Name	Description
WorkflowResults	result

Returns

Type	Description
System.Collections.Generic.IEnumerable<System.String>

RunWorkflow(OrderGroup, String)

Runs the specified workflow, exception will be thrown and should be handled by the caller. The execution will be synchronious.

Declaration

public static WorkflowResults RunWorkflow(OrderGroup orderGroup, string name)

Parameters

Type	Name	Description
OrderGroup	orderGroup	The order group.
System.String	name	The name.

Returns

Type	Description
WorkflowResults

RunWorkflow(OrderGroup, String, Boolean)

Runs the specified workflow.

Declaration

public static WorkflowResults RunWorkflow(OrderGroup orderGroup, string name, bool throwException)

Parameters

Type	Name	Description
OrderGroup	orderGroup	The order group.
System.String	name	The name.
System.Boolean	throwException	if set to `true` the exception will be thrown and should be handled by the caller.

Returns

Type	Description
WorkflowResults

RunWorkflow(OrderGroup, String, Boolean, Boolean, Dictionary<String, Object>)

Executes an order workflow.

Declaration

public static WorkflowResults RunWorkflow(OrderGroup orderGroup, string name, bool async, bool throwException, Dictionary<string, object> param)

Parameters

Type	Name	Description
OrderGroup	orderGroup	The order group to execute the workflow against.
System.String	name	The name of the workflow to execute.
System.Boolean	async	This parameter is ignored.
System.Boolean	throwException	If true, and the target workflow throws an exception, an System.ApplicationException will be throw with the inner exception set to the exception thrown by the workflow.
System.Collections.Generic.Dictionary<System.String, System.Object>	param	The parameters to pass to the workflow.

Returns

Type	Description
WorkflowResults	A workflow result created from the arguments to the last idle, completed, terminated, or aborted event from the order runtime with the instance ID of this cart.

RunWorkflow(OrderGroup, String, Boolean, Dictionary<String, Object>)

Runs the specified workflow.

Declaration

public static WorkflowResults RunWorkflow(OrderGroup orderGroup, string name, bool throwException, Dictionary<string, object> param)

Parameters

Type	Name	Description
OrderGroup	orderGroup	The order group.
System.String	name	The name.
System.Boolean	throwException	if set to `true` the exception will be thrown and should be handled by the caller.
System.Collections.Generic.Dictionary<System.String, System.Object>	param	The additional input parameters.

Returns

Type	Description
WorkflowResults