Table of Contents

Class ProductsAndGroupsHandler

Namespace
Dynamicweb.Ecommerce.Extensibility.Controls
Assembly
Dynamicweb.Ecommerce.dll
ProductsAndGroupsHandler class.
public class ProductsAndGroupsHandler : IComparer<Product>, IComparer<Group>
Inheritance
ProductsAndGroupsHandler
Implements
Inherited Members

Remarks

The data will be on one of these forms: [order] [product][all] [product][some](productsAndGroupsList) Where (productsAndGroupsList) is ((product)|(group))* (product) is [p:(productID),(variantID)] (group) is [g:(groupID)]

Constructors

ProductsAndGroupsHandler()

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

ProductsAndGroupsHandler(HandlerConfigurationType)

Initializes a new instance of the ProductsAndGroupsHandler class.
public ProductsAndGroupsHandler(HandlerConfigurationType type)

Parameters

type HandlerConfigurationType
The type.
See Also

ProductsAndGroupsHandler(string)

Initializes a new instance of the ProductsAndGroupsHandler class.
public ProductsAndGroupsHandler(string data)

Parameters

data string
The data.
See Also

ProductsAndGroupsHandler(string, HandlerConfigurationType)

Initializes a new instance of the ProductsAndGroupsHandler class.
public ProductsAndGroupsHandler(string data, HandlerConfigurationType defaultDataType)

Parameters

data string
The data.
defaultDataType HandlerConfigurationType
Default type of the data.
See Also

Properties

GroupIds 

protected IList<string> GroupIds { get; set; }

Property Value

IList<string>
See Also

GroupsSelected

Gets or sets the groups selected.
public IList<Group> GroupsSelected { get; set; }

Property Value

IList<Group>
The groups selected.
See Also

GroupsWithIncludedChildGroups

Gets the groups with included child groups.
public IList<Group> GroupsWithIncludedChildGroups { get; }

Property Value

IList<Group>
The groups with included child groups.
See Also

IncludeChildGroups

Gets or sets a value indicating whether [include child groups].
public bool IncludeChildGroups { get; set; }

Property Value

bool
true if [include child groups]; otherwise, false.
See Also

ProductIds 

protected IList<string> ProductIds { get; set; }

Property Value

IList<string>
See Also

ProductsSelected

Gets or sets the products selected.
public IList<Product> ProductsSelected { get; set; }

Property Value

IList<Product>
The products selected.
See Also

QueriesSelected

Gets or sets the queries selected.
public IList<IQuery> QueriesSelected { get; set; }

Property Value

IList<IQuery>
The queries selected.
See Also

QueryIds 

protected IList<string> QueryIds { get; set; }

Property Value

IList<string>
See Also

SearchesSelected

Gets or sets the searches selected.
public IList<string> SearchesSelected { get; set; }

Property Value

IList<string>
The searches selected.
See Also

ShopSelected

Gets or sets the shop selected.
public string ShopSelected { get; set; }

Property Value

string
The shop selected.
See Also

Type

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

Property Value

HandlerConfigurationType
The type.
See Also

Methods

ClearCache()

Clears the cache.
public static void ClearCache()
See Also

Compare(Group, Group)

Compares the specified x.
public int Compare(Group x, Group y)

Parameters

x Group
The x.
y Group
The y.

Returns

int
System.Int32.
See Also

Compare1(Product, Product)

Compare1s the specified x.
public int Compare1(Product x, Product y)

Parameters

x Product
The x.
y Product
The y.

Returns

int
System.Int32.
See Also

GetFullQueryName(string) 

public string GetFullQueryName(string queryIdentifier)

Parameters

queryIdentifier string

Returns

string
See Also

GetGroupsAndChildGroups(IEnumerable<Group>)

Gets a list of the given Groups including all their child groups.
public static IEnumerable<Group> GetGroupsAndChildGroups(IEnumerable<Group> groups)

Parameters

groups IEnumerable<Group>
The groups to expand with child groups.

Returns

IEnumerable<Group>
A list of groups and their child groups.
See Also

GetQueryIdentifier(IQuery) 

public static string GetQueryIdentifier(IQuery query)

Parameters

query IQuery

Returns

string
See Also

GetQueryName(IQuery) 

public static string GetQueryName(IQuery query)

Parameters

query IQuery

Returns

string
See Also

GetQueryRepository(string) 

public string GetQueryRepository(string queryIdentifier)

Parameters

queryIdentifier string

Returns

string
See Also

IsEmpty()

Determines whether this instance is empty.
public bool IsEmpty()

Returns

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

IsProductIncluded(Product)

Determines whether [is product included] [the specified product].
public bool IsProductIncluded(Product product)

Parameters

product Product
The product.

Returns

bool
true if [is product included] [the specified product]; otherwise, false.
See Also

LoadData(string)

Loads the given data, and returns a new ProductsAndGroupsHandler instance. Products and Groups are not loaded from database, so the returned instance should only be used to determine whether a specific product or group exists by using IsProductIncluded(Product).
public static ProductsAndGroupsHandler LoadData(string data)

Parameters

data string
The config data to load.

Returns

ProductsAndGroupsHandler
ProductsAndGroupsHandler.
See Also

LoadData(string, HandlerConfigurationType)

Loads the given data, and returns a new ProductsAndGroupsHandler instance. Products and Groups are not loaded from database, so the returned instance should only be used to determine whether a specific product or group exists by using IsProductIncluded(Product).
public static ProductsAndGroupsHandler LoadData(string data, HandlerConfigurationType defaultDataType)

Parameters

data string
The config data to load.
defaultDataType HandlerConfigurationType
The default type for the data. If data specifies a different type, the type from data is used.

Returns

ProductsAndGroupsHandler
ProductsAndGroupsHandler.
See Also

ParseData(string)

Parses the data.
public ParseResult ParseData(string data)

Parameters

data string
The data.

Returns

ParseResult
ParseResult.
See Also

ParseData(string, HandlerConfigurationType)

Parses the data.
public ParseResult ParseData(string data, HandlerConfigurationType defaultDataType)

Parameters

data string
The data.
defaultDataType HandlerConfigurationType
Default type of the data.

Returns

ParseResult
ParseResult.
See Also

ParseData(string, bool)

Parses the data.
public ParseResult ParseData(string data, bool loadDataFromDatabase)

Parameters

data string
The data.
loadDataFromDatabase bool
if set to true [load data from database].

Returns

ParseResult
ParseResult.
See Also

ParseData(string, bool, HandlerConfigurationType)

Parses the data.
public ParseResult ParseData(string data, bool loadDataFromDatabase, HandlerConfigurationType defaultDataType)

Parameters

data string
The data.
loadDataFromDatabase bool
if set to true [load data from database].
defaultDataType HandlerConfigurationType
Default type of the data.

Returns

ParseResult
ParseResult.
See Also

ToString()

Returns a string that represents this instance.
public override string ToString()

Returns

string
A string that represents this instance.
See Also

ToStringOnlyElements()

To the string only elements.
public string ToStringOnlyElements()

Returns

string
System.String.
See Also

See Also

IComparer<T>
IComparer<T>
Edit this page
To top