RandomCodeGenerator Class

Class generating random coupon codes according to specified pattern.

Inheritance Hierarchy

System.Object
  CMS.Ecommerce.RandomCodeGenerator

Namespace: CMS.Ecommerce
Assembly: CMS.Ecommerce (in CMS.Ecommerce.dll) Version: 9.0.0

Syntax

public class RandomCodeGenerator

The RandomCodeGenerator type exposes the following members.

Constructors

	Name	Description
Public method	RandomCodeGenerator	Initializes new instance of RandomCodeGenerator generating random codes starting with prefix. Format of codes is specified by codePattern parameter.

Fields

	Name	Description
Protected field Static member	digits	Digits 0-9.
Protected field Static member	chars	Characters A-Z.
Protected field	pattern	Pattern of generated codes. It is set via constructor.
Protected field	prefix	Prefix of codes. This string will be added at the beginning of all generated codes.
Protected field Static member	symbols	Symbols A-Z and 0-9.

Properties

	Name	Description
Public property	CodeChecker	Function returning true when its parameter represents acceptable code.

Methods

	Name	Description
Protected method	CodeIsUnique	Checks if given code is unique - not generated yet and accepted by CodeChecker function.
Public method	GenerateCode	Generates one new unique code. Throws exception when not able to generate unique code within 10 attempts.
Protected method	GetRandomDigit	Returns random digit 0-9.
Protected method	GetRandomChar	Returns random character A-Z.
Protected method	GetRandomNumber	Returns random number from 0 to max (exclusive).
Protected method	GetRandomSymbol	Returns random symbol 0-9 or A-Z.
Protected method	GetSymbolForType	Returns charType. Override this method to add custom character sets.
Protected method	RememberCode	Remembers given code as already generated.
Protected method	TryGenerateCode	Generates one random code.