CardTaskExtensionContext - класс

Контекст процесса взаимодействия с заданием.

Definition

Пространство имён: Tessa.Cards.Extensions
Сборка: Tessa (в Tessa.dll) Версия: 4.0.4
C#
public abstract class CardTaskExtensionContext : CardExtensionContext, 
	ICardTaskExtensionContext, ICardExtensionContext, ICardTypeExtensionContext, ITraceableInfoExtensionContext, ITraceableExtensionContext, 
	IExtensionContext
Inheritance
Object    CardTypeExtensionContext    CardExtensionContext    CardTaskExtensionContext
Derived
Implements
ICardExtensionContext, ICardTaskExtensionContext, ICardTypeExtensionContext, IExtensionContext, ITraceableExtensionContext, ITraceableInfoExtensionContext

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

CardTaskExtensionContext Создаёт экземпляр класса с указанием типа сохраняемой карточки, сохраняемого задания и его типа, метаинформации по типам карточек и сессии пользователя, выполняющего операцию.

Свойства

CancellationToken
(Унаследован от CardTypeExtensionContext)
CardMetadataМетаинформация по типам карточек, известным в системе.
(Унаследован от CardExtensionContext)
CardType

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

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


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

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

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


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

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

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


(Унаследован от CardTypeExtensionContext)
DbScope Объект, обеспечивающий взаимодействие с базой данных. Значение равно null на клиенте и не равно null на сервере.
(Унаследован от CardExtensionContext)
EnableTracing Признак того, что для текущего метода расширений разрешена запись сообщения трассировки при включённой в системе трассировке. Установка значения равным false позволяет запретить запись сообщения, например, для реализации метода, которая по умолчанию не выполняет полезной работы. При отключённой сортировке значение равно false.
(Унаследован от CardTypeExtensionContext)
Info Дополнительная информация, связанная с контекстом расширений.
(Унаследован от CardTypeExtensionContext)
RequestIsSuccessful Признак того, что процесс взаимодействия с карточкой завершился успешно. Можно использовать в расширениях, выполняющихся после запроса к сервису.
(Унаследован от CardExtensionContext)
SessionСессия пользователя, для которого выполняется процесс взаимодействия с карточкой.
(Унаследован от CardExtensionContext)
TaskЗадание, для которого выполняется расширение.
TaskTypeТип завершаемого задания.
ValidationResult Объект, выполняющий построение результата валидации. Может использоваться для того, чтобы запретить выполнение процесса стандартными средствами.
(Унаследован от CardTypeExtensionContext)

Методы

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)
GetHashCodeServes as the default hash function.
(Унаследован от Object)
GetTypeGets the Type of the current instance.
(Унаследован от Object)
MemberwiseCloneCreates a shallow copy of the current Object.
(Унаследован от Object)
ToStringReturns a string that represents the current object.
(Унаследован от Object)

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

CardTypeIs Возвращает признак того, что идентификатор типа карточки равен заданному значению.
(Определяется CardExtensionContextExtensions)
CardTypeIs Возвращает признак того, что идентификатор типа карточки равен одному из заданных значений.
(Определяется CardExtensionContextExtensions)
CardTypeIs Возвращает признак того, что идентификатор типа карточки равен одному из заданных значений.
(Определяется CardExtensionContextExtensions)
CardTypeIs Возвращает признак того, что имя типа карточки (свойство CardTypeName) равно одному из заданных значений. Пользуясь данным методом необходимо учитывать, что поле CardType может быть равным null.
(Определяется CardExtensionContextExtensions)
CardTypeIs Возвращает признак того, что имя типа карточки (свойство CardTypeName) равно заданному значению. Пользуясь данным методом необходимо учитывать, что поле CardType может быть равным null.
(Определяется CardExtensionContextExtensions)
CardTypeIs Возвращает признак того, что имя типа карточки (свойство CardTypeName) равно одному из заданных значений. Пользуясь данным методом необходимо учитывать, что поле CardType может быть равным null.
(Определяется CardExtensionContextExtensions)
CardTypeIs Возвращает признак того, что идентификатор типа карточки равен одному из заданных значений.
(Определяется CardExtensionContextExtensions)
CardTypeIs Возвращает признак того, что имя типа карточки (свойство CardTypeName) равно одному из заданных значений. Пользуясь данным методом необходимо учитывать, что поле CardType может быть равным null.
(Определяется CardExtensionContextExtensions)
CardTypeIs Возвращает признак того, что идентификатор типа карточки равен одному из заданных значений.
(Определяется CardExtensionContextExtensions)
CardTypeIs Возвращает признак того, что имя типа карточки (свойство CardTypeName) равно одному из заданных значений. Пользуясь данным методом необходимо учитывать, что поле CardType может быть равным null.
(Определяется CardExtensionContextExtensions)
CardTypeIs Возвращает признак того, что идентификатор типа карточки равен одному из заданных значений.
(Определяется CardExtensionContextExtensions)
CardTypeIs Возвращает признак того, что имя типа карточки (свойство CardTypeName) равно одному из заданных значений. Пользуясь данным методом необходимо учитывать, что поле CardType может быть равным null.
(Определяется CardExtensionContextExtensions)
CreateMetadataBinder Создаёт объект ICardMetadataBinder для удаления строк из коллекционных секций для указанной карточки.
(Определяется CardExtensions)
Get
(Определяется ComHelper)
Invoke
(Определяется ComHelper)
Set
(Определяется ComHelper)
SetActionHistoryRowID Устанавливает идентификатор записи в историю действий, которая была записана в процессе обработки запроса, или null, если требуется удалить предыдущий идентификатор.
(Определяется CardRequestExtensions)
SetCardAccessAsync Устанавливает доступ на редактирование полей указанной секции карточки в серверный токен безопасности, который хранится в дополнительной информации контекста расширений карточки.
(Определяется KrPermissionExtensions)
SetCardAccessAsync Устанавливает доступ на редактирование полей указанной секции карточки в серверный токен безопасности, который хранится в дополнительной информации контекста расширений карточки.
(Определяется KrPermissionExtensions)
SetContextData Устанавливает данные в контексте цепочки расширений для заданного объекта-отправителя sender. Данные существует в пределах цепочки расширений.
(Определяется CardRequestExtensions)
TryGetActionHistoryRowID Возвращает идентификатор записи в историю действий, которая была записана в процессе обработки запроса, или null, если записи в истории действий не было сделано.
(Определяется CardRequestExtensions)
TryGetContextDataT Возвращает данные, записанные методом SetContextData(ICardExtensionContext, Object, Object) в контекст цепочки расширений для заданного объекта-отправителя sender. Данные существует в пределах цепочки расширений. Возвращает null, если данные не найдены или были установлены как null.
(Определяется CardRequestExtensions)

См. также