NumberDirectorBase - класс

Базовый объект, реализующий произвольное взаимодействие с номерами карточек. Предназначен для реализации интерфейсов наподобие INumberDirector.

Definition

Пространство имён: Tessa.Cards.Numbers
Сборка: Tessa (в Tessa.dll) Версия: 4.0.4
C#
public abstract class NumberDirectorBase : NumberBuilder, 
	INumberDirectorBase, INumberExtendable, ISealable
Inheritance
Object    NumberExtendable    NumberBuilder    NumberDirectorBase
Derived
Implements
INumberDirectorBase, INumberExtendable, ISealable

Конструкторы

NumberDirectorBase Создаёт экземпляр класса с указанием его зависимостей.

Свойства

AvailableEventTypes Доступные типы событий, происходящие с номерами. Изменение этой коллекции позволяет отключить обработку некоторых событий для всех карточек, к которым применим текущий объект.
DependenciesОбъект, содержащий внешние зависимости API номеров.
(Унаследован от NumberBuilder)
IsSealedПризнак того, что объект был защищён от изменений.
PrimaryTypeLocation Местоположение номера, всегда соответствующее типу Primary для текущего объекта.
(Унаследован от NumberBuilder)
SecondaryTypeLocation Местоположение номера, всегда соответствующее типу Secondary для текущего объекта.
(Унаследован от NumberBuilder)
UnavailableCardTypes Идентификаторы типов карточек, система нумерации для которых принудительно отключена.

Методы

CreateEmptyNumberAsync Создаёт объект, описывающий пустой номер заданного типа. Возвращённое значение не может быть равно null.
(Унаследован от NumberBuilder)
CreateEmptyNumberCoreAsync Создаёт объект, описывающий пустой номер заданного типа. Возвращённое значение не может быть равно null.
(Унаследован от NumberBuilder)
CreateNumberAsync Создаёт объект, описывающий номер с заданными параметрами. Номер может быть пустым или не пустым в зависимости от параметров. Возвращённое значение не может быть равно null.
(Унаследован от NumberBuilder)
CreateNumberCoreAsync Создаёт объект, описывающий номер с заданными параметрами. Номер может быть пустым или не пустым в зависимости от параметров. Возвращённое значение не может быть равно null.
(Унаследован от NumberBuilder)
EqualsDetermines whether the specified object is equal to the current object.
(Унаследован от Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Унаследован от Object)
FormatNumberAsyncФорматирует текстовое представление номера по заданной строке форматирования.
(Унаследован от NumberBuilder)
FormatSequenceNameAsync Форматирует имя последовательности по заданной строке форматирования.
(Унаследован от NumberBuilder)
GetAsyncTВозвращает типизированные данные для контекста события, происходящего с номером.
(Унаследован от NumberBuilder)
GetBuilder Возвращает объект, осуществляющий низкоуровневые действия с номерами, которые зависят от бизнес-логики. Не возвращает null.
GetBuilderCore Возвращает объект, осуществляющий низкоуровневые действия с номерами, которые зависят от бизнес-логики. Не возвращает null.
GetCoreAsyncTВозвращает типизированные данные для контекста события, происходящего с номером.
(Унаследован от NumberBuilder)
GetFullNumberAsync Возвращает текстовое представление номера по числовому представлению для заданного действия с номером.
(Унаследован от NumberBuilder)
GetFullNumberCoreAsync Возвращает текстовое представление номера по числовому представлению для заданного действия с номером.
(Унаследован от NumberBuilder)
GetHashCodeServes as the default hash function.
(Унаследован от Object)
GetNumberAsync Возвращает номер, расположенный в заданных местоположении и контексте или пустой номер, если он не был найден. Метод не возвращает null.
(Унаследован от NumberBuilder)
GetNumberCoreAsync Возвращает номер, расположенный в заданных местоположении и контексте или пустой номер, если он не был найден. Метод не возвращает null.
(Унаследован от NumberBuilder)
GetNumberFromCardLocationAsync Возвращает номер, расположенный в карточке в месте, указанном в параметре cardLocation, или пустой номер, если номер пуст или его не удалось получить. Метод не возвращает null.
(Унаследован от NumberBuilder)
GetPlaceholderDateTimeUtc Возвращает дату и время в формате UTC, используемую для подстановки в строке для форматирования номера или имени последовательности. По умолчанию возвращает текущую дату.
(Унаследован от NumberBuilder)
GetPlaceholderInfoAsync Создаёт или возвращает объект с дополнительной информацией, необходимой при обращении к API плейсхолдеров. Созданный объект кэшируется в контексте context, чтобы для той же операции он мог повторно использоваться. Например, если в операции форматируются и имя последовательности, и строковое представление номера, то обе операции по форматированию получат один и тот же объект с дополнительной информацией.
(Унаследован от NumberBuilder)
GetTypeGets the Type of the current instance.
(Унаследован от Object)
IsAvailableAsyncВыполняет проверку доступности для типа события, происходящего с номером.
IsAvailableCoreAsyncВыполняет проверку доступности для типа события, происходящего с номером.
MemberwiseCloneCreates a shallow copy of the current Object.
(Унаследован от Object)
MethodReturnedNull Создаёт и возвращает исключение, которое вызывается в случае, когда перегруженный виртуальный метод вернул null, хотя он не должен был возвращать null.
(Унаследован от NumberExtendable)
NotifyAfterEventAsync Выполняет постобработку события, происходящего с номером. Это предоставляет возможность изменить результат обработанного события или сохранить результат во внешнем хранилище.
(Унаследован от NumberExtendable)
NotifyAfterEventCoreAsync Выполняет постобработку события, происходящего с номером. Это предоставляет возможность изменить результат обработанного события или сохранить результат во внешнем хранилище.
(Переопределяет NumberExtendableNotifyAfterEventCoreAsync(INumberContext, CancellationToken))
NotifyBeforeEventAsync Выполняет предварительную обработку события, происходящего с номером. Это предоставляет возможность полностью заместить или отменить стандартную обработку.
(Унаследован от NumberExtendable)
NotifyBeforeEventCoreAsync Выполняет предварительную обработку события, происходящего с номером. Это предоставляет возможность полностью заместить или отменить стандартную обработку.
(Переопределяет NumberExtendableNotifyBeforeEventCoreAsync(INumberContext, CancellationToken))
NotifyOnEventAsyncВыполняет заданное действие с номером.
NotifyOnEventCoreAsyncВыполняет заданное действие с номером.
RemoveNumberQueueAsync Удаляет очередь действий с номерами для заданного контекста. Возвращает признак того, что очередь была найдена и удалена. Возвращает false, если очередь не была найдена.
(Унаследован от NumberBuilder)
RemoveNumberQueueCoreAsync Удаляет очередь действий с номерами для заданного контекста. Возвращает признак того, что очередь была найдена и удалена. Возвращает false, если очередь не была найдена.
(Унаследован от NumberBuilder)
ReplacePlaceholder Заменяет плейсхолдеры в строке для форматирования номера или имени последовательности и возвращает строку, содержащую заменённый плейсхолдер или null, если плейсхолдер заменить не удалось. Неизвестные плейсхолдеры не изменяются в результирующей строке номера.
(Унаследован от NumberBuilder)
SealЗащищает объект от изменений.
SealInternal

Защищает объект от изменений.

Метод может быть переопределён в классах-наследниках.

StoreNumberAsync(INumberContext, INumberObject, NumberStoreMode, CancellationToken)Сохраняет объект с номером в контексте и по местоположению, определяемому его типом.
(Унаследован от NumberBuilder)
StoreNumberAsync(INumberContext, INumberObject, INumberLocation, NumberStoreMode, CancellationToken)Сохраняет объект с номером в заданном местоположении и контексте.
(Унаследован от NumberBuilder)
StoreNumberCoreAsyncСохраняет объект с номером в заданном местоположении и контексте.
(Унаследован от NumberBuilder)
StoreNumberToCardLocation Сохраняет номер в карточку в место, указанное в параметре cardLocation. Возвращает false, если сохранить номер не удалось.
(Унаследован от NumberBuilder)
ToStringReturns a string that represents the current object.
(Унаследован от Object)
TryGetNumberEffectiveLocationAsync Возвращает эффективное местоположение номера по его заданному местоположению или null, если эффективное местоположение недоступно и следует использовать заданное местоположение location. Например, местоположение [Tessa.Cards.Numbers.NumberLocationTypes.Primary] может соответствовать определённым полям в карточке, задаваемым эффективным местоположением типа [Tessa.Cards.Numbers.CardNumberLocation].
(Унаследован от NumberBuilder)
TryGetNumberEffectiveLocationCoreAsync Возвращает эффективное местоположение номера по его заданному местоположению или null, если эффективное местоположение недоступно и следует использовать заданное местоположение location. Например, местоположение [Tessa.Cards.Numbers.NumberLocationTypes.Primary] может соответствовать определённым полям в карточке, задаваемым эффективным местоположением типа [Tessa.Cards.Numbers.CardNumberLocation].
(Унаследован от NumberBuilder)
TryGetNumberLocationAsync Возвращает местоположение номера для заданного типа или null, если местоположение не определено и действие с номером следует отменить.
(Унаследован от NumberBuilder)
TryGetNumberLocationCoreAsync Возвращает местоположение номера для заданного типа или null, если местоположение не определено и действие с номером следует отменить.
(Унаследован от NumberBuilder)
TryGetNumberQueueAsync Возвращает очередь действий с номерами для заданного контекста или null, если очередь недоступна.
(Унаследован от NumberBuilder)
TryGetNumberQueueCoreAsync Возвращает очередь действий с номерами для заданного контекста или null, если очередь недоступна.
(Унаследован от NumberBuilder)
TryGetSequenceNameAsync Возвращает имя последовательности, подходящее для заданного события, происходящего с номером, или null, если последовательность недоступна и операция будет считаться невыполненной.
(Унаследован от NumberBuilder)
TryGetSequenceNameCoreAsync Возвращает имя последовательности, подходящее для заданного события, происходящего с номером, или null, если последовательность недоступна и операция будет считаться невыполненной.
(Унаследован от NumberBuilder)

События

AfterEvent Событие, выполняемое в процессе постобработки события, происходящего с номером. Это предоставляет возможность изменить результат обработанного события или сохранить результат во внешнем хранилище.
(Унаследован от NumberExtendable)
BeforeEvent Событие, выполняемое в процессе предварительной обработки события, происходящего с номером. Это предоставляет возможность полностью заместить или отменить стандартную обработку.
(Унаследован от NumberExtendable)

Поля

UnavailableCardTypesStatic Идентификаторы типов карточек, система нумерации для которых принудительно отключена. Используется по умолчанию в переопределяемом свойстве UnavailableCardTypes.

Методы расширения

EnsureAvailable Гарантирует, что объект INumberDirectorBase в коллекции доступных типов событий AvailableEventTypes будет содержать тип действия eventType. Если коллекция защищена от изменений и тип события в ней отсутствовал, то метод возвращает false.
(Определяется NumberExtensions)
Get
(Определяется ComHelper)
Invoke
(Определяется ComHelper)
Set
(Определяется ComHelper)

См. также