ISerializableObject - интерфейс

Объект, сериализуемый средствами TessaSerializer.

Definition

Пространство имён: Tessa.Platform.Storage
Сборка: Tessa (в Tessa.dll) Версия: 4.0.4

public interface ISerializableObject : IDictionary<string, Object>, 
	ICollection<KeyValuePair<string, Object>>, IEnumerable<KeyValuePair<string, Object>>, 
	IEnumerable, INotificationObject, IStorageObjectProvider, IStorageDictionaryProvider, IStorageProvider, 
	ISealable, ICloneable

Public Interface ISerializableObject
	Inherits IDictionary(Of String, Object), ICollection(Of KeyValuePair(Of String, Object)), 
	IEnumerable(Of KeyValuePair(Of String, Object)), IEnumerable, 
	INotificationObject, IStorageObjectProvider, IStorageDictionaryProvider, IStorageProvider, ISealable, 
	ICloneable

C++

public interface class ISerializableObject : IDictionary<String^, Object^>, 
	ICollection<KeyValuePair<String^, Object^>>, IEnumerable<KeyValuePair<String^, Object^>>, 
	IEnumerable, INotificationObject, IStorageObjectProvider, IStorageDictionaryProvider, IStorageProvider, 
	ISealable, ICloneable

type ISerializableObject = 
    interface
        interface IDictionary<string, Object>
        interface ICollection<KeyValuePair<string, Object>>
        interface IEnumerable<KeyValuePair<string, Object>>
        interface IEnumerable
        interface INotificationObject
        interface IStorageObjectProvider
        interface IStorageDictionaryProvider
        interface IStorageProvider
        interface ISealable
        interface ICloneable
    end

Implements: ICollectionKeyValuePairString, Object, IDictionaryString, Object, IEnumerableKeyValuePairString, Object, IEnumerable, ICloneable, INotificationObject, ISealable, IStorageDictionaryProvider, IStorageObjectProvider, IStorageProvider

Заметки

Это декоратор для Dictionary<string, object>, который автоматически сериализуется и десериализуется при передаче через веб-сервис.

Свойства

Count	Gets the number of elements contained in the ICollectionT. (Унаследован от ICollectionKeyValuePairString, Object)
IsReadOnly	Gets a value indicating whether the ICollectionT is read-only. (Унаследован от ICollectionKeyValuePairString, Object)
IsSealed	Признак того, что объект был защищён от изменений. (Унаследован от ISealable)
Item	Gets or sets the element with the specified key. (Унаследован от IDictionaryString, Object)
Keys	Gets an ICollectionT containing the keys of the IDictionaryTKey, TValue. (Унаследован от IDictionaryString, Object)
Values	Gets an ICollectionT containing the values in the IDictionaryTKey, TValue. (Унаследован от IDictionaryString, Object)

Методы

Add(T)	Adds an item to the ICollectionT. (Унаследован от ICollectionKeyValuePairString, Object)
Add(TKey, TValue)	Adds an element with the provided key and value to the IDictionaryTKey, TValue. (Унаследован от IDictionaryString, Object)
Clear	Removes all items from the ICollectionT. (Унаследован от ICollectionKeyValuePairString, Object)
ClearCache	Очищает кэш сериализованных данных, если он больше не требуется.
Clone	Создаёт полную копию объекта.
Contains	Determines whether the ICollectionT contains a specific value. (Унаследован от ICollectionKeyValuePairString, Object)
ContainsKey	Determines whether the IDictionaryTKey, TValue contains an element with the specified key. (Унаследован от IDictionaryString, Object)
CopyTo	Copies the elements of the ICollectionT to an Array, starting at a particular Array index. (Унаследован от ICollectionKeyValuePairString, Object)
Deserialize(Byte)	Десериализует объект из последовательности байт средствами [Tessa.Platform.Json.TessaSerializer].
Deserialize(String)	Десериализует объект из текстовой строки средствами [Tessa.Platform.Json.TessaSerializer]. В отличие от бинарной сериализации, результат текстовой сериализации более читаемый и его может изменять пользователь, но при этом теряется часть информации по типам данных. Например, любые целые числа преобразуются в [System.Int64], а многие типы, за исключением числовых и булевских, такие как [System.Guid], выводятся в виде строки.
GetEnumerator	Returns an enumerator that iterates through the collection. (Унаследован от IEnumerableKeyValuePairString, Object)
GetStorage	Возвращает хранилище Dictionary<string, object>, декоратором для которого является текущий объект. (Унаследован от IStorageObjectProvider)
IsEmpty	Возвращает признак того, что объект не содержит сериализуемой информации.
IsModified	Возвращает признак того, что объект был изменён с момента его создания. (Унаследован от INotificationObject)
Remove(T)	Removes the first occurrence of a specific object from the ICollectionT. (Унаследован от ICollectionKeyValuePairString, Object)
Remove(TKey)	Removes the element with the specified key from the IDictionaryTKey, TValue. (Унаследован от IDictionaryString, Object)
Seal	Защищает объект от изменений. (Унаследован от ISealable)
Serialize	Сериализует объект в последовательность байт средствами [Tessa.Platform.Json.TessaSerializer].
SerializeJson	Сериализует объект в виде текстовой строки средствами [Tessa.Platform.Json.TessaSerializer]. В отличие от бинарной сериализации, результат текстовой сериализации более читаемый и его может изменять пользователь, но при этом теряется часть информации по типам данных. Например, любые целые числа преобразуются в [System.Int64], а многие типы, за исключением числовых и булевских, такие как [System.Guid], выводятся в виде строки.
SetModified	Устанавливает признак наличия изменений в значение value. Если изменения отсутствовали и этот метод установил значение true, то подписчики события [Modified] уведомляются о наступлении события. (Унаследован от INotificationObject)
SetStorage	Устанавливает хранилище объекта в соответствии с переданной коллекцией ключ / значение.
TryGetValue	Gets the value associated with the specified key. (Унаследован от IDictionaryString, Object)

События

Modified

Событие, подписчики которого уведомляются в момент первого изменения объекта с момента его создания. После вызова методов сериализации и установки другого хранилища признак изменений сбрасывается, поэтому событие возникает повторно.
(Унаследован от INotificationObject)

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

AddRangeKeyValuePairString, Object	Добавляет значения items в коллекцию collection. (Определяется CollectionsExtensions)
AddRangeKeyValuePairString, Object	Добавляет значения items в коллекцию collection. (Определяется CollectionsExtensions)
AddTiles	Метод для добавления тайлов. (Определяется WorkflowEngineExtensions)
AllOrNullKeyValuePairString, Object	Определяет отвечают ли все элементы последовательности переданному предикату. (Определяется PlatformExtensions)
AsArrayKeyValuePairString, Object	Преобразует коллекцию в массив. В случае, если коллекция не является массивом, к ней применяется ToArrayTSource(IEnumerableTSource). (Определяется CollectionsExtensions)
DontHideStages	Добавляет в указанный словарь значение, показывающее, необходимо ли загружать в карточку скрытые этапы маршрута или нет. (Определяется KrProcessSharedExtensions)
ForEachKeyValuePairString, Object	Выполняет указанное действие с каждым элементом коллекции IEnumerableT. (Определяется CollectionsExtensions)
FullOuterJoinKeyValuePairString, Object, TInner, TKey, TResult	Объединяет две последовательности по алгоритму FULL OUTER JOIN. (Определяется CollectionsExtensions)
GetT	Возвращает значение из хранилища IDictionary<string, object>, полученное по ключу key и приведённое к типу T. (Определяется StorageExtensions)
GetActionInstance	Метод для получения экземпляра действия из Info запроса. (Определяется WorkflowEngineExtensions)
GetActionTemplate	Метод для получения шаблона действия из Info запроса. (Определяется WorkflowEngineExtensions)
GetAsyncProcessCompletedSimultaniosly	Возвращает значение, показывающее, что асинхронный процесс был завершён. (Определяется KrProcessSharedExtensions)
GetCardID	Возвращает уникальный идентификатор карточки по заданной ссылке, или null, если идентификатор не найден. (Определяется ViewRowHelper)
GetCardIDAsInteger	Возвращает числовой идентификатор карточки по заданной ссылке, или null, если идентификатор не найден. (Определяется ViewRowHelper)
GetCompileMark	(Определяется CardCompilationHelper)
GetDisplayValue	Возвращает строковое представление для карточки по заданной ссылке. (Определяется ViewRowHelper)
GetEventName	Метод для получения события из Info запроса. (Определяется WorkflowEngineExtensions)
GetFirstStringColumnByPrefix	Возвращает имя первого строкового поля из строки представленияя, имя которого начинается с указанного префикса. (Определяется ViewRowHelper)
GetFirstStringValueByPrefix	Возвращает значение первого по порядку строкового поля с именем, начинающимся с указанного префикса, или null, если поле не найдено. (Определяется ViewRowHelper)
GetHashBinder	Метод для получения биндера хеша из Info. (Определяется WorkflowEngineExtensions)
GetInfoAboutChanges	Возвращает режим вывода информации об изменениях в маршруте после пересчёта или значение по умолчанию для типа, если хранилище его не содержало. (Определяется KrProcessSharedExtensions)
GetKrProcessClientCommands	Возвращает из указанной коллекции <ключ-значение> список клиентских команд или значение по умолчанию для типа, если она их не содержала. (Определяется KrProcessSharedExtensions)
GetNodeInstance	Метод для получения экземпляра узла из Info запроса. (Определяется WorkflowEngineExtensions)
GetNodeTemplate	Метод для получения шаблона узла из Info запроса. (Определяется WorkflowEngineExtensions)
GetOrAddTGet, TDefault	Возвращает либо значение из хранилища IDictionary<string, object>, полученное по ключу key и приведённое к типу TGet при его наличии, либо возвращает значение, созданное вызовом конструктора по умолчанию для типа TDefault, если запрошенное значение отсутствовало в хранилище, и устанавливает его в storage. (Определяется StorageExtensions)
GetOrCreateServerToken	Возвращает серверный токен безопасности из данных дополнительной информации или создаёт его там, если он ещё не был туда добавлен. (Определяется KrPermissionExtensions)
GetProcessID	Метод для получения ID экземпляра процесса из Info запроса. (Определяется WorkflowEngineExtensions)
GetProcessInfoAtEnd	Возвращает дополнительную информацию завершившегося асинхронного процесса. (Определяется KrProcessSharedExtensions)
GetProcessInstance	Метод для получения экземпляра процесса из Info запроса. (Определяется WorkflowEngineExtensions)
GetProcessRequest	Возвращает запрос на обработку процесса WorkflowEngine и его подпись. (Определяется WorkflowEngineExtensions)
GetProcessTemplate	Метод для получения шаблона процесса из Info запроса. (Определяется WorkflowEngineExtensions)
GetProcessTemplateCardID	Метод для получения ID карточки шаблона процесса из Info запроса. (Определяется WorkflowEngineExtensions)
GetRecalcFlag	Возвращает значение, показывающее, должен ли быть выполнен пересчёт маршрута или нет. (Определяется KrProcessSharedExtensions)
GetSources	Метод для получения исходников скриптов шаблона процесса из Info запроса. (Определяется WorkflowEngineExtensions)
GetValidationNotNullTableInfoList	Возвращает список объектов CardValidationNotNullTableInfo для заданного хранилища storage или создаёт и возвращает новый список объектов, если искомый список не был найден в хранилище. Метод не возвращает значение null. (Определяется CardValidationExtensions)
GetValidationTransactionActionInfoList	Возвращает список выполняемых в транзакции методов для заданного хранилища storage или создаёт и возвращает новый список объектов, если искомый список не был найден в хранилище. Метод не возвращает значение null. Используйте метод, чтобы добавить действие, записывающее ошибку в результат валидации, когда о наличии ошибки известно перед началом транзакции, но транзакция должна быть запущена, чтобы выполнились другие валидаторы. (Определяется CardValidationExtensions)
GetValidationUniqueInfoList	Возвращает список объектов CardValidationUniqueInfo для заданного хранилища storage или создаёт и возвращает новый список объектов, если искомый список не был найден в хранилище. Метод не возвращает значение null. (Определяется CardValidationExtensions)
GetValueID	Возвращает идентификатор карточки из строки представления по указанному префиксу колонки, или null, если идентификатор не найден. (Определяется ViewRowHelper)
GetValuesByPrefix	Возвращает набор значений колонок из строки представления, имена которых начинаются с указанного префикса, или null, если колонки не найдены. (Определяется ViewRowHelper)
GetWorkflowAccessChecked	Метод для получения из Info информации о том, что проверка на выполнение операции в WorkflowEngine пройдена. (Определяется WorkflowEngineExtensions)
GetWorkflowTileID	Метод для получения ID выполняемой кнопки из info. (Определяется WorkflowEngineExtensions)
GetWorkflowType	Метод для получения типа Workflow из info. (Определяется WorkflowEngineExtensions)
IndexOfKeyValuePairString, Object	Возвращает индекс первого вхождения элемента в последовательность, определяемый посредством заданного выражения. (Определяется CollectionsExtensions)
IndexOfKeyValuePairString, Object	Возвращает индекс первого вхождения элемента в последовательность, определяемый посредством заданного компаратора IEqualityComparerT. (Определяется CollectionsExtensions)
MergeTo	Копирует данные из сериализуемого объекта в коллекцию ключ / значение, выполняя слияние с перезаписью уже существующих в заданном объекте данных. (Определяется StorageExtensions)
OrderByAttributeAndTypeKeyValuePairString, Object	Сортирует элементы с учётом атрибута OrderAttribute на типах объектов. Если атрибут отсутствует или элемент равен null - подразумевается 0. Если несколько зависимостей имеют одинаковый порядок, то они сортируются по краткому имени типа элемента (без пространства имён), а при его совпадении - по квалифицированному имени типа (с учётом пространства имён и названия сборки). (Определяется PlatformExtensions)
OrderByDbmsBaseKeyValuePairString, Object	Метод для сортировки списка в порядке по возрастанию с учётом особенностей СУБД. (Определяется DataExtensions)
OrderByDependenciesKeyValuePairString, Object	(Определяется CollectionsExtensions)
OrderByDependenciesKeyValuePairString, Object	(Определяется CollectionsExtensions)
OrderByDependenciesKeyValuePairString, Object, TKey	(Определяется CollectionsExtensions)
OrderByDependenciesKeyValuePairString, Object, TKey	(Определяется CollectionsExtensions)
OrderByDescendingDbmsBaseKeyValuePairString, Object	Метод для сортировки списка в порядке по убыванию с учётом особенностей СУБД. (Определяется DataExtensions)
OrderByLocalizedKeyValuePairString, Object	Сортирует значения последовательности по возрастанию по локализованному ключу, который определяется для каждого элемента. (Определяется PlatformExtensions)
OrderByLocalizedDescendingKeyValuePairString, Object	Сортирует значения последовательности по убыванию по локализованному ключу, который определяется для каждого элемента. (Определяется PlatformExtensions)
RemoveRangeKeyValuePairString, Object	Удаляет значения items из коллекции collection. (Определяется CollectionsExtensions)
RemoveRangeKeyValuePairString, Object	Удаляет значения items из коллекции collection. (Определяется CollectionsExtensions)
RunWithMaxDegreeOfParallelismAsyncKeyValuePairString, Object	Выполняет асинхронную обработку элементов с ограничением на максимальное количество параллельных задач. (Определяется PlatformExtensions)
SetActionInstance	Метод для установки экземпляра дейсвтия в Info запроса. (Определяется WorkflowEngineExtensions)
SetActionTemplate	Метод для установки шаблона действия в Info запроса. (Определяется WorkflowEngineExtensions)
SetAsyncProcessCompletedSimultaniosly	Устанавливает значение, показывающее, что асинхронный процесс был завершён. (Определяется KrProcessSharedExtensions)
SetConverterFormat	Устанавливает, что загружаемое содержимое должно быть сконвертировано в указанный формат. (Определяется CardRequestExtensions)
SetHashBinder	Метод для установки биндера хеша в Info. (Определяется WorkflowEngineExtensions)
SetInfoAboutChanges	Устанавливает в хранилище информацию о режиме информирования об изменениях в маршруте после пересчёта. (Определяется KrProcessSharedExtensions)
SetKeepTaskDialog	Устанавливает в указанный словарь флаг показывающий требуется ли оставить открытым окно диалога или нет. (Определяется CardRequestExtensions)
SetNodeInstance	Метод для установки экземпляра узла в Info запроса. (Определяется WorkflowEngineExtensions)
SetNodeTemplate	Метод для установки шаблона узла в Info запроса. (Определяется WorkflowEngineExtensions)
SetProcessInfoAtEnd	Задаёт дополнительную информацию завершившегося асинхронного процесса в указанном хранилище. (Определяется KrProcessSharedExtensions)
SetProcessInstance	Метод для установки экземпляра процесса в Info запроса. (Определяется WorkflowEngineExtensions)
SetProcessTemplate	Метод для установки шаблона процесса в Info запроса. (Определяется WorkflowEngineExtensions)
SetRecalcFlag	Задаёт значение, показывающее, что должен быть выполнен пересчёт маршрута. (Определяется KrProcessSharedExtensions)
SetSources	Метод для установки исходников скриптов шаблона процесса в Info запроса. (Определяется WorkflowEngineExtensions)
SetStartingKrProcessParameters	Устанавливает параметры запускаемого процесса. (Определяется KrProcessSharedExtensions)
SetWorkflowAccessChecked	Метод для установки в Info информации о том, что проверка на выполнение операции в WorkflowEngine пройдена. (Определяется WorkflowEngineExtensions)
SetWorkflowTileID	Метод для установки ID выполняемой кнопки в info. (Определяется WorkflowEngineExtensions)
SetWorkflowType	Метод для установки типа Workflow в info. (Определяется WorkflowEngineExtensions)
ToBase64String	Сериализует объект в виде строки base-64. (Определяется StorageExtensions)
ToDictionaryAsyncKeyValuePairString, Object, TKey, TElement	Создает словарь DictionaryTKey, TValue из объекта IEnumerableT в соответствии с заданными функциями синхронного селектора ключа и асинхронного селектора значения. (Определяется PlatformExtensions)
ToDictionaryStorage	Преобразует заданную хеш-таблицу в форму Dictionary<string, object>, которая может затем использоваться в качестве хранилища для объектов StorageObject. Если объект dictionary уже является требуемым типом, то выполняется преобразование типа без копирования. (Определяется PlatformExtensions)
ToObservableCollectionKeyValuePairString, Object	Преобразует коллекцию IEnumerable в ObservableCollection (Определяется CollectionsExtensions)
ToSealableListKeyValuePairString, Object	Возвращает список объектов, поддерживающий защиту от изменений. Каждый из объектов T в списке либо не реализует интерфейс ISealable, либо защита от изменений таких объектов не активируется вместе со списком. (Определяется CollectionsExtensions)
ToSerializable	Возвращает сериализуемый объект, полученный для заданного объекта, предоставляющего доступ к хранилищу Dictionary<string, object>. (Определяется StorageExtensions)
TryFirstKeyValuePairString, Object	Возвращает первый элемент последовательности, удовлетворяющий условию. (Определяется CollectionsExtensions)
TryGetT	Возвращает либо значение из хранилища IDictionary<string, object>, полученное по ключу key и приведённое к типу T при его наличии, либо возвращает значение по умолчанию defaultValue, если запрошенное значение отсутствовало в хранилище. Внимание! Если требуется получить значение, которое может присутствовать со значением null, но тип данных не допускает null, например, для типа int, то пишите следующим образом: storage.TryGet<int?>("key") ?? 0 (Определяется StorageExtensions)
TryGetConverterFormat	Возвращает формат, в который должно быть сконвертировано содержимое, или null, если конвертация не требуется. (Определяется CardRequestExtensions)
TryGetServerToken	Возвращает серверный токен безопасности из данных дополнительной информации, если он был туда добавлен. (Определяется KrPermissionExtensions)
TryGetStartingKrProcessParameters	Возвращает параметры запускаемого процесса. (Определяется KrProcessSharedExtensions)
TryGetTiles	Метод для получения тайлов из info. (Определяется WorkflowEngineExtensions)
TryGetValidationNotNullTableInfoList	Возвращает список объектов CardValidationNotNullTableInfo для заданного хранилища storage или null, если искомый список не был найден в хранилище. (Определяется CardValidationExtensions)
TryGetValidationTransactionActionInfoList	Возвращает список выполняемых в транзакции методов для заданного хранилища storage или null, если искомый список не был найден в хранилище. (Определяется CardValidationExtensions)
TryGetValidationUniqueInfoList	Возвращает список объектов CardValidationUniqueInfo для заданного хранилища storage или null, если искомый список не был найден в хранилище. (Определяется CardValidationExtensions)
TryGetValueT	Возвращает признак наличия значения в хранилище IDictionary<string, object>, полученное по ключу key и само значение и приведённое к типу T при его наличии. Внимание! Если требуется получить значение, которое может присутствовать со значением null, но тип данных не допускает null, например, для типа int, то пишите следующим образом: storage.TryGet<int?>("key") ?? 0 (Определяется StorageExtensions)
TrySingleOrDefaultKeyValuePairString, Object	Возвращает единственный конкретный элемент коллекции или значение по умолчанию для типа, если этот элемент не найден. (Определяется CollectionsExtensions)
WithPreviousAndNextKeyValuePairString, Object	(Определяется EnumerableExtensions)

См. также

Ссылки

Tessa.Platform.Storage - пространство имён