Class RecurringOrderService

Namespace

Dynamicweb.Ecommerce.Orders

Assembly

Dynamicweb.Ecommerce.dll

public abstract class RecurringOrderService : ICacheStorage<int, RecurringOrder>, ICacheStorage<int>, ICacheStorage

Inheritance

object

RecurringOrderService

Implements

ICacheStorage<int, RecurringOrder>

ICacheStorage<int>

ICacheStorage

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Info

Gets the cache information.

public abstract CacheInformation Info { get; }

Property Value

CacheInformation

Methods

ClearCache()

Clears all cache entries.

public abstract void ClearCache()

ClearCache(IEnumerable<int>)

Clears cache for the specified keys.

public abstract void ClearCache(IEnumerable<int> keys)

Parameters

keys IEnumerable<int>

The cache keys to clear.

ClearCache(int)

Clears cache for the specified key.

public abstract void ClearCache(int key)

Parameters

key int

The cache key to clear.

Delete(int)

Deletes a recurring order by its identifier.

public abstract void Delete(int recurringOrderId)

Parameters

recurringOrderId int

The identifier of the recurring order to delete.

EndRecurring(int)

Ends a recurring order by the recurring order identifier.

public abstract void EndRecurring(int recurringOrderId)

Parameters

recurringOrderId int

The identifier of the recurring order to end.

EndRecurringByBaseOrderId(string)

Ends recurring order by its base order identifier.

public abstract void EndRecurringByBaseOrderId(string baseOrderId)

Parameters

baseOrderId string

The base order identifier of the recurring order to end.

GetByBaseOrderId(string)

Gets a recurring order by its base order identifier.

public abstract RecurringOrder? GetByBaseOrderId(string baseOrderId)

Parameters

baseOrderId string

The base order identifier of the recurring order.

Returns

RecurringOrder

The recurring order if found; otherwise, null.

GetById(int)

Gets a recurring order by its unique identifier.

public abstract RecurringOrder? GetById(int id)

Parameters

id int

The unique identifier of the recurring order.

Returns

RecurringOrder

The recurring order if found; otherwise, null.

GetRecurringOrdersForScheduling()

Gets recurring orders that are ready for scheduling.

public abstract IEnumerable<RecurringOrder> GetRecurringOrdersForScheduling()

Returns

IEnumerable<RecurringOrder>

A collection of recurring orders ready for scheduling.

GetRecurringOrdersForUser(int, bool, DateTime?)

Gets recurring orders for a specific user.

public abstract IEnumerable<RecurringOrder> GetRecurringOrdersForUser(int userId, bool useCustomerNumber, DateTime? fromDate)

Parameters

userId int

The user identifier.

useCustomerNumber bool

Indicates whether to use customer number for filtering.

fromDate DateTime?

The minimum date to filter orders from.

Returns

IEnumerable<RecurringOrder>

A collection of recurring orders for the user.

Save(RecurringOrder)

Saves a recurring order.

public abstract void Save(RecurringOrder recurringOrder)

Parameters

recurringOrder RecurringOrder

The recurring order to save.

SetCacheType<TObjectCache>()

Sets the cache type for the service cache storage.

public abstract void SetCacheType<TObjectCache>() where TObjectCache : ServiceCache<int, RecurringOrder>

Type Parameters

TObjectCache

The type of cache to set.