INumberContext - интерфейс

Контекст события, происходящего с номером, о котором уведомляется объект INumberDirector.

Definition

Пространство имён: Tessa.Cards.Numbers
Сборка: Tessa (в Tessa.dll) Версия: 3.6.0.22
C#
public interface INumberContext : INumberDependencies, 
	ISealable
Implements
INumberDependencies, ISealable

Свойства

Builder Объект, осуществляющий низкоуровневые действия с номерами, которые зависят от бизнес-логики. Если объект недоступен или уже был установлен, то выбрасывается исключение [System.InvalidOperationException].
CanCancel Признак того, что свойство [Tessa.Cards.Numbers.INumberContext.Cancel] содержит информацию об отмене действия и его значение можно изменить.
Cancel Признак того, что действие должно быть отменено для [Tessa.Cards.Numbers.INumberExtendable.NotifyBeforeEventAsync] или было отменено для [Tessa.Cards.Numbers.INumberExtendable.NotifyAfterEventAsync]. По умолчанию свойство равно false.
CanChangeNumber Признак того, что значение свойства [Tessa.Cards.Numbers.INumberContext.NumberObject] можно изменить.
CanHandle Признак того, что свойство [Tessa.Cards.Numbers.INumberContext.Handled] содержит информацию об успешной обработке действия и его значение можно изменить.
Card

Карточка, для которой производится работа с номером.

В методе [Tessa.Cards.Numbers.INumberDirectorBase.IsAvailableAsync] для события [Tessa.Cards.Numbers.NumberEventTypes.DeletingCardWithoutBackup] может отсутствовать любая информация по карточке для оптимизации загрузки секций удаляемой карточки. Поэтому в этом случае, если в карточке нет секций, рекомендуется не выполнять никаких проверок. Метод будет позже вызван ещё раз для того же действия.

Во всех остальных случаях для того, чтобы гарантировать успешную обработку в расширениях, в карточке должны присутствовать системная информация и все секции, но могут отсутствовать файлы и задания.

CardTypeТип карточки, для которой будет производиться работа с номером.
Composer Объект, обрабатывающий логику выделения и изменения номеров карточек. Если объект недоступен или уже был установлен, то выбрасывается исключение [System.InvalidOperationException].
ContextInfo Доступная только для чтения информация из внешнего контекста, используемая при обработке события, происходящего с номером. Обычно в расширениях UI это ICardModel.Info, а в других расширениях, связанных с карточками, это Info запроса.
DbScope Объект, предоставляющий доступ к базе данных, или null, если выполнение происходит без доступа к базе данных, например, со стороны клиента.
(Унаследован от INumberDependencies)
Director Объект, управляющий взаимодействием с номерами карточек. Если объект недоступен или уже был установлен, то выбрасывается исключение [System.InvalidOperationException].
EventType Тип события, происходящего с номером. Если событие не было установлено, то возвращается [Tessa.Cards.Numbers.NumberEventTypes.Unknown]. Установить значение можно единственный раз, причём нельзя установить null или [Tessa.Cards.Numbers.NumberEventTypes.Unknown].
ExternalContextОбъект внешнего контекста, используемый при обработке события, происходящего с номером.
Handled Признак того, что действие было успешно обработано, если свойство [Tessa.Cards.Numbers.INumberContext.CanHandle] возвращает true. В противном случае значене равно false, что следует трактовать как "информация о выполнении неизвестна".
HasBuilder Признак того, что объект [Tessa.Cards.Numbers.INumberContext.Builder] был задан, и обращение к свойству не приведёт к исключению.
HasComposer Признак того, что объект [Tessa.Cards.Numbers.INumberContext.Composer] был задан, и обращение к свойству не приведёт к исключению.
HasDirector Признак того, что объект [Tessa.Cards.Numbers.INumberContext.Director] был задан, и обращение к свойству не приведёт к исключению.
HasEventType Признак того, что объект [Tessa.Cards.Numbers.INumberContext.EventType] был задан, и обращение к свойству вернёт действительное значение.
Info Произвольно структурированная информация, используемая при обработке события, происходящего с номером.
IsSealedПризнак того, что объект был защищён от изменений.
(Унаследован от ISealable)
NumberObjectОбъект, определяющий свойства номера и средства его хранения.
PlaceholderInfo Информация, передаваемая в свойство IPlaceholderContext.Info при замене плейсхолдеров в формате номера, формате последовательности или в других случаях, когда для API номеров требуется задействовать API плейсхолдеров.
PlaceholderManagerОбъект, управляющий операциями с плейсхолдерами.
(Унаследован от INumberDependencies)
RequestRepositoryРепозиторий, используемый для построения универсальных запросов к API номеров на сервере.
(Унаследован от INumberDependencies)
SerializableInfo Сериализуемая информация, которая может быть передана при обмене данными между клиентом и сервером. Обычно это информация из методов, связанных с элементом управления номерами, которую можно получить из сервера в клиентском NumberControlResponse.Info. Запрещено использовать это свойство для хранения несериализуемых объектов, т.к. это приведёт к ошибке при сериализации данных.
SessionСессия текущего пользователя.
(Унаследован от INumberDependencies)
TransactionMode Получает или задаёт способ выполнения запросов, связанных с номерами.
UnityContainerКонтейнер Unity, который может использоваться для получения дополнительных зависимостей.
(Унаследован от INumberDependencies)
ValidationResultИнформация по результату события, происходящего с номером.

Методы

SealЗащищает объект от изменений.
(Унаследован от ISealable)

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

ExecuteNumberActionAsync Выполняет ранее установленное действие с номером по заданному ключу. Если действие не было установлено, то возвращает false.
(Определяется NumberExtensions)
Initialize Выполняет инициализацию свойств для контекста действий с номером, если они не были инициализированы: Director, Builder и EventType. Инициализация вызывается автоматически для вызова расширяемых методов INumberDirector.
(Определяется NumberExtensions)
SetControl Устанавливает в контексте элемент управления номерами, который инициировал событие, происходящее с номером.
(Определяется NumberExtensions)
SetControlLocation Устанавливает в контексте информацию по местоположению номера в карточке для элемента управления номерами, который инициировал событие, происходящее с номером.
(Определяется NumberExtensions)
SetControlName Устанавливает в контексте имя элемента управления номерами, который инициировал событие, происходящее с номером.
(Определяется NumberExtensions)
SetNumberAction Устанавливает в контексте действие с номером, доступное по заданному ключу. Значение null, переданное в параметр numberActionAsync, приводит к удалению ранее заданного действия.
(Определяется NumberExtensions)
TryGetControlT Возвращает элемент управления номерами, который инициировал событие, происходящее с номером, или null, если элемент управления неизвестен или если его тип отличен от заданного.
(Определяется NumberExtensions)
TryGetControlLocation Возвращает информацию по местоположению номера в карточке для элемента управления номерами, который инициировал событие, происходящее с номером, или null, если местоположение неизвестно.
(Определяется NumberExtensions)
TryGetControlName Возвращает имя (алиас) элемента управления номерами, который инициировал событие, происходящее с номером, или null, если элемент управления неизвестен или если его тип отличен от заданного.
(Определяется NumberExtensions)

См. также