ITessaViewRequest - интерфейс |
Описание интерфейса запроса к представлению ITessaView.
Запрос содержит информацию необходимую для осуществления
вызова представления указанного в View
с параметрами Values.
Для получения из представления результатов подмножества необходимо задать
имя подмножества в SubsetName.
Значения заданные в SortingColumn влияют на сортировку
результатов выполнения представления.
Результат выполнения запроса к представлению возвращается в виде
объекта реализующего интерфейс ITessaViewResult
Пространство имён: Tessa.Views
Сборка: Tessa (в Tessa.dll) Версия: 3.5.0.19
Синтаксисpublic interface ITessaViewRequest : IViewConnectionInfo
Тип ITessaViewRequest предоставляет следующие члены.
Свойства| Имя | Описание | |
|---|---|---|
 | CalculateRowCounting |
Gets or sets a value indicating whether Признак необходимости подсчета количества строк.
Для подсчета строк представление должно содержать подмножество осуществляющее подсчет количества строк.
Имя данного подмножества указывается в свойстве RowCountSubset метаданных
представления.
|
| ConnectionAlias | Алиас строки подключения (из конфигурационного файла веб сервиса `app.json`) к БД, на которой будет выполняться представление вместо дефолтной базы. В конфигурационном файле можно указать подключение к любой СУБД. Если, например, основная база - MSSQL, а подключение к базе Postgres, то запрос генерируется по правилам Postgres; если же база какая-то другая (например, Oracle), то по умолчанию используются правила генерации для MSSQL. С помощью данного параметра можно прописать подключение к другой базе, в том числе не к базе Tessa, а, например, к какой-то другой информационнной системе. Укажите null или пустую строку, если используется соединение по умолчанию. Также на алиас соединения влияет одноимённая настройка в метаинформации представления. Для использования этой настройки требуется модуль лицензии "Кластеризация". Он включён в лицензии Enterprise. |
| ExecutionTimeOut |
Gets or sets Тайм-аут выполнения запроса.
null - используется значение по умолчанию заданное в настройках системы.
Отличное от null значение будет использовано для выставления тайм-аута запроса.
При этом если при выполнении запроса тайм-аут истечет, то в результате
будет возвращен результат выполнения запроса с пустым списком строк и HasTimeOut
выставленным в true.
|
| SortingColumns |
Gets or sets список колонок сортировки.
В случае если колонки сортировки результатов выполнения представления
не указаны сортировка производится по DefaultSortColumn
и DefaultSortDirection если они указаны для представления.
В случае исполнения представления в режиме подмножества сортировка не производится.
|
| SubsetName |
Gets or sets Имя вызываемого подмножества представления.
Указывается в случае необходимости получения данных подмножества представления View |
| Values |
Gets or sets Список значений параметров.
|
| View |
Gets or sets Метаданные вызываемого представления.
На основании указанного значения будет осуществлен вызов представления Alias |
| ViewAlias |
Gets or sets Псевдоним представления
|
Методы расширения| Имя | Описание | |
|---|---|---|
 | GetCriteriaName |
Возвращает количество условий заданных для параметра paramName (Определяется TessaViewRequestHelper.) |
| GetParameterCriteriaCount |
Возвращает количество условий заданных для параметра paramName (Определяется TessaViewRequestHelper.) |
| GetParameterFirstValue |
Возвращает первое значение параметра заданного в запросе request
для параметра с именем paramName. Если значение не задано
или количество значений меньше одного то будет выдано исключение
(Определяется TessaViewRequestHelper.) |
| GetParameterFirstValueIsNull |
Возвращает признак того, что первое значение параметра, заданного в запросе request
для параметра с именем paramName, равно null.
Если значение не задано или количество значений меньше одного, то будет выдано исключение.
Метод учитывает операторы "пусто" IsNullCriteriaOperator и "не пусто"
IsNotNullCriteriaOperator.
(Определяется TessaViewRequestHelper.) |
| GetParameterSecondValue |
Возвращает второе значение параметра заданного в запросе request
для параметра с именем paramName. Если значение не задано
или количество значений меньше одного то будет выдано исключение
(Определяется TessaViewRequestHelper.) |
| GetParameterSingleIsNull |
Возвращает признак того, что единственное значение параметра, заданного в запросе request
для параметра с именем paramName, равно null.
Если значение не задано или количество значений не равно одному, то будет выдано исключение.
Метод учитывает операторы "пусто" IsNullCriteriaOperator и "не пусто"
IsNotNullCriteriaOperator.
(Определяется TessaViewRequestHelper.) |
| GetParameterSingleValue |
Возвращает единственное значение параметра заданного в запросе request
для параметра с именем paramName. Если значение не задано
или количество значений не равно одному то будет выдано исключение
(Определяется TessaViewRequestHelper.) |
| GetParameterValueCount |
Возвращает число заданных значений параметра.
Если параметр не задан или условий больше чем 1 возвращает -1
(Определяется TessaViewRequestHelper.) |
| IsAnySubsetDefined |
Осуществялет проверку необходимости работы в режиме подмножества
(Определяется TessaViewRequestHelper.) |
| IsDefinedAllParametersOrSubset |
Осуществляет проверку наличия в коллекции параметра или имени сабсета
(Определяется ViewRequestExtender.) |
| IsDefinedParameter |
Определяет задан ли параметр с именем parameterName в запросе request (Определяется TessaViewRequestHelper.) |
| IsSubsetDefined |
Осуществляет проверку работы в режиме любого подмножеств заданного в параметре subsetName (Определяется TessaViewRequestHelper.) |
| IterateParameterCriteriasAsync |
Осуществляет выполнение метода operate
над операциями заданным в параметре parameterName,
если он определен в запросе
(Определяется TessaViewRequestHelper.) |
| RemovePredefinedParameters |
Удаляет из запроса request зарезервированные имена
AdministratorPredefinedParamSubsetPredefinedParamNormalPredefinedParam (Определяется TessaViewRequestHelper.) |
| SortDirection |
Получает порядок сортировки для столбца columnAlias
в запросе request.
Возвращает строку "asc", если выполняется сортировка по возрастанию;
строку "desc", если выполняется сортировка по убыванию;
или null, если сортировка по столбцу не выполняется.
(Определяется TessaViewRequestHelper.) |
| SortedBy |
Проверяет наличие колонки columnAlias в списке колонок,
по которым осуществляется сортировка в запросе request (Определяется TessaViewRequestHelper.) |
| TryGetParameter |
Возвращает параметр запроса к представлению по имени parameterName (Определяется TessaViewRequestHelper.) |
См. также