TessaViewRequest - класс

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

Definition

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

C#

public class TessaViewRequest : StorageSerializable, 
	ITessaViewRequest, IViewConnectionInfo

VB

Public Class TessaViewRequest
	Inherits StorageSerializable
	Implements ITessaViewRequest, IViewConnectionInfo

C++

public ref class TessaViewRequest : public StorageSerializable, 
	ITessaViewRequest, IViewConnectionInfo

F#

type TessaViewRequest = 
    class
        inherit StorageSerializable
        interface ITessaViewRequest
        interface IViewConnectionInfo
    end

Inheritance: Object StorageSerializable TessaViewRequest

Implements: ITessaViewRequest, IViewConnectionInfo

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

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

Свойства

CalculateRowCounting	Признак необходимости подсчета количества строк. Для подсчета строк представление должно содержать подмножество осуществляющее подсчет количества строк. Имя данного подмножества указывается в свойстве RowCountSubset метаданных представления.
ConnectionAlias	Алиас строки подключения (из конфигурационного файла веб сервиса `app.json`) к БД, на которой будет выполняться представление вместо дефолтной базы. В конфигурационном файле можно указать подключение к любой СУБД. Если, например, основная база - MSSQL, а подключение к базе Postgres, то запрос генерируется по правилам Postgres; если же база какая-то другая (например, Oracle), то по умолчанию используются правила генерации для MSSQL. С помощью данного параметра можно прописать подключение к другой базе, в том числе не к базе Tessa, а, например, к какой-то другой информационнной системе. Укажите null или пустую строку, если используется соединение по умолчанию. Также на алиас соединения влияет одноимённая настройка в метаинформации представления. Для использования этой настройки требуется модуль лицензии "Кластеризация". Он включён в лицензии Enterprise.
ExecutionTimeOut	Тайм-аут выполнения запроса. null - используется значение по умолчанию заданное в настройках системы. Отличное от null значение будет использовано для выставления тайм-аута запроса. При этом если при выполнении запроса тайм-аут истечет, то в результате будет возвращен результат выполнения запроса с пустым списком строк и HasTimeOut выставленным в true.
SkipErrorLogging	Возвращает или задаёт значение, показывающее, что не требуется создавать карточку ошибки при ошибке выполнения представления.
SortingColumns	Список колонок сортировки. В случае если колонки сортировки результатов выполнения представления не указаны сортировка производится по DefaultSortColumn и DefaultSortDirection если они указаны для представления. В случае исполнения представления в режиме подмножества сортировка не производится.
SubsetName	Имя вызываемого подмножества представления. Указывается в случае необходимости получения данных подмножества представления View
Values	Список значений параметров.
View	Метаданные вызываемого представления. На основании указанного значения будет осуществлен вызов представления Alias
ViewAlias	Псевдоним представления

Методы

Deserialize	Выполняет десериализацию полей объекта из заданного хранилища. (Унаследован от StorageSerializable)
DeserializeAndGetCore	Выполняет десериализацию полей объекта из заданного хранилища. (Унаследован от StorageSerializable)
DeserializeCore	Выполняет десериализацию полей объекта из заданного хранилища. (Переопределяет StorageSerializableDeserializeCore(DictionaryString, Object))
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)
GetHashCode	Serves as the default hash function. (Унаследован от Object)
GetType	Gets the Type of the current instance. (Унаследован от Object)
MemberwiseClone	Creates a shallow copy of the current Object. (Унаследован от Object)
OnSerialized	Выполняется после сериализации объекта
OnSerializing	Выполняется при сериализации объекта
Serialize	Выполняет сериализацию полей объекта в заданное хранилище. (Унаследован от StorageSerializable)
SerializeCore	Выполняет сериализацию полей объекта в заданное хранилище. (Переопределяет StorageSerializableSerializeCore(DictionaryString, Object))
ToString	Returns a string that represents the current object. (Унаследован от Object)

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

Get	(Определяется ComHelper)
GetCriteriaName	Возвращает имя единственного критерия CriteriaName для параметра запроса name или null, если параметр не найден или количество критериев отлично от одного. (Определяется TessaViewRequestHelper)
GetFirstParameterValueT	Возвращает значение первого критерия для указанного параметра. (Определяется TessaViewRequestHelper)
GetParameterCriteriaCount	Возвращает количество условий, заданных для параметра name. (Определяется TessaViewRequestHelper)
GetParameterFirstValue	Возвращает первое значение параметра, заданного в запросе request, для параметра с именем name. Если значение не задано или количество значений меньше одного, то будет выброшено исключение. (Определяется TessaViewRequestHelper)
GetParameterFirstValueIsNull	Возвращает признак того, что первое значение параметра, заданного в запросе request, для параметра с именем name равно null. Если значение не задано или количество значений меньше одного, то будет выброшено исключение. Метод учитывает операторы "пусто" IsNullCriteriaOperator и "не пусто" IsNotNullCriteriaOperator. (Определяется TessaViewRequestHelper)
GetParameterSecondValue	Возвращает второе значение параметра, заданного в запросе request, для параметра с именем name. Если значение не задано или количество значений меньше одного, то будет выброшено исключение. (Определяется TessaViewRequestHelper)
GetParameterSingleIsNull	Возвращает признак того, что единственное значение параметра, заданного в запросе request, для параметра с именем name, равно null. Если значение не задано или количество значений не равно одному, то будет выброшено исключение. Метод учитывает операторы "пусто" IsNullCriteriaOperator и "не пусто" IsNotNullCriteriaOperator. (Определяется TessaViewRequestHelper)
GetParameterSingleValue	Возвращает единственное значение параметра, заданного в запросе request, для параметра с именем name. Если значение не задано или количество значений не равно одному, то будет выброшено исключение. (Определяется TessaViewRequestHelper)
GetParameterValueCount	Возвращает число заданных значений параметра. Если параметр не задан или условий больше чем 1, то возвращает -1. (Определяется TessaViewRequestHelper)
Invoke	(Определяется ComHelper)
IsAnySubsetDefined	Проверяет необходимость работы в режиме подмножества. (Определяется TessaViewRequestHelper)
IsDefinedAllParametersOrSubset	Проверяет, что все параметры или сабсеты, имена которых указаны в ключах хеш-таблицы keywordParameters, определены в запросе request. (Определяется ViewRequestExtender)
IsDefinedParameter	Определяет, задан ли параметр с именем name в запросе request. (Определяется TessaViewRequestHelper)
IsSubsetDefined	Проверяет, выполняется ли запрос в режиме одного из указанных подмножеств. (Определяется TessaViewRequestHelper)
IterateParameterCriteriasAsync	Выполняет делегат operateAsync над всеми значениями критериев, указанные в параметре запроса с именем name. Не выполняет действий, если параметр отсутствует в запросе. (Определяется TessaViewRequestHelper)
RemoveDuplicateParameters	Удаляет из запроса request параметры с такими же именами, которые встречались ранее. (Определяется TessaViewRequestHelper)
RemoveParameter	Удаляет параметр с именем name из запроса к представлению. (Определяется TessaViewRequestHelper)
RemovePredefinedParameters	Удаляет из запроса request параметры с зарезервированными именами: AdministratorPredefinedParam, SubsetPredefinedParam, NormalPredefinedParam. (Определяется TessaViewRequestHelper)
Set	(Определяется ComHelper)
SortDirection	Получает порядок сортировки для столбца columnAlias в запросе request. Возвращает строку "asc", если выполняется сортировка по возрастанию; строку "desc", если выполняется сортировка по убыванию; или null, если сортировка по столбцу не выполняется. (Определяется TessaViewRequestHelper)
SortedBy	Проверяет наличие колонки columnAlias в списке колонок, по которым осуществляется сортировка в запросе request. (Определяется TessaViewRequestHelper)
TryGetParameter	Возвращает параметр запроса к представлению по имени name. (Определяется TessaViewRequestHelper)

См. также

Ссылки

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