Table of Contents

Class CustomerProductList

Namespace
Dynamicweb.Ecommerce.CustomerCenter
Assembly
Dynamicweb.Ecommerce.dll
CustomerProductList class.
public class CustomerProductList : DbObject
Inheritance
CustomerProductList
Inherited Members

Constructors

CustomerProductList()

Initializes a new instance of the CustomerProductList class.
public CustomerProductList()
See Also

Properties

AccessUserId

Gets or sets the access user identifier.
public int AccessUserId { get; set; }

Property Value

int
The access user identifier.
See Also

Description

Gets or sets the description.
public string Description { get; set; }

Property Value

string
The description.
See Also

IsDefault

Gets or sets a value indicating whether this instance is default.
public bool IsDefault { get; set; }

Property Value

bool
true if this instance is default; otherwise, false.
See Also

IsPublished

Gets or sets a value indicating whether this instance is published.
public bool IsPublished { get; set; }

Property Value

bool
true if this instance is published; otherwise, false.
See Also

IsShared

Gets or sets a value indicating whether this instance is shared.
public bool IsShared { get; set; }

Property Value

bool
true if this instance is shared; otherwise, false.
See Also

ListId

Gets or sets the list identifier.
public int ListId { get; set; }

Property Value

int
The list identifier.
See Also

Name

Gets or sets the name.
public string Name { get; set; }

Property Value

string
The name.
See Also

Products

Gets user's favorits products
public IEnumerable<CustomerProductListProduct> Products { get; }

Property Value

IEnumerable<CustomerProductListProduct>
User's favorite products. The collection is read-only.
See Also

ProductsCount

Gets the count of products
public int ProductsCount { get; }

Property Value

int
The count of products.
See Also

ProductsQuantity

Gets the quantity of products
public int ProductsQuantity { get; }

Property Value

int
The quantity of products.
See Also

PublishedId

Gets or sets the published identifier.
public string PublishedId { get; set; }

Property Value

string
The published identifier.
See Also

PublishedToDate

Gets or sets the published to date.
public DateTime PublishedToDate { get; set; }

Property Value

DateTime
The published to date.
See Also

Type

Gets or sets the type.
public string Type { get; set; }

Property Value

string
The type.
See Also

Methods

AddToFavorites(Product)

Adds to favorites.
public static void AddToFavorites(Product product)

Parameters

product Product
The product.
See Also

AddToFavorites(string, string)

Adds to favorites.
public static void AddToFavorites(string productId, string variantId)

Parameters

productId string
The product identifier.
variantId string
The variant identifier.
See Also

AddToFavorites(string, string, int)

Adds to favorites.
public static void AddToFavorites(string productId, string variantId, int favoriteListId)

Parameters

productId string
The product identifier.
variantId string
The variant identifier.
favoriteListId int
The favorite list identifier.
See Also

AddToFavorites(string, string, string) 

[Obsolete("Use the overload without Language ID")]
public static void AddToFavorites(string productId, string variantId, string languageId)

Parameters

productId string
variantId string
languageId string
See Also

AddToFavorites(string, string, string, int) 

[Obsolete("Use the overload without Language ID")]
public static void AddToFavorites(string productId, string variantId, string languageId, int favoriteListId)

Parameters

productId string
variantId string
languageId string
favoriteListId int
See Also

AddToFavorites(string, string, string, string, string, int)

Adds to favorites.
public static void AddToFavorites(string productId, string variantId, string listName, string listType, string listDescription, int favoriteListId)

Parameters

productId string
The product identifier.
variantId string
The variant identifier.
listName string
Name of the list.
listType string
Type of the list.
listDescription string
The list description.
favoriteListId int
The favorite list identifier.
See Also

AddToFavorites(string, string, string, string, string, int, int)

Adds to favorites.
public static void AddToFavorites(string productId, string variantId, string listName, string listType, string listDescription, int favoriteListId, int userId)

Parameters

productId string
The product identifier.
variantId string
The variant identifier.
listName string
Name of the list.
listType string
Type of the list.
listDescription string
The list description.
favoriteListId int
The favorite list identifier.
userId int
The user identifier.
See Also

AddToFavorites(string, string, string, string, string, string, int) 

[Obsolete("Use the overload without Language ID")]
public static void AddToFavorites(string productId, string variantId, string languageId, string listName, string listType, string listDescription, int favoriteListId)

Parameters

productId string
variantId string
languageId string
listName string
listType string
listDescription string
favoriteListId int
See Also

AddToFavorites(string, string, string, string, string, string, int, int) 

[Obsolete("Use the overload without Language ID")]
public static void AddToFavorites(string productId, string variantId, string languageId, string listName, string listType, string listDescription, int favoriteListId, int userId)

Parameters

productId string
variantId string
languageId string
listName string
listType string
listDescription string
favoriteListId int
userId int
See Also

ClearCache(Group)

Clears the cache.
public static void ClearCache(Group group)

Parameters

group Group
The group.
See Also

ClearCache(User)

Clears the cache.
public static void ClearCache(User user)

Parameters

user User
The user.
See Also

ClearCache(int)

Clears the cache.
public static void ClearCache(int userId)

Parameters

userId int
The user identifier.
See Also

Delete(int)

Deletes the object with specified Id.
public override void Delete(int id)

Parameters

id int
Specified Id.
See Also

Fill(IDataReader)

Fills the specified reader.
public override void Fill(IDataReader reader)

Parameters

reader IDataReader
The reader.
See Also

FillRow(DataRow)

Fills the row.
protected override void FillRow(DataRow row)

Parameters

row DataRow
The row.
See Also

ForceInitializeAllProducts() 

public void ForceInitializeAllProducts()
See Also

GeneratePublishedId()

Generates the published identifier.
public static string GeneratePublishedId()

Returns

string
System.String.
See Also

GetAllProductLists(int)

Gets the default favorite list by user id.
[Obsolete("Use GetListByCustomerId instead.")]
public static IEnumerable<CustomerProductList> GetAllProductLists(int userId)

Parameters

userId int
The user id of favorite list.

Returns

IEnumerable<CustomerProductList>
The favorites list
See Also

GetDefaultList(IEnumerable<CustomerProductList>)

Gets the default favorite list by user id.
public static CustomerProductList GetDefaultList(IEnumerable<CustomerProductList> favouriteListCollection)

Parameters

favouriteListCollection IEnumerable<CustomerProductList>
The user id of favorite list.

Returns

CustomerProductList
The favorites list
See Also

GetDefaultList(int)

Gets the default favorite list by user id.
public static CustomerProductList GetDefaultList(int userId)

Parameters

userId int
The user id of favorite list.

Returns

CustomerProductList
The favorites list
See Also

GetListByCustomerId(int)

Gets the favorites list by user id.
public static IEnumerable<CustomerProductList> GetListByCustomerId(int customerId)

Parameters

customerId int
The id of user

Returns

IEnumerable<CustomerProductList>
The favorites list
See Also

GetListById(int)

Gets the favorite list by id.
public static CustomerProductList GetListById(int id)

Parameters

id int
The id of favorite list.

Returns

CustomerProductList
The favorite list
See Also

GetListById(int, IEnumerable<CustomerProductList>)

Gets the list by identifier.
public static CustomerProductList GetListById(int id, IEnumerable<CustomerProductList> favouriteListCollection)

Parameters

id int
The identifier.
favouriteListCollection IEnumerable<CustomerProductList>
The favourite list collection.

Returns

CustomerProductList
CustomerProductList.
See Also

GetListByPublishedId(string)

Gets the favorite list by published id.
public static CustomerProductList GetListByPublishedId(string publishedId)

Parameters

publishedId string
The published id of favorite list.

Returns

CustomerProductList
The favorite list
See Also

GetListByType(IEnumerable<CustomerProductList>, string)

Gets the favorites list by type.
public static IEnumerable<CustomerProductList> GetListByType(IEnumerable<CustomerProductList> productListCollection, string type)

Parameters

productListCollection IEnumerable<CustomerProductList>
The product list collection.
type string
The type.

Returns

IEnumerable<CustomerProductList>
The favorites list by type
See Also

GetListByType(int, string)

Gets the favorites list by user id.
public static IEnumerable<CustomerProductList> GetListByType(int customerId, string type)

Parameters

customerId int
The id of user
type string
The type.

Returns

IEnumerable<CustomerProductList>
The favorites list
See Also

GetListsByUserCustomerNumber(string)

Gets the lists by user customer number.
public static IEnumerable<CustomerProductList> GetListsByUserCustomerNumber(string customerNumber)

Parameters

customerNumber string
The customer number of user

Returns

IEnumerable<CustomerProductList>
The favorites list
See Also

GetListTypesByCustomerNumber(string)

Gets the favorites list types by user customer number.
public static IEnumerable<string> GetListTypesByCustomerNumber(string customerNumber)

Parameters

customerNumber string
The user customer number

Returns

IEnumerable<string>
The favorites list
See Also

GetListTypesByUser(int)

Gets the favorites list by user id.
public static IEnumerable<string> GetListTypesByUser(int customerId)

Parameters

customerId int
The id of user

Returns

IEnumerable<string>
The favorites list
See Also

GetProductKey(string, string) 

public static string GetProductKey(string productId, string variantId)

Parameters

productId string
variantId string

Returns

string
See Also

GetProductKey(string, string, string) 

[Obsolete("Use the overload without Language ID")]
public static string GetProductKey(string productId, string variantId, string languageId)

Parameters

productId string
variantId string
languageId string

Returns

string
See Also

GetProductLists(int, string, bool, string, bool, int, int) 

public static IEnumerable<CustomerProductList> GetProductLists(int userId, string search, bool isShared, string sortField, bool isAscending, int startItem, int endItem)

Parameters

userId int
search string
isShared bool
sortField string
isAscending bool
startItem int
endItem int

Returns

IEnumerable<CustomerProductList>
See Also

GetProductListsCount(int, string, bool) 

public static int GetProductListsCount(int userId, string search, bool isShared)

Parameters

userId int
search string
isShared bool

Returns

int
See Also

GetProductLookup() 

public Dictionary<string, Product> GetProductLookup()

Returns

Dictionary<string, Product>
See Also

GneratePublishedId()

Gnerates the published identifier.
[Obsolete("Use GeneratePublishedId()")]
public static string GneratePublishedId()

Returns

string
System.String.
See Also

RemoveFromFavorites(Order)

Removes from favorites.
public static void RemoveFromFavorites(Order order)

Parameters

order Order
The order.
See Also

RemoveFromFavorites(string, string)

Removes from favorites.
public static void RemoveFromFavorites(string productId, string variantId)

Parameters

productId string
The product identifier.
variantId string
The variant identifier.
See Also

RemoveFromFavorites(string, string, int, double)

Removes from favorites.
public static void RemoveFromFavorites(string productId, string variantId, int favoriteListId, double quantity)

Parameters

productId string
The product identifier.
variantId string
The variant identifier.
favoriteListId int
The favorite list identifier.
quantity double
The quantity.
See Also

RemoveFromFavorites(string, string, int, double, bool)

Removes from favorites.
public static void RemoveFromFavorites(string productId, string variantId, int favoriteListId, double quantity, bool isRemoveFromList)

Parameters

productId string
The product identifier.
variantId string
The variant identifier.
favoriteListId int
The favorite list identifier.
quantity double
The quantity.
isRemoveFromList bool
if set to true [is remove from list].
See Also

RemoveFromFavorites(string, string, string) 

[Obsolete("Use the overload without Language ID")]
public static void RemoveFromFavorites(string productId, string variantId, string languageId)

Parameters

productId string
variantId string
languageId string
See Also

RemoveFromFavorites(string, string, string, int, double) 

[Obsolete("Use the overload without Language ID")]
public static void RemoveFromFavorites(string productId, string variantId, string languageId, int favoriteListId, double quantity)

Parameters

productId string
variantId string
languageId string
favoriteListId int
quantity double
See Also

RemoveFromFavorites(string, string, string, int, double, bool) 

[Obsolete("Use the overload without Language ID")]
public static void RemoveFromFavorites(string productId, string variantId, string languageId, int favoriteListId, double quantity, bool isRemoveFromList)

Parameters

productId string
variantId string
languageId string
favoriteListId int
quantity double
isRemoveFromList bool
See Also

Save()

Saves current data to the database.
public override void Save()
See Also

See Also

DbObject
Edit this page
To top