CardSatelliteHelper - класс

Вспомогательный класс для организации работы расширений для карточек-сателлитов.

Definition

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

Методы

AddSatelliteToList Добавляет карточку-сателлит в список карточек-сателлитов, который должен содержаться в пакете основной карточки. Если список не был создан, то он автоматически создаётся при первом вызове метода.
ClearSatelliteList Очищает список карточек-сателлитов, если он существовал в пакете основной карточки (но не удаляет пустой список из структуры).
CreateSatelliteInfo Создаёт объект SatelliteInfo, содержащий информацию по карточке-сателлиту для задания.
GenerateSatelliteID Возвращает идентификатор сателлита, созданный на основе идентификатора типа сателлита и идентификатора владельца сателлита (карточки или задания).
RemoveSatelliteFromList Удаляет из списка карточек-сателлитов, если он существовал в пакете основной карточки, сателлиты указанного типа. Удаляет пустой список из структуры.
SatelliteCardWasFound Возвращает признак того, что карточка-сателлит была установлена как присутствующая в пакете основной карточки, т.е. не равная null.
SatelliteCardWasNotFound Возвращает признак того, что карточка-сателлит была установлена как отсутствующая в пакете основной карточки.
SetSatellite Сохраняет карточку-сателлит в пакете основной карточки.
SetSatellitesToDeleteIDList Устанавливает список идентификаторов для сателлитов, которые должны быть удалены из указанного в satelliteKey списка сателлитов.
SetupUniversalSatellite Метод для установки параметров универсального сателлита в секцию сателлита.
TryGetMainCardIDAndTaskRowID 
TryGetMainCardIDAndTaskRowIDAsync Возвращает идентификатор основной карточки и идентификатор задания по идентификатору карточки-сателлита задания или null, если сателлит не найден. Возвращает признак того, что карточка запрошенная информация найдена. Вторым значением возвращает идентификатор основной карточки или Guid.Empty, если карточка-сателлит не найдена. Третьим значением возвращает идентификатор задания или Guid.Empty, если карточка-сателлит не найдена.
TryGetMainCardIDByTaskRowIDAsync Возвращает идентификатор основной карточки по идентификатору задания или null, если задание не найдено. Поиск выполняется среди активных заданий и среди записей в истории заданий.
TryGetMainCardIDFromSatelliteIDAsync Возвращает идентификатор основной карточки по идентификатору карточки-сателлита или null, если сателлит не найден.
TryGetSatelliteCard Возвращает карточку-сателлит, которая была установлена в пакете основной карточки, или null, если карточка-сателлит не была установлена или была установлена как отсутствующая.
TryGetSatelliteCardList Возвращает список карточек-сателлитов, который был установлен в пакете основной карточки, или null, если карточки-сателлиты не установлены, т.е. список пустой.
TryGetSatelliteIDAsync Возвращает идентификатор сателлита по идентификатору основной карточки или null, если сателлит ещё не создан.
TryGetSatelliteIDListAsync Возвращает список идентификаторов карточек-сателлитов для заданной основной карточки или null, если список пустой.
TryGetSatelliteInfoListAsync Возвращает список объектов SatelliteInfo, содержащий информацию по карточкам-сателлитам задач для заданной основной карточки, или null, если такие список пустой.
TryGetSatellitesToDeleteIDList Получает список идентификаторов для сателлитов из CardStoreRequest, которые должны быть удалены из указанного в satelliteKey списка сателлитов
TryGetSingleSatelliteCardFromList Возвращает карточку-сателлит, которая была установлена в пакете основной карточки, или , если карточка-сателлит указанного типа не была найдена в списке карточек сателлитов доступном по указанному ключу или список карточек сателлитов не содержит значений.
TryGetTaskSatelliteIDAsync Возвращает идентификатор карточки-сателлита для задания с заданным идентификатором, или null, если для задания отсутствует сателлит.
TryGetUniversalSatelliteIDAsync Возвращает идентификатор сателлита по идентификатору основной карточки, идентификатору задания и типу сателлита или null, если сателлит ещё не создан.
TryGetUniversalSatelliteInfoListAsync Возвращает список объектов SatelliteInfo, содержащий информацию по карточкам-сателлитам задач для заданной основной карточки, или null, если такие список пустой.

Поля

ContextCardInfoKey Имя по умолчанию для дополнительной информации по карточке-сателлиту card.Info, которая доступен при сохранении сателлита-задачи в контексте context.Info.
ContextFilesKey Имя по умолчанию для списка файлов, который доступен при сохранении сателлита-задачи в контексте context.Info.
ContextMainCardIDKey Имя по умолчанию для идентификатора основной карточки, который доступен при сохранении сателлита-задачи в контексте context.Info.
ContextTasksKey Имя по умолчанию для списка заданий, который доступен при сохранении сателлита-задачи в контексте context.Info.
MainCardIDColumn Рекомендуемое имя колонки в карточке-сателлите, которая содержит идентификатор основной карточки.
NextCardIDKey Идентификатор карточки (Guid), которую требуется открыть после успешного сохранения карточки-сателлита. Может отсутствовать, тогда обновляется текущая карточка.
NextCardTypeIDKey Идентификатор типа карточки (Guid), которую требуется открыть после успешного сохранения. Если отсутствует этот ключ, то карточка открывается по идентификатору без указания типа.
SatelliteKey Ключ сателлита по умолчанию для размещения пакета сателлита в пакете основной карточки.
SatellitesKey Ключ, по которому хранятся все сателлиты, зарегистрированные через ISatelliteTypeRegistry.
SatellitesSectionName Имя основной секции с универсальными сателлитами.
SatelliteTypeIDColumn Имя колонки с типом карточки сателлита в универсальной секции SatellitesSectionName
TaskRowIDColumn Имя колонки в карточке-сателлите, которая содержит идентификатор задания, к которому относится сателлит.
VirtualMainCardIDKey Признак того, что карточка-сателлит открыта как виртуальная, поэтому при сохранении надо будет её сначала создать; по ключу располагается идентификатор основной карточки (Guid).

См. также