Table of Contents

Class RecurringOrder

Namespace
Dynamicweb.Ecommerce.Orders
Assembly
Dynamicweb.Ecommerce.dll

The class RecurringOrder represents recurring order.

[PermissionEntity("RecurringOrder")]
public class RecurringOrder : IPermissionEntity, IPermissionEntityLookup
Inheritance
RecurringOrder
Implements
Inherited Members
Extension Methods

Constructors

RecurringOrder()

Initializes a new instance of the RecurringOrder class.

public RecurringOrder()

Properties

BaseOrderId

Gets or sets recurring order base order ID.

public string? BaseOrderId { get; set; }

Property Value

string

CanceledDeliveries

Gets or sets recurring order canceled deliveries as comma-separated string of serial numbers of deliveries counted from start date.

public string? CanceledDeliveries { get; set; }

Property Value

string

EndDate

Gets or sets recurring orders end date.

public DateTime? EndDate { get; set; }

Property Value

DateTime?

ID

Gets or sets the unique identifier for the order.

public int ID { get; set; }

Property Value

int

Interval

Gets or sets recurring orders interval.

public int Interval { get; set; }

Property Value

int

IntervalUnit

Gets or sets recurring orders interval unit(day, week, month).

public RecurringIntervalUnitType IntervalUnit { get; set; }

Property Value

RecurringIntervalUnitType

IsNew

Gets a value indicating whether the RecurringOrder is new.

public bool IsNew { get; }

Property Value

bool

LastDelivery

Gets or sets previous date of recurring.

public DateTime? LastDelivery { get; set; }

Property Value

DateTime?

NextDelivery

Gets next date of recurring.

public DateTime? NextDelivery { get; }

Property Value

DateTime?

PermissionName

The permission entity identifier name supported by this implementation of IPermissionEntityLookup.

public string PermissionName { get; }

Property Value

string
See Also

StartDate

Gets or sets recurring orders start date.

public DateTime? StartDate { get; set; }

Property Value

DateTime?

UserId

Gets the recurring order related user ID.

public int UserId { get; set; }

Property Value

int

Methods

GetEvents()

Retrieve recurring order events occurred during scheduler

public IEnumerable<OrderDebuggingInfo> GetEvents()

Returns

IEnumerable<OrderDebuggingInfo>

GetFutureDeliveriesList()

Gets information about the future deliveries

public IEnumerable<RecurringOrderFutureDelivery> GetFutureDeliveriesList()

Returns

IEnumerable<RecurringOrderFutureDelivery>

GetNextDeliveryIndex(bool)

Gets index of next delivery.

public int GetNextDeliveryIndex(bool checkForCanceled)

Parameters

checkForCanceled bool

Returns

int

GetPermissionEntityByKey(string)

Attempts to resolve a concrete instance of IPermissionEntity based on a key.

public IPermissionEntity? GetPermissionEntityByKey(string key)

Parameters

key string

The key used for looking up an instance of IPermissionEntity

Returns

IPermissionEntity

An instance of IPermissionEntity, if found; otherwise, null.

See Also

GetPermissionKey()

Gets the unique key for this permission entity.

public string GetPermissionKey()

Returns

string

Permission key

GetPermissionParents()

Gets the parents of this permission entity, for the purposes of inherited permissions.

public IEnumerable<IPermissionEntity> GetPermissionParents()

Returns

IEnumerable<IPermissionEntity>

A sequence of direct parents to this entity

GetPreviousOrdersIds()

Retrieve previous recurring orders IDs

public IEnumerable<string> GetPreviousOrdersIds()

Returns

IEnumerable<string>

HasErros()

Retrieve recurring order errors occurred during scheduler

public bool HasErros()

Returns

bool
Improve this doc
To top