TessaViewRequest - класс

Запрос к представлению ITessaView.

Definition

Пространство имён: Tessa.Views
Сборка: Tessa (в Tessa.dll) Версия: 4.1.3+7e2b1422f9b8c7c41fbbc4b151a843bed05319ab
C#
public sealed class TessaViewRequest : StorageSerializable, 
	ITessaViewRequest, IStorageCachePolicyProvider, IViewConnectionInfo, IEnumerable<RequestParameter>, 
	IEnumerable
Inheritance
Object    StorageSerializable    TessaViewRequest
Implements
IEnumerableRequestParameter, IEnumerable, IStorageCachePolicyProvider, ITessaViewRequest, IViewConnectionInfo

Заметки

Результат выполнения запроса возвращается как объект ITessaViewResult.

Для сериализации используйте объект TessaViewRequest.

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

TessaViewRequest Конструктор по умолчанию для сериализации. Не используйте для создания объекта.
Устарело.
TessaViewRequest(ITessaViewRequest) Создаёт неглубокую копию заданного объекта ITessaViewRequest. Копируются коллекции, но не содержащиеся в них объекты.
TessaViewRequest(String) Создаёт экземпляр класса TessaViewRequest с указанием алиаса представления.

Свойства

CalculateRowCounting Признак необходимости подсчёта количества строк. Для подсчёта строк представление должно содержать подмножество с именем RowCountSubset, осуществляющее такой подсчёт.
ConnectionAlias

Алиас строки подключения (из конфигурационного файла app.json на сервере) к БД, на которой будет выполняться представление вместо основной БД. В конфигурационном файле можно указать подключение к любой СУБД. Если, например, основная база - MSSQL, а подключение к базе Postgres, то запрос генерируется по правилам Postgres; если же СУБД какая-то другая (например, Oracle), то по умолчанию используются правила генерации для MSSQL.

С помощью данного параметра можно прописать подключение к другой базе, в том числе не к базе TESSA, а, например, к какой-то другой информационной системе.

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

Для использования этой настройки требуется модуль лицензии "Кластеризация". Он включён в корпоративную лицензию Enterprise.

ExecutionTimeout Таймаут выполнения запроса или null, если используется значение по умолчанию из настроек системы. Значение Zero соответствует неограниченному таймауту.
Info Дополнительная информация для расширений.
Parameters Значения параметров представления.
SkipErrorLogging Признак того, что не требуется создавать карточку ошибки при ошибке выполнения представления.
SortingColumns Колонки сортировки.
SubsetName Имя вызываемого подмножества представления. Равен null или пустой строке, если сабсет не указан, т.е. представление выполняется без подмножества в режиме Normal.
ViewAlias Алиас вызываемого представления. Не равен null или пустой строке.

Методы

Add Добавляет параметр в коллекцию Parameters, если он не равен null. Метод для удобства заполнения свойств объекта через инициализацию.
DeserializeВыполняет десериализацию полей объекта из заданного хранилища.
(Унаследован от StorageSerializable)
DeserializeAndGetCoreВыполняет десериализацию полей объекта из заданного хранилища.
(Унаследован от StorageSerializable)
DeserializeCoreВыполняет десериализацию полей объекта из заданного хранилища.
(Переопределяет StorageSerializableDeserializeCore(DictionaryString, Object))
EnsureCacheResolved Инициализирует объект-обёртку для всех значений, в т.ч. для вложенных объектов. Рекомендуется выполнять при создании заполненного объекта перед асинхронным обращением к его вложенным объектам.
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)
GetEnumeratorReturns an enumerator that iterates through the collection.
GetHashCodeServes as the default hash function.
(Унаследован от Object)
GetTypeGets the Type of the current instance.
(Унаследован от Object)
MemberwiseCloneCreates a shallow copy of the current Object.
(Унаследован от Object)
SerializeВыполняет сериализацию полей объекта в заданное хранилище.
(Унаследован от StorageSerializable)
SerializeCoreВыполняет сериализацию полей объекта в заданное хранилище.
(Переопределяет StorageSerializableSerializeCore(DictionaryString, Object))
ToStringReturns a string that represents the current object.
(Унаследован от Object)

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

AllOrNullRequestParameter Определяет отвечают ли все элементы последовательности переданному предикату.
(Определяется PlatformExtensions)
AsArrayRequestParameter Преобразует перечисление в массив. В случае, если перечисление не является массивом, к нему применяется ToArrayTSource(IEnumerableTSource).
(Определяется CollectionsExtensions)
AsArrayOrIListRequestParameter Преобразует перечисление в список IListT, доступный только для чтения, или в массив. В случае, если перечисление не является списком или массивом, к нему применяется ToArrayTSource(IEnumerableTSource).
(Определяется CollectionsExtensions)
AsReadOnlyCollectionRequestParameter Преобразует перечисление в коллекцию, доступную только для чтения. В случае, если перечисление не является коллекцией IReadOnlyCollectionT, но является объектом IListT, к нему применяется AsReadOnlyT(IListT), иначе к нему применяется ToImmutableListTSource(IEnumerableTSource).
(Определяется CollectionsExtensions)
AsReadOnlyListRequestParameter Преобразует перечисление в список, доступный только для чтения. В случае, если перечисление не является списком IReadOnlyListT, но является объектом IListT, к нему применяется AsReadOnlyT(IListT), иначе к нему применяется ToImmutableListTSource(IEnumerableTSource).
(Определяется CollectionsExtensions)
FindByNameRequestParameter Осуществляет поиск по имени в коллекции для объектов, связанных с представлениями. Сравнение имён выполняется по правилам метода IsEquals(String, String).
(Определяется ViewsExtensions)
ForEachRequestParameter Выполняет указанное действие с каждым элементом коллекции IEnumerableT.
(Определяется CollectionsExtensions)
FullOuterJoinRequestParameter, TInner, TKey, TResult Объединяет две последовательности по алгоритму FULL OUTER JOIN.
(Определяется CollectionsExtensions)
GetCriteriaName Возвращает имя единственного критерия CriteriaName для параметра запроса name или null, если параметр не найден или количество критериев отлично от одного.
(Определяется ViewsExtensions)
GetFirstParameterValue Возвращает первое значение параметра, заданного в запросе request, для параметра с именем name.
Если значение не задано или количество значений меньше одного, то будет выброшено исключение.
(Определяется ViewsExtensions)
GetFirstParameterValueT Возвращает значение первого критерия для указанного параметра.
(Определяется ViewsExtensions)
GetFirstParameterValueIsNull Возвращает признак того, что первое значение параметра, заданного в запросе request, для параметра с именем name равно null.
Если значение не задано или количество значений меньше одного, то будет выброшено исключение.
Метод учитывает операторы "пусто" IsNullCriteriaOperator и "не пусто" IsNotNullCriteriaOperator.
(Определяется ViewsExtensions)
GetParameterCriteriaCount Возвращает количество условий, заданных для параметра name.
(Определяется ViewsExtensions)
GetParameterValueCount Возвращает число заданных значений параметра.
Если параметр не задан или условий больше чем 1, то возвращает -1.
(Определяется ViewsExtensions)
GetSecondParameterValue Возвращает второе значение параметра, заданного в запросе request, для параметра с именем name.
Если значение не задано или количество значений меньше одного, то будет выброшено исключение.
(Определяется ViewsExtensions)
GetSingleParameterValue Возвращает единственное значение параметра, заданного в запросе request, для параметра с именем name.
Если значение не задано или количество значений не равно одному, то будет выброшено исключение.
(Определяется ViewsExtensions)
GetSingleParameterValueIsNull Возвращает признак того, что единственное значение параметра, заданного в запросе request, для параметра с именем name, равно null.
Если значение не задано или количество значений не равно одному, то будет выброшено исключение.
Метод учитывает операторы "пусто" IsNullCriteriaOperator и "не пусто" IsNotNullCriteriaOperator.
(Определяется ViewsExtensions)
IndexOfRequestParameter Возвращает индекс первого вхождения элемента в последовательность, определяемый посредством заданного выражения.
(Определяется CollectionsExtensions)
IndexOfRequestParameter Возвращает индекс первого вхождения элемента в последовательность, определяемый посредством заданного компаратора IEqualityComparerT.
(Определяется CollectionsExtensions)
IsDefinedByNameRequestParameter Возвращает признак того, что в коллекции для объектов, связанных с представлениями, присутствует объект с указанным именем. Сравнение имён выполняется по правилам метода IsEquals(String, String).
(Определяется ViewsExtensions)
OrderByAttributeAndTypeRequestParameter

Сортирует элементы с учётом атрибута OrderAttribute на типах объектов.

Если атрибут отсутствует или элемент равен null - подразумевается 0. Если несколько зависимостей имеют одинаковый порядок, то они сортируются по краткому имени типа элемента (без пространства имён), а при его совпадении - по квалифицированному имени типа (с учётом пространства имён и названия сборки).


(Определяется PlatformExtensions)
OrderByDbmsBaseRequestParameter Метод для сортировки списка в порядке по возрастанию с учётом особенностей СУБД.
(Определяется DataExtensions)
OrderByDependenciesRequestParameter
(Определяется CollectionsExtensions)
OrderByDependenciesRequestParameter
(Определяется CollectionsExtensions)
OrderByDependenciesRequestParameter, TKey
(Определяется CollectionsExtensions)
OrderByDependenciesRequestParameter, TKey
(Определяется CollectionsExtensions)
OrderByDescendingDbmsBaseRequestParameter Метод для сортировки списка в порядке по убыванию с учётом особенностей СУБД.
(Определяется DataExtensions)
OrderByLocalizedRequestParameter Сортирует значения последовательности по возрастанию по локализованному ключу, который определяется для каждого элемента.
(Определяется PlatformExtensions)
OrderByLocalizedDescendingRequestParameter Сортирует значения последовательности по убыванию по локализованному ключу, который определяется для каждого элемента.
(Определяется PlatformExtensions)
OrderByNoteItemGroupRequestParameter Сортирует объекты по группе NoteItemGroup с учётом переданного порядка групп orderedGroups.
(Определяется NotesExtensions)
ProvideDefaults

Заполняет параметры запроса по умолчанию в соответствии с метаинформацией представления.

Алиас метаинформации [!:IViewMetadata.Alias] должен соответствовать алиасу в запросе ViewAlias.


(Определяется ViewsExtensions)
RunWithMaxDegreeOfParallelismAsyncRequestParameter Выполняет асинхронную обработку элементов с ограничением на максимальное количество параллельных задач.
(Определяется PlatformExtensions)
SortDirection Получает порядок сортировки для столбца columnAlias в запросе request.
Возвращает строку "asc", если выполняется сортировка по возрастанию;
строку "desc", если выполняется сортировка по убыванию;
или null, если сортировка по столбцу не выполняется.
(Определяется ViewsExtensions)
SortedBy Проверяет наличие колонки columnAlias в списке колонок, по которым осуществляется сортировка в запросе request.
(Определяется ViewsExtensions)
ToDictionaryAsyncRequestParameter, TKey, TElement Создает словарь DictionaryTKey, TValue из объекта IEnumerableT в соответствии с заданными функциями синхронного селектора ключа и асинхронного селектора значения.
(Определяется PlatformExtensions)
ToObservableCollectionRequestParameter Преобразует коллекцию IEnumerable в ObservableCollection
(Определяется CollectionsExtensions)
ToSealableListRequestParameter Возвращает список объектов, поддерживающий защиту от изменений. Каждый из объектов T в списке либо не реализует интерфейс ISealable, либо защита от изменений таких объектов не активируется вместе со списком.
(Определяется CollectionsExtensions)
ToSerializedListRequestParameter Сериализует список объектов в список хэш-таблиц, каждая из которых является хранилищем объекта в списке без указания типа объекта (класса). Возвращаемое значение null аналогично пустому списку.
(Определяется StorageExtensions)
TryFirstRequestParameter Возвращает первый элемент последовательности, удовлетворяющий условию.
(Определяется CollectionsExtensions)
TrySingleOrDefaultRequestParameter Возвращает единственный конкретный элемент коллекции или значение по умолчанию для типа, если этот элемент не найден.
(Определяется CollectionsExtensions)
WithPreviousAndNextRequestParameter
(Определяется EnumerableExtensions)

См. также