Class OrderOptions

Contains options for the order system.

Inheritance

System.Object

OrderOptions

Namespace: Mediachase.Commerce.Orders

Assembly: Mediachase.Commerce.dll

Version: 14.26.0

Syntax

public class OrderOptions : Object

Constructors

OrderOptions()

Declaration

public OrderOptions()

Properties

AutoConfigure

Gets a value indicating whether to auto configure the Order System when first initialized.

Declaration

public bool AutoConfigure { get; set; }

Property Value

Type	Description
System.Boolean	`true` if auto configuration should happen; otherwise, `false`.

Cache

The cache options for Orders

Declaration

public OrderCacheOptions Cache { get; set; }

Property Value

Type	Description
OrderCacheOptions

CommandTimeout

Gets or sets a value indicating whether to user custom sql command timeout or not. Default is 30.

Declaration

public int CommandTimeout { get; set; }

Property Value

Type	Description
System.Int32	CommandTimeout in seconds

DisableOrderDataLocalization

A flag to indicate if we disable the order data localization.

Declaration

public bool DisableOrderDataLocalization { get; set; }

Property Value

Type	Description
System.Boolean

Remarks

Default value is false.

ExpiredCartJobDays

Number of days cart is inactive before deleting. Default is 30.

Declaration

public int ExpiredCartJobDays { get; set; }

Property Value

Type	Description
System.Int32

ExpiredCartsRemovalJobExcludedCartName

The names of the carts to exlude when running expiring cart removal job.

Declaration

public IList<string> ExpiredCartsRemovalJobExcludedCartName { get; set; }

Property Value

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

MappedTypes

Gets the mapping of order-related entities to actual implementation classes.

Declaration

public MappedTypes MappedTypes { get; set; }

Property Value

Type	Description
MappedTypes	The mapped types.

MetaClasses

Contains the names of meta classes for orders that are stored in the configuration file

Declaration

public MetaClassNames MetaClasses { get; set; }

Property Value

Type	Description
MetaClassNames	The meta classes.

NewOrderStatus

Gets the new order status.

Declaration

public string NewOrderStatus { get; set; }

Property Value

Type	Description
System.String	The new order status.

Roles

Configuration element defines the mapping of mapped types to type names specified in configuration file

Declaration

public Dictionary<string, string> Roles { get; set; }

Property Value

Type	Description
System.Collections.Generic.Dictionary<System.String, System.String>	The mapped types.

SensitiveDataMode

Gets the sensitive data mode, indicating if sensitive data (such as credit card number) should be removed, remain partially unmasked or be encrypted.

Declaration

public SensitiveDataPersistance SensitiveDataMode { get; set; }

Property Value

Type	Description
SensitiveDataPersistance	The sensitive data mode.

ShipmentAutoReleaseTimeout

Gets or sets the shipment auto release timeout.

Declaration

public TimeSpan ShipmentAutoReleaseTimeout { get; set; }

Property Value

Type	Description
System.TimeSpan	The shipment auto release timeout.

WishListCartNames

The names of the wishlist to exlude when using the default order search service.

Declaration

public IList<string> WishListCartNames { get; set; }

Property Value

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

Methods

ConfigureMetaData()

Configures the meta data.

Declaration

public void ConfigureMetaData()

SetDefaultValue()

Declaration

public void SetDefaultValue()