Class Assortment

Namespace

Dynamicweb.Ecommerce.Assortments

Assembly

Dynamicweb.Ecommerce.dll

Assortment class.

[Serializable]
[PermissionEntity("Assortment")]
public class Assortment : IPermissionEntity, IPermissionEntityLookup

Inheritance

object

Assortment

Implements

IPermissionEntity

IPermissionEntityLookup

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

PermissionEntityExtensions.GetPermission(IPermissionEntity)

PermissionEntityExtensions.GetPermissionIdentifier(IPermissionEntity)

PermissionEntityExtensions.HasPermission(IPermissionEntity, PermissionLevel)

Constructors

Assortment()

Creates an Assortment object with default property values.

public Assortment()

Properties

Active

Gets or sets a value indicating whether the Assortment is active.

public bool Active { get; set; }

Property Value

bool

true if active; otherwise, false.

AllowAnonymousUsers

Gets or sets a value indicating whether the Assortment is available to anonymous uses.

public bool AllowAnonymousUsers { get; set; }

Property Value

bool

true if assortment is available to anonymous users; otherwise, false.

AutoId

Gets or sets the autoId of the Assortment.

public int AutoId { get; }

Property Value

int

The auto assigned value from the assortment database table

GroupHierarchy

Gets the group hierarchy of assortment

public HashSet<string> GroupHierarchy { get; }

Property Value

HashSet<string>

GroupRelations

Gets the group relations of assortment

public Dictionary<string, AssortmentGroupRelation> GroupRelations { get; }

Property Value

Dictionary<string, AssortmentGroupRelation>

HasRelations

Shows that assortment has any type of relation (product, group or shop relations)

public bool HasRelations { get; }

Property Value

bool

ID

Gets or sets the id of the Assortment.

public string ID { get; set; }

Property Value

string

The identifier.

IncludeSubgroups

Gets or sets a value indicating whether the Assortment should include subgroups of selected groups when building the Assortment.

public bool IncludeSubgroups { get; set; }

Property Value

bool

true if subgroups are included; otherwise, false.

Items

Gets the assortment items

public Dictionary<ProductKey, AssortmentItem> Items { get; }

Property Value

Dictionary<ProductKey, AssortmentItem>

LastBuildDate

Gets the date and time when the Assortment was last built.

public DateTime? LastBuildDate { get; }

Property Value

DateTime?

The last build date.

PermissionName

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

public string PermissionName { get; }

Property Value

string

See Also

Name

Permissions

Gets the assortment permissions

public Dictionary<int, AssortmentPermission> Permissions { get; }

Property Value

Dictionary<int, AssortmentPermission>

ProductRelations

Gets the product relations of assortment

public Dictionary<string, AssortmentProductRelation> ProductRelations { get; }

Property Value

Dictionary<string, AssortmentProductRelation>

RebuildRequired

Gets or sets a value indicating whether a rebuild of the Assortment is required.

public bool RebuildRequired { get; set; }

Property Value

bool

true if rebuild is required; otherwise, false.

ShopRelations

Gets the shop relations of assortment

public Dictionary<string, AssortmentShopRelation> ShopRelations { get; }

Property Value

Dictionary<string, AssortmentShopRelation>

Translations

Gets the translations of assortment

public TranslationCollection<AssortmentTranslation> Translations { get; }

Property Value

TranslationCollection<AssortmentTranslation>

Methods

GetName(string)

Gets the name of the assortment for the given language.

public string GetName(string languageId)

Parameters

languageId string

Language id

Returns

string

GetNumber(string)

Gets the number of the assortment for the given language.

public string GetNumber(string languageId)

Parameters

languageId string

Language id

Returns

string

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

Key

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

SetName(string, string)

Sets the name of the assortment for the given language.

public void SetName(string languageId, string name)

Parameters

languageId string

Language id

name string

Assortment name

SetNumber(string, string)

Sets the number of the assortment for the given language.

public void SetNumber(string languageId, string number)

Parameters

languageId string

Language id

number string

Assortment number