ICardRepairExtensionContext - интерфейс

Контекст расширений на исправление структуры карточки.

Definition

Пространство имён: Tessa.Cards.Extensions
Сборка: Tessa (в Tessa.dll) Версия: 4.0.4
C#
public interface ICardRepairExtensionContext : ICardRepairOptions, 
	ICardTypeExtensionContext, ITraceableInfoExtensionContext, ITraceableExtensionContext, IExtensionContext
Implements
ICardTypeExtensionContext, ICardRepairOptions, IExtensionContext, ITraceableExtensionContext, ITraceableInfoExtensionContext

Свойства

CancellationToken Объект, посредством которого можно отменить асинхронную задачу.
(Унаследован от IExtensionContext)
CardКарточка, для которой выполняется исправление структуры.
CardMetadataМетаинформация по типам карточек.
CardType

Тип карточки или null, если тип карточки неизвестен.

Данное свойство следует устанавливать, если оно еще не задано, но необходимо предоставить информацию о типе в цепочке расширений. Например, в методе [ICardGetExtension.BeforeRequest] можно задать тип, а в методах [ICardGetExtension.BeforeRequestWhenTypeResolved] или [ICardGetExtension.AfterRequest] проверить его напрямую. Также это может пригодиться при проверке типа методом [CardExtensions.WhenCardTypes].


(Унаследован от ICardTypeExtensionContext)
CardTypeIsVerified

Признак того, что заданный тип карточки является корректным в рамках текущего запроса. Если тип не является корректным, то перед выполнением метода BeforeRequestWhenTypeResolved он будет определен из базы данных по идентификатору карточки, переданныму в запросе.

Поле используется только на сервере, в клиентской части его использование бессмысленно. Если запрос пришел с клиента, то при создании контекста устанавливается значение false. Ручное изменение свойств [CardType] и [CardTypeName] автоматически установит его как true.


(Унаследован от ICardTypeExtensionContext)
CardTypeName

Уникальное имя типа карточки или null, если тип карточки неизвестен. Имя может не соответствовать действительному типу в метаинформации.

Данное свойство следует устанавливать, если оно еще не задано, но необходимо предоставить информацию о типе в цепочке расширений. Например, в методе [ICardGetExtension.BeforeRequest] можно задать тип, а в методах [ICardGetExtension.BeforeRequestWhenTypeResolved] или [ICardGetExtension.AfterRequest] проверить его напрямую. Также это может пригодиться при проверке типа методом [CardExtensions.WhenCardTypes].


(Унаследован от ICardTypeExtensionContext)
DefaultManagerОбъект, управляющий исправлением структуры карточки без расширений.
EnableTracing Признак того, что для текущего метода расширений разрешена запись сообщения трассировки при включённой в системе трассировке. Установка значения равным false позволяет запретить запись сообщения, например, для реализации метода, которая по умолчанию не выполняет полезной работы. При отключённой сортировке значение равно false.
(Унаследован от ITraceableExtensionContext)
ErrorsOnly Признак, определяющий, что в результат валидации должны записываться только ошибки.
(Унаследован от ICardRepairOptions)
ExtendedManagerОбъект, управляющий исправлением структуры карточки с расширениями.
Info Дополнительная информация, связанная с контекстом расширений.
(Унаследован от ITraceableInfoExtensionContext)
NewMode Способ заполнения добавляемых в карточку полей, который соответствует способу создания карточки.
(Унаследован от ICardRepairOptions)
NotifyFieldsUpdated Признак того, что в пакете карточки для изменённых полей должны записываться уведомления об изменённых полях.
(Унаследован от ICardRepairOptions)
ParentContext Контекст по исправлению родительской карточки или null, если текущая исправляемая карточка не связана с родительской карточкой, т.е. не является сателлитом.
RequestIsSuccessful Признак того, что исправление структуры карточки выполнено успешно. Свойство принимает актуальное значение только после того, как исправление структуры было выполнено стандартными средствами.
ValidationResult Объект, выполняющий построение результата валидации. Может использоваться для того, чтобы запретить выполнение процесса стандартными средствами.
(Унаследован от ITraceableExtensionContext)

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

RepairAsync Выполняет исправление структуры заданной карточки на основании данных в контексте расширений по исправлению карточки. Метод полезен для исправления карточек-сателлитов, связанных с основной исправляемой карточкой. После исправления любые сообщения будут записаны в результат валидации текущего контекста. Возвращает признак того, что исправление выполнено успешно, т.е. без ошибок, предотвращающих использование карточки.
(Определяется CardExtensions)

См. также