CardComponentHelper - класс

Вспомогательные методы и константы для компонентов API карточек.

Definition

Пространство имён: Tessa.Cards.ComponentModel
Сборка: Tessa (в Tessa.dll) Версия: 4.0.4
C#
public static class CardComponentHelper
Inheritance
Object    CardComponentHelper

Методы

AddDamagedCardTypeValidationResultAsync Добавляет в validationResult результаты валидации, относящиеся к указанному типу.
CheckCardAndFileRelationWithFileVersionAsync Метод выполняет проверку соответствия версии файла указанной карточке документа и файлу.
CheckCardTypeAsync(Guid, NullableGuid, String, ICardMetadata, IValidationResultBuilder, Object, CancellationToken) Метод выполняет проверку предполагаемого типа карточки с актуальным, если информация по предполагаемому типу была указана. В случае несовпадения в результат валидации validationResult будет записано сообщение об ошибке, а метод вернёт false.
CheckCardTypeAsync(ICardGetStrategy, IConfigurationInfoProvider, Guid, NullableGuid, String, ICardMetadata, IValidationResultBuilder, Object, CancellationToken) Метод выполняет проверку предполагаемого типа карточки с актуальным, если информация по предполагаемому типу была указана. В случае несовпадения в результат валидации validationResult будет записано сообщение об ошибке, а метод вернёт false.
CleanCardAsync Очищает место, отведённое для контента файлов, принадлежащих карточке.
CleanFilesAsync Очищает место, отведённое для контента файла. Метод вызывается перед удалением файла.
CreateResponse Возвращает ответ на универсальный запрос к сервису карточек по заданному запросу.
DeleteContentsAsync Удаляет контенты версий файлов, определяемые заданным списком контекстов.
ExtendRequestAsyncTRequest, TResponse, TContext, TExtension Дополняет запрос к API карточек цепочками расширений.
ExtendRequestWithTypeResolvingAsyncTRequest, TResponse, TContext, TExtension Дополняет запрос к API карточек цепочками расширений с определением типа карточки в запросе и контексте.
FillAuthorTaskAssignedRoleRowID Заполняет AuthorTaskAssignedRoleRowID данными из БД.
FillTaskAssignedRolesAsync(CardTask, IDbScope, Boolean, CancellationToken) Если RolesCached = false, заполняет коллекцию TaskAssignedRoles недостающими записями из БД.
FillTaskAssignedRolesAsync(CardTask, DbManager, IQueryBuilderFactory, Boolean, CancellationToken) Если RolesCached не true, заполняет коллекцию TaskAssignedRoles недостающими записями из БД.
FillTaskSessionRolesAsync Заполняет коллекцию TaskSessionRoles недостающими записями из БД.
FixAfterExport(Card) Исправляет структуру карточки после экспорта для того, чтобы её можно было использовать для импорта или для создания по шаблону. Метод устанавливает версию карточку, равную 0, а также исправляет файлы и задания (при этом не изменяются секции).
FixAfterExport(CardFile) Исправляет структуру файла после экспорта для того, чтобы её можно было использовать для импорта или для создания по шаблону.
FixAfterExport(CardTask) Исправляет структуру задания после экспорта для того, чтобы её можно было использовать для импорта.
GetContentContextsAsync Возвращает список контекстов, описывающий все версии для заданного списка файлов.
GetInvalidInstanceTypeResponseTResponse Возвращает запрос с сообщением об ошибке валидации, обозначающей несоответствие типа экземпляра для заданного типа карточки cardType и ожидаемого типа экземпляра expectedInstanceType.
GetStoreMode Возвращает способ сохранения карточки по её версии.
GetTaskAssignedRolesAsync Получает все роли для задания.
IsAllowedPhysicalColumn Возвращает признак того, что колонка с заданным именем columnName присутствует в указанном списке columns и является физической колонкой.
IsTemporaryTaskRole Возвращает признак того, что роль с заданным идентификатором типа является или заменена на временную роль задания и должна быть удалена после завершения задания.
TryGetCardTypeAsync(Guid, ICardMetadata, CancellationToken) Возвращает тип карточки по заданному идентификатору, или null, если тип карточки не найден.
TryGetCardTypeAsync(NullableGuid, String, ICardMetadata, CancellationToken) Возвращает тип карточки по заданному идентификатору или имени, или null, если идентификатор и имя равны null или тип карточки не найден по заданным идентификатору или имени.
TryGetFileNameAsync Возвращает имя файла с указанным идентификатором в соответствии с базой данных.
TryGetFileVersionNameAsync Возвращает имя версии файла с указанным идентификатором в соответствии с базой данных.
TryGetMasterTaskAssignedRole Получает мастер-роль для задания из объекта task. Запишет ошибку в validationResult если роль с пометкой "Master" не будет найдена.
TryGetMasterTaskAssignedRoleAsync(Guid, DbManager, IQueryBuilderFactory, CancellationToken) Получает мастер-роль для задания из БД.
TryGetMasterTaskAssignedRoleAsync(CardTask, IValidationResultBuilder, Type, DbManager, IQueryBuilderFactory, Boolean, CancellationToken) Возвращает ФРЗ с пометкой "Master". На основе неё определяется временная зона и календарь. Запишет ошибку в validationResult, если роль с пометкой "Master" не будет найдена.
TryGetUserInfo Возвращает информацию о пользователе по объекту сессии или false, если информацию невозможно получить.

Поля

CardTaskAssignedRoleFactory Фабрика, используемая для создания объекта ListStorage<CardTaskAssignedRole>, который содержит запись функциональной роли, которая связана с CardTask.
CardTaskSessionRoleFactory Фабрика, используемая для создания объекта ListStorage<CardTaskSessionRole>, который содержит TaskRoleID функциональной роли задания, к которой относится текущая сессия, связанная с CardTask и признак, относится ли она как заместитель.
ContentFileDataKey Ключ для содержимого файла, выгруженного в текстовый формат JSON.
ContentFileIDKey Ключ для идентификатора файла, который записывается рядом с его содержимым в карточке, выгруженной в текстовый формат JSON.
ContentFileReferenceKey Ключ для содержимого файла, выгруженного в текстовый формат JSON.
ContentFileSizeKey Ключ для размера файла, который записывается рядом с его содержимым в карточке, выгруженной в текстовый формат JSON.
DoNotCheckVersion Значение версии, которое передаётся в метод ExecuteInWriterLockAsync(Guid, Int32, IValidationResultBuilder, FuncICardTransactionParameter, Task, CancellationToken) для того, чтобы обозначить, что проверка версии не требуется. Это имеет смысл при удалении карточки.
FileFactory Фабрика, используемая для создания объекта ListStorage<CardFile>, который содержит файлы карточки.
FileMappingFactory Фабрика, используемая для создания объекта ListStorage<CardFileContentMapping>, который содержит объекты маппинга сохраняемого контента.
RowFactory Фабрика, используемая для создания объекта ListStorage<CardRow>, который содержит строки коллекционной и древовидной секции.
SectionFactory Фабрика, используемая для создания объекта StringDictionaryStorage<CardSection>, который содержит секции карточки.
SectionRowsFactory Фабрика, используемая для создания объекта StringDictionaryStorage<CardRow>, который содержит пустые строки коллекционных и древовидных секций.
TaskFactory Фабрика, используемая для создания объекта ListStorage<CardTask>, который содержит задания карточки.
TaskHistoryFactory Фабрика, используемая для создания объекта ListStorage<CardTaskHistoryItem>, который содержит записи в истории действий карточки.
TaskHistoryGroupFactory Фабрика, используемая для создания объекта ListStorage<CardTaskHistoryGroup>, который содержит группы в истории действий карточки.
TemporaryTaskRoleTypeIDList Идентификаторы типов ролей, которые являются временными ролями заданий.

См. также