Class OrderFlow

Namespace

Dynamicweb.Ecommerce.Orders

Assembly

Dynamicweb.Ecommerce.dll

[Serializable]
public class OrderFlow

Inheritance

object

OrderFlow

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

OrderFlow()

Constructor for OrderFlow class.

public OrderFlow()

OrderFlow(int)

Constructor for OrderFlow class.

[Obsolete("Use Services.OrderFlows.GetFlowById(id) instead.")]
public OrderFlow(int id)

Parameters

id int

News ID.

Fields

CacheKey

[Obsolete("Not used")]
public const string CacheKey = "ECOM:ORDERFLOWS"

Field Value

string

Properties

Description

Gets or sets the description.

public string Description { get; set; }

Property Value

string

The description.

ID

Gets or sets the id.

public int ID { get; set; }

Property Value

int

IsDefault

Gets or sets a value indicating whether this instance is default.

public bool IsDefault { get; set; }

Property Value

bool

true if this instance is default; otherwise, false.

IsNew

Indicates whether the current instance is new.

public bool IsNew { get; }

Property Value

bool

Boolean statement.

Name

Gets or sets the name.

public string Name { get; set; }

Property Value

string

The name.

OrderType

Gets or sets a type of this flow: for orders or for quotes

public OrderType OrderType { get; set; }

Property Value

OrderType

Methods

Delete()

[Obsolete("Use Services.OrderFlows.Delete instead.")]
public void Delete()

Delete(int)

Deletes flow and all the flow states by id.

[Obsolete("Use Services.OrderFlows.Delete instead.")]
public void Delete(int flowId)

Parameters

flowId int

The flow id.

Fill(IDataReader)

Fills flow with data from reader.

[Obsolete("Do not use.")]
public void Fill(IDataReader reader)

Parameters

reader IDataReader

The reader.

FillRow(DataRow)

[Obsolete("Do not use.")]
protected void FillRow(DataRow row)

Parameters

row DataRow

GetAllFlows()

Gets all the flows.

[Obsolete("Use Services.OrderFlows.GetAllFlows() instead.")]
public static OrderFlowCollection GetAllFlows()

Returns

OrderFlowCollection

GetCartFlows()

Gets all the cart flows.

[Obsolete("Use Services.OrderFlows.GetFlowsByOrderType(OrderType.Cart) instead.")]
public static OrderFlowCollection GetCartFlows()

Returns

OrderFlowCollection

GetDefault()

Gets default order flow.

[Obsolete("Use Services.OrderFlows.GetDefaultFlowByOrderType(OrderType.Order) instead.")]
public static OrderFlow GetDefault()

Returns

OrderFlow

GetDefaultCart()

[Obsolete("Use Services.OrderFlows.GetDefaultFlowByOrderType(OrderType.Cart) instead.")]
public static OrderFlow GetDefaultCart()

Returns

OrderFlow

GetDefaultQuote()

Gets default quote flow.

[Obsolete("Use Services.OrderFlows.GetDefaultFlowByOrderType(OrderType.Quote) instead.")]
public static OrderFlow GetDefaultQuote()

Returns

OrderFlow

GetOrderFlows()

Gets all the order flows.

[Obsolete("Use Services.OrderFlows.GetFlowsByOrderType(OrderType.Order) instead.")]
public static OrderFlowCollection GetOrderFlows()

Returns

OrderFlowCollection

GetQuoteFlows()

Gets all the quote flows.

[Obsolete("Use Services.OrderFlows.GetFlowsByOrderType(OrderType.Quote) instead.")]
public static OrderFlowCollection GetQuoteFlows()

Returns

OrderFlowCollection

GetRecurringOrderFlows()

Gets all the recurring order flows.

[Obsolete("Use Services.OrderFlows.GetFlowsByOrderType(OrderType.Recurringorder) instead.")]
public static OrderFlowCollection GetRecurringOrderFlows()

Returns

OrderFlowCollection

Load(int)

[Obsolete("Use Services.OrderFlows.GetFlowById instead.")]
public void Load(int id)

Parameters

id int

Save()

Saves this flow.

[Obsolete("Use Services.OrderFlows.Save(OrderFlow) instead.")]
public void Save()

UpdateDefault(bool, OrderType, string)

Updates the flow IsDefault property.

[Obsolete("Set IsDefault and call Services.OrderFlows.Save instead.")]
public void UpdateDefault(bool setDefaultTo, OrderType orderType, string flowId = "")

Parameters

setDefaultTo bool

The indicator whether flow is default.

orderType OrderType

The type of order.

flowId string

The flow id.

UpdateDefault(bool, string)

Updates the flow IsDefault property.

[Obsolete("Set IsDefault and call Services.OrderFlows.Save instead.")]
public void UpdateDefault(bool setDefaultTo, string flowId = "")

Parameters

setDefaultTo bool

The indicator whether flow is default.

flowId string

The flow id.