Class FieldValueConversionRuleService

Namespace

Dynamicweb.Ecommerce.Products.FieldValueConversions

Assembly

Dynamicweb.Ecommerce.dll

Provides an abstract base class for managing FieldValueConversionRule objects.

[Experimental("DWEX100002")]
public abstract class FieldValueConversionRuleService : ICacheStorage<int, FieldValueConversionRule>, ICacheStorage<int>, ICacheStorage

Inheritance

object

FieldValueConversionRuleService

Implements

ICacheStorage<int, FieldValueConversionRule>

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

Information about the object cache

public abstract CacheInformation Info { get; }

Property Value

CacheInformation

Methods

ClearCache()

Resets all keys to the default value for objects stored in the object cache

public abstract void ClearCache()

ClearCache(IEnumerable<int>)

Resets the specified keys to the default value for objects stored in the object cache

public abstract void ClearCache(IEnumerable<int> keys)

Parameters

keys IEnumerable<int>

Keys to reset

ClearCache(int)

Resets the specified key to the default value for objects stored in the object cache

public abstract void ClearCache(int key)

Parameters

key int

Key to reset

Delete(FieldValueConversionRule)

Deletes a FieldValueConversionRule object.

public abstract void Delete(FieldValueConversionRule rule)

Parameters

rule FieldValueConversionRule

Exceptions

ArgumentNullException

Thrown when rule is null.

DeleteByField(string)

Deletes all FieldValueConversionRule objects associated with a specific Field ID.

public abstract void DeleteByField(string fieldId)

Parameters

fieldId string

The Field ID

DeleteByFieldValueConversionId(int)

Deletes all FieldValueConversionRule objects associated with a specific Field Value Conversion ID.

public abstract void DeleteByFieldValueConversionId(int fieldValueConversionId)

Parameters

fieldValueConversionId int

The Field Value Conversion ID

DeleteByIds(IEnumerable<int>?)

Deletes a collection of FieldValueConversionRule objects that matches the provided rule ids.

public abstract void DeleteByIds(IEnumerable<int>? ruleIds)

Parameters

ruleIds IEnumerable<int>

Exceptions

ArgumentNullException

Thrown when ruleIds is null.

GetAllByField(string)

Retrieves all rules associated with a specific field.

public abstract IEnumerable<FieldValueConversionRule> GetAllByField(string fieldId)

Parameters

fieldId string

The Field ID.

Returns

IEnumerable<FieldValueConversionRule>

GetByField(string, FieldValueConversionContext)

Retrieves a rule for a specific FieldValueConversionContext.

public abstract FieldValueConversionRule? GetByField(string fieldId, FieldValueConversionContext context)

Parameters

fieldId string

The Field ID.

context FieldValueConversionContext

The FieldValueConversionContext to provide additional context for the retrieval.

Returns

FieldValueConversionRule

GetById(int)

Retrieves all rules associated with a specific field.

public abstract FieldValueConversionRule? GetById(int id)

Parameters

id int

The rule ID.

Returns

FieldValueConversionRule

Save(FieldValueConversionRule)

Saves a FieldValueConversionRule object.

public abstract void Save(FieldValueConversionRule rule)

Parameters

rule FieldValueConversionRule

Exceptions

ArgumentNullException

Thrown when rule is null.

SetCacheType<TObjectCache>()

Changes the storage container

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

Type Parameters

TObjectCache