[StorageObjectGeneratorAttribute]
public sealed class CardGetRequest : CardRequestBase,
ICloneable
<StorageObjectGeneratorAttribute>
Public NotInheritable Class CardGetRequest
Inherits CardRequestBase
Implements ICloneable
[StorageObjectGeneratorAttribute]
public ref class CardGetRequest sealed : public CardRequestBase,
ICloneable
[<SealedAttribute>]
[<StorageObjectGeneratorAttribute>]
type CardGetRequest =
class
inherit CardRequestBase
interface ICloneable
end
CardGetRequest | Создаёт экземпляр класса и пустое хранилище Dictionary<string, object>, декоратором для которого является создаваемый объект. |
CardGetRequest(DictionaryString, Object) | Создаёт экземпляр класса с указанием хранилища, декоратором для которого является создаваемый объект. |
CardGetRequest(IStorageObjectProvider) | Создаёт экземпляр класса с указанием объекта, предоставляющего доступ к хранилищу, декоратором для которого является создаваемый объект. |
CardID |
Идентификатор запрашиваемой карточки
или null, если запрашивается виртуальная карточка, идентификатор которой задаётся другим способом.
(Унаследован от CardRequestBase) |
CardTypeID |
Идентификатор типа карточки. Значение необязательно для заполнения.
(Унаследован от CardRequestBase) |
CardTypeName |
Имя типа карточки. Значение необязательно для заполнения.
(Унаследован от CardRequestBase) |
CompressionMode | Способ сжатия карточки. |
Dynamic |
Объект, осуществляющий доступ к текущему объекту через позднее связывание свойств.
(Унаследован от CardInfoStorageObject) |
DynamicInfo |
Объект, осуществляющий доступ к дополнительной пользовательской информации
по текущему объекту через позднее связывание свойств.
(Унаследован от CardInfoStorageObject) |
ExportFormat | Формат файла для экспорта карточки. Актуально только при указании Method равным Export. |
GetMode | Способ открытия карточки. |
GetTaskMode | Способ загрузки заданий в открываемой карточке. |
Info |
Дополнительная пользовательская информация.
(Унаследован от CardInfoStorageObject) |
Method | Способ загрузки карточки. |
NewMode | Способ создания пустых строк для карточки. |
RestrictionFlags | Флаги, ограничивающие загружаемую по карточке информацию. По умолчанию загружаемая информация не ограничивается. |
SectionsToExclude | Список имён физических секций, которые не следует загружать. Не влияет на виртуальные секции. |
ServiceType | Тип сервиса, от которого был получен текущий объект запроса. Позволяет определить надёжность данных в запросе. При сериализации значение не передаётся с клиента на сервер. Это свойство используется платформой, не рекомендуется устанавливать его значение вручную. (Унаследован от CardRequestBase) |
SkipTypeResolving | Определяет необходимость проверки типа карточки в запросе. При сериализации значение не передаётся с клиента на сервер. Это свойство используется платформой, не рекомендуется устанавливать его значение вручную. (Унаследован от CardRequestBase) |
TasksToUnlockRowIDList | Список идентификаторов заданий, все данные которых будут полностью загружены, если такие задания доступны от имени автора. |
Clean | Выполняет очистку хранилища от избыточных данных. (Унаследован от CardRequestBase) |
CleanCollectionAndSetNullIfEmpty |
Очищает коллекцию, найденную по ключу key, после чего устанавливает null
на место коллекции, если она стала пустой.
(Унаследован от StorageObject) |
ClearCache |
Очищает внутренний кэш декораторов.
(Унаследован от StorageObject) |
Clone | Выполняет глубокое клонирование хранилища объекта и возвращает созданный строго типизированный декоратор для хранилища. |
ContainsKey |
Возвращает признак того, что элемент с заданным ключом содержится в хранилище.
(Унаследован от StorageObject) |
EnsureCacheResolved |
Инициализирует объект-обёртку для всех значений, в т.ч. для вложенных объектов.
Рекомендуется выполнять при создании заполненного объекта перед асинхронным обращением к его вложенным объектам.
(Переопределяет CardInfoStorageObjectEnsureCacheResolved) |
Equals | Determines whether the specified object is equal to the current object. (Унаследован от Object) |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Унаследован от Object) |
FromJsonCore |
Устанавливает содержимое объекта в соответствии с данными, десериализованными из текстового JSON.
Возвращает текущий объект для цепочки вызовов.
Рассмотрите использование метода ToTypedJson(Boolean) для сериализации с сохранением полной информации по типам,
которую можно будет восстановить в методе FromTypedJson.
(Унаследован от StorageObject) |
FromTypedJson | Устанавливает содержимое объекта в соответствии с данными, десериализованными из текстового JSON с сохранением типов. Используйте метод [Tessa.Platform.Storage.StorageObject.ToTypedJson] для сериализации с сохранением типов. Для десериализации других объектов, у которых нет метода FromTypedJson (например, request/response), используйте метод [Tessa.Platform.Storage.StorageHelper.DeserializeFromTypedJson], записав полученную структуру в объект obj.SetStorage(storage). |
FromTypedJsonCore |
Устанавливает содержимое объекта в соответствии с данными, десериализованными из текстового JSON с сохранением типов.
Используйте метод ToTypedJson(Boolean) для сериализации с сохранением типов.
Для десериализации других объектов, у которых нет метода FromTypedJson (например, request/response),
используйте метод DeserializeFromTypedJson(String),
записав полученную структуру в объект obj.SetStorage(storage).
(Унаследован от StorageObject) |
GetT(String) |
Возвращает строго типизированное значение объекта из хранилища по заданному ключу.
(Унаследован от StorageObject) |
GetT(String, FuncObject) |
Возвращает строго типизированное значение объекта из хранилища по заданному ключу
с указанием фабрики defaultValueFunc, создающей значение по умолчанию и
добавляющей его в хранилище, если оно было равно null.
Метод выбрасывает исключение ArgumentException в случае, если фабрика defaultValueFunc вернула null. (Унаследован от StorageObject) |
GetDictionaryT |
Возвращает декоратор для коллекции пар ключ / значение, полученный из хранилища
по заданному ключу или созданный посредством заданной фабрики defaultDictionaryFunc,
и добавленный в хранилище, если он там отсутствует.
Метод выбрасывает исключение ArgumentException в случае, если фабрика defaultDictionaryFunc вернула null.
(Унаследован от StorageObject) |
GetHashCode | Serves as the default hash function. (Унаследован от Object) |
GetListT |
Возвращает декоратор для коллекции объектов, полученный из хранилища
по заданному ключу или созданный посредством заданной фабрики defaultListFunc,
и добавленный в хранилище, если он там отсутствует.
Метод выбрасывает исключение ArgumentException в случае, если фабрика defaultListFunc вернула null.
(Унаследован от StorageObject) |
GetObjectData |
Записывает сериализованные данные текущего объекта в указанный
объект [System.Runtime.Serialization.SerializationInfo].
(Унаследован от StorageObject) |
GetStorage |
Возвращает хранилище Dictionary<string, object>,
декоратором для которого является текущий объект.
(Унаследован от StorageObject) |
GetType | Gets the Type of the current instance. (Унаследован от Object) |
Init |
Инициализирует значение объекта с заданным ключом, если он отсутствовал в хранилище.
(Унаследован от StorageObject) |
InitNotNull |
Инициализирует значение объекта с заданным ключом, если он отсутствовал в хранилище или был равен null,
посредством фабрики объектов.
(Унаследован от StorageObject) |
IsValid | Выполняет проверку объекта на валидность и возвращает признак того, что объект является валидным. (Унаследован от ValidationStorageObject) |
MemberwiseClone | Creates a shallow copy of the current Object. (Унаследован от Object) |
ObjectCanExistInStorageByKeyT |
Возвращает признак того, что значение, доступное по ключу key,
может содержаться в хранилище и в таком случае должно проходить проверку на валидность
посредством функции valueIsValid,
причём значение для проверки доступно из хранилища по ключу key.
(Унаследован от ValidationStorageObject) |
ObjectCanExistInStorageByValueT |
Возвращает признак того, что значение, доступное по ключу key,
может содержаться в хранилище и в таком случае должно проходить проверку на валидность
посредством функции valueIsValid,
причём значение для проверки определяется по функции, передаваемой первым параметром метода Validate.
(Унаследован от ValidationStorageObject) |
ObjectExistsInStorageByKey(String) |
Возвращает признак того, что значение, доступное по ключу key, содержится в хранилище.
(Унаследован от ValidationStorageObject) |
ObjectExistsInStorageByKeyT(String, FuncT, Boolean) |
Возвращает признак того, что значение, доступное по ключу key,
содержится в хранилище и проходит проверку на валидность посредством функции valueIsValid,
причём значение для проверки доступно из хранилища по ключу key.
(Унаследован от ValidationStorageObject) |
ObjectExistsInStorageByValueT |
Возвращает признак того, что значение, доступное по ключу key,
содержится в хранилище и проходит проверку на валидность посредством функции valueIsValid,
причём значение для проверки определяется по функции, передаваемой первым параметром метода Validate.
(Унаследован от ValidationStorageObject) |
Remove |
Удаляет объект с заданным ключом из хранилища.
(Унаследован от StorageObject) |
RemoveSystemInfo | Удаляет системную информацию, которая может располагаться в любом месте в хранилище текущего объекта и может быть найдена по ключам с префиксом SystemKeyPrefix. Внимание! После выполнения метода из карточки исчезнут важные сведения, такие как информация об изменённых полях или о состоянии строк коллекционных и древовидных секций. (Унаследован от CardInfoStorageObject) |
RemoveUserInfo |
Удаляет пользовательскую информацию, которая может располагаться в любом месте в хранилище текущего объекта
и может быть найдена по ключам с префиксом UserKeyPrefix.
(Унаследован от CardInfoStorageObject) |
Set |
Устанавливает значение в хранилище по заданному ключу.
При этом не изменяется внутренний кэш декораторов, поэтому метод следует использовать
только для примитивных типов.
(Унаследован от StorageObject) |
SetNull |
Устанавливает значение null для элемента по заданному ключу и
удаляет предыдущий элемент из внутреннего кэша декораторов.
(Унаследован от StorageObject) |
SetNullIfEmptyEnumerable |
Устанавливает равным null элемент с ключом key,
если он является пустым перечислением IEnumerable.
(Унаследован от StorageObject) |
SetStorage(DictionaryString, Object) |
Устанавливает хранилище Dictionary<string, object>,
декоратором для которого является текущий объект,
посредством копирования значений из заданного хранилища.
Если текущий объект реализует IStorageNotificationReceiver,
то для него вызывается метод NotifyStorageUpdated.
(Унаследован от StorageObject) |
SetStorage(IStorageObjectProvider) |
Устанавливает хранилище Dictionary<string, object>,
декоратором для которого является текущий объект,
посредством копирования значений из хранилища заданного объекта.
Если текущий объект реализует IStorageNotificationReceiver,
то для него вызывается метод NotifyStorageUpdated.
(Унаследован от StorageObject) |
SetStorageValue |
Устанавливает значение объекта, реализующего IStorageProvider, в хранилище по заданному ключу.
При этом также изменяется внутренний кэш декораторов, поэтому метод следует использовать
для декораторов.
(Унаследован от StorageObject) |
ToDynamic |
Возвращает объект, осуществляющий доступ к хранилищу, декоратором для которого является текущий объект,
через позднее связывание.
(Унаследован от StorageObject) |
ToJson |
Сериализует объект в текстовый JSON.
Рассмотрите использование метода ToTypedJson(Boolean) для сериализации с сохранением полной информации по типам,
которую можно будет восстановить в методе FromTypedJson.
(Унаследован от StorageObject) |
ToString | Returns a string that represents the current object. (Унаследован от Object) |
ToTypedJson |
Сериализует объект в текстовый JSON с сохранением информации по типам для всех подобъектов, в т.ч. для Info.
Используйте метод FromTypedJson для десериализации.
Для сериализации других объектов, у которых нет метода ToTypedJson (например, request/response),
используйте метод SerializeToTypedJson(IDictionaryString, Object, Boolean),
передав в него структуру объекта obj.GetStorage().
(Унаследован от StorageObject) |
TryGetT |
Возвращает строго типизированное значение объекта из хранилища по заданному ключу
или default(T), если объект по заданному ключу не найден.
(Унаследован от StorageObject) |
TryGetDictionaryT |
Возвращает строго типизированное значение объекта Dictionary<string, object>
из хранилища по заданному ключу или default(T),
если объект по заданному ключу не найден.
(Унаследован от StorageObject) |
TryGetInfo |
Возвращает дополнительную пользовательскую информацию по текущему объекту
или null, если информация ещё не была задана.
(Унаследован от CardInfoStorageObject) |
TryGetListT |
Возвращает строго типизированное значение объекта List<object>
из хранилища по заданному ключу или default(T),
если объект по заданному ключу не найден.
(Унаследован от StorageObject) |
TryGetSectionsToExclude | Возвращает список имён физических секций, которые не следует загружать, или null, если список ещё не был задан. |
TryGetString |
Возвращает строковое представление для значения объекта из хранилища по заданному ключу
или null, если объект по заданному ключу не найден.
(Унаследован от StorageObject) |
TryGetTasksToUnlockRowIDList | Возвращает список идентификаторов заданий, все данные которых будут полностью загружены, если такие задания доступны от имени исполнителя функциональной роли со скрытыми по умолчанию вариантами завершения, или null, если список ещё не был задан. |
Validate |
Выполняет валидацию объекта и всех его дочерних объектов.
(Унаследован от ValidationStorageObject) |
Validate(IValidationResultBuilder) | Выполняет валидацию текущего объекта и всех его дочерних объектов. (Унаследован от ValidationStorageObject) |
ValidateInternal | Выполняет валидацию текущего объекта и всех его дочерних объектов. (Унаследован от CardInfoStorageObject) |
CompressionModeKey | |
ExportFormatKey | |
GetModeKey | |
GetTaskModeKey | |
NewModeKey | |
RestrictionFlagsKey | |
SectionsToExcludeKey | |
SystemMethodKey | |
TasksToUnlockRowIDListKey |
AddKrProcessClientCommands |
Добавляет в указанное хранилище список клиентских команд.
(Определяется KrProcessSharedExtensions) |
AreButtonsIgnored |
Получает из заданного хранилища значение флага показывающего, что при загрузке карточки не надо добавлять в ответ информацию по тайлам вторичных процессов.
(Определяется KrProcessSharedExtensions) |
ConsiderHiddenStages |
Возвращает значение, показывающее, что в карточку должны быть загружены скрытые этапы маршрута.
(Определяется KrProcessSharedExtensions) |
ConsiderSkippedStages |
Возвращает значение из заданного хранилища, показывающее, требуется ли отображать пропущенные этапы.
(Определяется KrProcessSharedExtensions) |
DontHideStages |
Добавляет в указанное хранилище значение, показывающее, необходимо ли загружать в карточку скрытые этапы маршрута или нет.
(Определяется KrProcessSharedExtensions) |
Get | (Определяется ComHelper) |
GetCalculateDigest |
Возвращает флаг расчёта Digest при загрузке карточки.
(Определяется CardRequestExtensions) |
GetForbidStoringHistory |
Возвращает запрет на сохранение данных о загружаемой карточке в историю действий с карточкой.
(Определяется CardRequestExtensions) |
GetHasRecalcChanges |
Возвращает значение, показывающее, что после пересчёта были изменения в маршруте или нет. Информация добавляется только при выставленном флаге HasChangesToInfo.
(Определяется KrProcessSharedExtensions) |
GetIgnorePermissionsWarning |
Возвращает признак того, что при сохранении карточки могут быть не указаны токены безопасности,
поэтому не следует показывать соответствующее предупреждение.
Если признак не был установлен, то возвращается false.
(Определяется CardRequestExtensions) |
GetInfoAboutChanges |
Возвращает режим вывода информации об изменениях в маршруте после пересчёта или значение по умолчанию для типа, если хранилище его не содержало.
(Определяется KrProcessSharedExtensions) |
GetKrProcessClientCommands |
Возвращает из указанного хранилища список клиентских команд или значение по умолчанию для типа, если оно их не содержало.
(Определяется KrProcessSharedExtensions) |
GetKrProcessInstance |
Возвращает информацию об экземпляре процесса из указанного хранилища.
(Определяется KrProcessSharedExtensions) |
GetKrProcessLaunchResult |
Возвращает объект содержащий результат запуска процесса или значение по умолчанию для типа, если указанный объект его не содержит.
(Определяется KrProcessSharedExtensions) |
GetLocalTiles |
Получает из указанного объекта коллекцию объектов содержащих информацию о локальных тайлах маршрутов.
(Определяется KrProcessSharedExtensions) |
GetNoLockingMainCard |
Возвращает признак того, что не следует выполнять блокировку основной карточки при создании или изменении сателлита.
(Определяется CardRequestExtensions) |
GetRecalcChanges |
Возвращает информацию о различиях в маршруте до и после пересчёта.
(Определяется KrProcessSharedExtensions) |
GetRecalcFlag |
Возвращает значение, показывающее, должен ли быть выполнен пересчёт маршрута или нет.
(Определяется KrProcessSharedExtensions) |
GetStartingSecondaryProcess |
Возвращает из объекта содержащего дополнительную информацию, информацию необходимую для запуска процесса.
(Определяется KrProcessSharedExtensions) |
IgnoreButtons |
Устанавливает значение, показывающее, что при загрузке карточки не надо добавлять в ответ информацию по тайлам вторичных процессов.
(Определяется KrProcessSharedExtensions) |
IgnoreKrSatellite |
Устанавливает значение, показывающее, что при загрузке карточки не надо загружать и обрабатывать информацию содержащуюся в основном сателлите (KrSatelliteTypeID) карточки.
(Определяется KrProcessSharedExtensions) |
Invoke | (Определяется ComHelper) |
IsKrSatelliteIgnored |
Возвращает значение, показывающее, что при загрузке карточки не надо загружать и обрабатывать информацию содержащуюся в основном сателлите (KrSatelliteTypeID) карточки.
(Определяется KrProcessSharedExtensions) |
RemoveLocalTiles |
Удаляет из заданного хранилища информацию по локальным тайлам маршрутов.
(Определяется KrProcessSharedExtensions) |
RemoveSecondaryProcess |
Удаляет из объекта содержащего дополнительную информацию, информацию необходимую для запуска процесса добавленную SetStartingSecondaryProcess(CardInfoStorageObject, StartingSecondaryProcessInfo).
(Определяется KrProcessSharedExtensions) |
ResetRequestToCache |
Сбрасывает признак того, что запрос на получение карточки должен обращаться к кэшу.
После выполнения метода запрос будет выполняться стандартным образом, т.е. в обход кэша.
Значение актуально для карточек-синглтонов.
(Определяется CardRequestExtensions) |
Set | (Определяется ComHelper) |
SetCalculateDigest |
Устанавливает флаг расчёта Digest при загрузке карточки.
(Определяется CardRequestExtensions) |
SetDigest |
Устанавливает Digest для сохранения в историю действий с карточкой.
(Определяется CardRequestExtensions) |
SetDisableExpandJsonFlag |
Устанавливает флаг, указывающий на то, что при экспорте карточки не нужно разворачивать JSON-поля карточки из строки в Dictionary<string, object?>.
(Определяется CardRequestExtensions) |
SetForbidStoringHistory |
Устанавливает запрет на сохранение данных о загружаемой карточке в историю действий с карточкой.
Вызов метода в клиентских расширениях запрещён, это приведёт к ошибке RequestFromClientCheckFailed.
(Определяется CardRequestExtensions) |
SetForceTaskPanel | (Определяется CardRequestExtensions) |
SetHasRecalcChanges |
Задаёт значение, показывающее, что после пересчёта были изменения в маршруте или нет. Информация добавляется только при выставленном флаге HasChangesToInfo.
(Определяется KrProcessSharedExtensions) |
SetIgnorePermissionsWarning |
Устанавливает признак того, что при обработке карточки могут быть не указаны токены безопасности,
поэтому не следует показывать соответствующее предупреждение.
(Определяется CardRequestExtensions) |
SetInfoAboutChanges |
Устанавливает в хранилище информацию о режиме информирования об изменениях в маршруте после пересчёта.
(Определяется KrProcessSharedExtensions) |
SetKrProcessInstance |
Сохраняет в указанном объекте информация об экземпляре процесса.
(Определяется KrProcessSharedExtensions) |
SetKrProcessLaunchResult |
Сохраняет результаты запуска процесса в указанном хранилище.
(Определяется KrProcessSharedExtensions) |
SetLocalTiles |
Сохраняет в указанном объекте коллекцию объектов содержащих информацию о локальных тайлах маршрутов.
(Определяется KrProcessSharedExtensions) |
SetNoLockingMainCard |
Устанавливает признак того, что не следует выполнять блокировку основной карточки при создании или изменении сателлита.
(Определяется CardRequestExtensions) |
SetPluginType |
Устанавливает тип плагина при выполнении запроса к карточке из плагина Chronos.
Стандартные типы перечислены в CardPluginTypes.
(Определяется CardRequestExtensions) |
SetRecalcChanges |
Сохраняет в заданном хранилище информацию о различиях в маршруте до и после пересчёта.
(Определяется KrProcessSharedExtensions) |
SetRecalcFlag |
Задаёт значение, показывающее, что должен быть выполнен пересчёт маршрута.
(Определяется KrProcessSharedExtensions) |
SetRequestToCache |
Устанавливает признак того, что запрос на получение карточки должен обращаться к кэшу.
Значение актуально для карточек-синглтонов.
(Определяется CardRequestExtensions) |
SetStartingKrProcessParameters |
Устанавливает параметры запускаемого процесса.
(Определяется KrProcessSharedExtensions) |
SetStartingSecondaryProcess |
Устанавливает информацию о процессе, запускаемого посредством WorkflowStoreExtension.
(Определяется KrProcessSharedExtensions) |
SetWarningIfEntryNotFoundFlag |
Устанавливает флаг, указывающий на то, что в случае отсутствия строковой секции в БД, будет сгенерировано предупреждение, а не ошибка.
(Определяется CardRequestExtensions) |
ShouldExpandJson |
Возвращает признак того, что нужно разворачивать JSON-поля карточки из строки в Dictionary<string, object?>.
(Определяется CardRequestExtensions) |
TryGetDigest |
Возвращает Digest для сохранения в историю действий с карточкой
или null, если Digest не был установлен.
(Определяется CardRequestExtensions) |
TryGetDisableExpandJsonFlag |
Возвращает флаг, указывающий на то, что при экспорте карточки не нужно разворачивать JSON-поля карточки из строки в Dictionary<string, object?>.
(Определяется CardRequestExtensions) |
TryGetKrProcessClientCommands |
Возвращает из указанного хранилища список клиентских команд или значение по умолчанию для типа, если оно их не содержало.
(Определяется KrProcessSharedExtensions) |
TryGetKrProcessInstance |
Возвращает информацию об экземпляре процесса из указанного хранилища.
(Определяется KrProcessSharedExtensions) |
TryGetKrProcessLaunchResult |
Возвращает объект, содержащий результат запуска процесса.
(Определяется KrProcessSharedExtensions) |
TryGetLocalTiles |
Получает из указанного объекта коллекцию объектов содержащих информацию о локальных тайлах маршрутов.
(Определяется KrProcessSharedExtensions) |
TryGetPluginType |
Возвращает тип плагина, установленный при выполнении запроса к карточке из плагина Chronos,
или null, если запрос выполнен не из плагина или из неизвестного плагина.
(Определяется CardRequestExtensions) |
TryGetRequestToCache |
Возвращает признак того, что запрос на получение карточки должен обращаться к кэшу.
Значение актуально для карточек-синглтонов.
(Определяется CardRequestExtensions) |
TryGetStartingKrProcessParameters |
Возвращает параметры запускаемого процесса.
(Определяется KrProcessSharedExtensions) |
TryGetWarningIfEntryNotFoundFlag |
Возвращает флаг, указывающий на то, что в случае отсутствия строковой секции в БД, будет сгенерировано предупреждение, а не ошибка.
(Определяется CardRequestExtensions) |