NumberBuilder - класс

Базовый класс для объекта, осуществляющего низкоуровневые действия с номерами, которые зависят от бизнес-логики.

Definition

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

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

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

Свойства

DependenciesОбъект, содержащий внешние зависимости API номеров.
PrimaryTypeLocation Местоположение номера, всегда соответствующее типу Primary для текущего объекта.
SecondaryTypeLocation Местоположение номера, всегда соответствующее типу Secondary для текущего объекта.

Методы

CreateEmptyNumberAsync Создаёт объект, описывающий пустой номер заданного типа. Возвращённое значение не может быть равно null.
CreateEmptyNumberCoreAsync Создаёт объект, описывающий пустой номер заданного типа. Возвращённое значение не может быть равно null.
CreateNumberAsync Создаёт объект, описывающий номер с заданными параметрами. Номер может быть пустым или не пустым в зависимости от параметров. Возвращённое значение не может быть равно null.
CreateNumberCoreAsync Создаёт объект, описывающий номер с заданными параметрами. Номер может быть пустым или не пустым в зависимости от параметров. Возвращённое значение не может быть равно null.
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Форматирует текстовое представление номера по заданной строке форматирования.
FormatSequenceNameAsync Форматирует имя последовательности по заданной строке форматирования.
GetT Возвращает значение поля в строковой секции карточки. Поле обязано присутствовать в секции.
GetAsyncTВозвращает типизированные данные для контекста события, происходящего с номером.
GetCoreAsyncTВозвращает типизированные данные для контекста события, происходящего с номером.
GetDefaultSequenceName Возвращает имя последовательности, рекомендуемое для организации номеров карточек.
GetFullNumberAsync Возвращает текстовое представление номера по числовому представлению для заданного действия с номером.
GetFullNumberCoreAsync Возвращает текстовое представление номера по числовому представлению для заданного действия с номером.
GetHashCodeServes as the default hash function.
(Унаследован от Object)
GetNumberAsync Возвращает номер, расположенный в заданных местоположении и контексте или пустой номер, если он не был найден. Метод не возвращает null.
GetNumberCoreAsync Возвращает номер, расположенный в заданных местоположении и контексте или пустой номер, если он не был найден. Метод не возвращает null.
GetNumberFromCardLocationAsync Возвращает номер, расположенный в карточке в месте, указанном в параметре cardLocation, или пустой номер, если номер пуст или его не удалось получить. Метод не возвращает null.
GetPaddedNumber Возвращает строку, дополненную спереди нулями до заданного размера.
GetPlaceholderDateTimeUtc Возвращает дату и время в формате UTC, используемую для подстановки в строке для форматирования номера или имени последовательности. По умолчанию возвращает текущую дату.
GetPlaceholderInfoAsync Создаёт или возвращает объект с дополнительной информацией, необходимой при обращении к API плейсхолдеров. Созданный объект кэшируется в контексте context, чтобы для той же операции он мог повторно использоваться. Например, если в операции форматируются и имя последовательности, и строковое представление номера, то обе операции по форматированию получат один и тот же объект с дополнительной информацией.
GetTypeGets the Type of the current instance.
(Унаследован от Object)
MemberwiseCloneCreates a shallow copy of the current Object.
(Унаследован от Object)
MethodReturnedNull Создаёт и возвращает исключение, которое вызывается в случае, когда перегруженный виртуальный метод вернул null, хотя он не должен был возвращать null.
(Унаследован от NumberExtendable)
NotifyAfterEventAsync Выполняет постобработку события, происходящего с номером. Это предоставляет возможность изменить результат обработанного события или сохранить результат во внешнем хранилище.
(Унаследован от NumberExtendable)
NotifyAfterEventCoreAsync Выполняет постобработку события, происходящего с номером. Это предоставляет возможность изменить результат обработанного события или сохранить результат во внешнем хранилище.
(Унаследован от NumberExtendable)
NotifyBeforeEventAsync Выполняет предварительную обработку события, происходящего с номером. Это предоставляет возможность полностью заместить или отменить стандартную обработку.
(Унаследован от NumberExtendable)
NotifyBeforeEventCoreAsync Выполняет предварительную обработку события, происходящего с номером. Это предоставляет возможность полностью заместить или отменить стандартную обработку.
(Унаследован от NumberExtendable)
RemoveNumberQueueAsync Удаляет очередь действий с номерами для заданного контекста. Возвращает признак того, что очередь была найдена и удалена. Возвращает false, если очередь не была найдена.
RemoveNumberQueueCoreAsync Удаляет очередь действий с номерами для заданного контекста. Возвращает признак того, что очередь была найдена и удалена. Возвращает false, если очередь не была найдена.
ReplacePlaceholder Заменяет плейсхолдеры в строке для форматирования номера или имени последовательности и возвращает строку, содержащую заменённый плейсхолдер или null, если плейсхолдер заменить не удалось. Неизвестные плейсхолдеры не изменяются в результирующей строке номера.
StoreNumberAsync(INumberContext, INumberObject, NumberStoreMode, CancellationToken)Сохраняет объект с номером в контексте и по местоположению, определяемому его типом.
StoreNumberAsync(INumberContext, INumberObject, INumberLocation, NumberStoreMode, CancellationToken)Сохраняет объект с номером в заданном местоположении и контексте.
StoreNumberCoreAsyncСохраняет объект с номером в заданном местоположении и контексте.
StoreNumberToCardLocation Сохраняет номер в карточку в место, указанное в параметре cardLocation. Возвращает false, если сохранить номер не удалось.
ToStringReturns a string that represents the current object.
(Унаследован от Object)
TryGetT Возвращает значение поля в строковой секции карточки или значение по умолчанию для типа T, если поле или секция отсутствуют.
TryGetNumberEffectiveLocationAsync Возвращает эффективное местоположение номера по его заданному местоположению или null, если эффективное местоположение недоступно и следует использовать заданное местоположение location. Например, местоположение [Tessa.Cards.Numbers.NumberLocationTypes.Primary] может соответствовать определённым полям в карточке, задаваемым эффективным местоположением типа [Tessa.Cards.Numbers.CardNumberLocation].
TryGetNumberEffectiveLocationCoreAsync Возвращает эффективное местоположение номера по его заданному местоположению или null, если эффективное местоположение недоступно и следует использовать заданное местоположение location. Например, местоположение [Tessa.Cards.Numbers.NumberLocationTypes.Primary] может соответствовать определённым полям в карточке, задаваемым эффективным местоположением типа [Tessa.Cards.Numbers.CardNumberLocation].
TryGetNumberLocationAsync Возвращает местоположение номера для заданного типа или null, если местоположение не определено и действие с номером следует отменить.
TryGetNumberLocationCoreAsync Возвращает местоположение номера для заданного типа или null, если местоположение не определено и действие с номером следует отменить.
TryGetNumberQueueAsync Возвращает очередь действий с номерами для заданного контекста или null, если очередь недоступна.
TryGetNumberQueueCoreAsync Возвращает очередь действий с номерами для заданного контекста или null, если очередь недоступна.
TryGetSequenceNameAsync Возвращает имя последовательности, подходящее для заданного события, происходящего с номером, или null, если последовательность недоступна и операция будет считаться невыполненной.
TryGetSequenceNameCoreAsync Возвращает имя последовательности, подходящее для заданного события, происходящего с номером, или null, если последовательность недоступна и операция будет считаться невыполненной.

События

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

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

DereserveWhenTabIsClosedOrRefreshedAsync Добавляет запись в очередь действий с номерами, которая вызовет дерезервирование заданного номера number при закрытии вкладки карточки или при её переоткрытии (например, в процессе сохранения).
(Определяется NumberExtensions)
Get
(Определяется ComHelper)
GetNumberAsync Возвращает номер, расположенный в заданных местоположении и контексте или пустой номер, если он не был найден. Метод не возвращает null.
(Определяется NumberExtensions)
Invoke
(Определяется ComHelper)
ReleaseAndCommitAtServerAsync Добавляет запись в очередь действий с номерами, которая вызовет освобождение заданного номера number при сохранении карточки. Вторым параметром возвращает действие, выполняемое для отмены операции по освобождению номера, или null, если отсутствуют действия для отмены.
(Определяется NumberExtensions)
ReserveAndCommitAtServerAsync Резервирует номер заданного типа и добавляет запись в очередь действий с номерами, которая вызовет выделение номера при сохранении карточки. Возвращает зарезервированный номер или пустой номер, если зарезервировать номер не удалось или в процессе выполнения произошли ошибки.
(Определяется NumberExtensions)
Set
(Определяется ComHelper)

См. также