Элемент FilterDescriptor в элементе FilterDescriptors (схема BDCMetadata)

Область применения: SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013

Задает дескриптор фильтра для метода.

Пространство имен: http://schemas.microsoft.com/windows/2007/BusinessDataCatalog

Схема: BDCMetadata

<FilterDescriptor Type = "String" FilterField = "String" Name = "String" DefaultDisplayName = "String" IsCached = "Boolean"> </FilterDescriptor>

Элементы и атрибуты

В разделах ниже приводится описание атрибутов, дочерних и родительских элементов.

Атрибуты

Атрибут

Описание

**Тип**

Обязательно.

Тип дескриптора фильтра.

В следующей таблице приведен список возможных значений этого атрибута.

Значение

Описание

Ограничение

Используется при запросе внешней системы, значение которой можно интерпретировать как ограничение на количество внешних элементов (**EntityInstances**), возвращаемых при вызове метода, к которому она принадлежит.

PageNumber

Wildcard

Используется при запросе внешней системы. Значение этого параметра представляет шаблон из обычных и подстановочных знаков, который сравнивается со значением конкретного поля в наборе элементов EntityInstances. Из внешней системы возвращаются только те элементы EntityInstances, значения полей которых соответствуют заданному шаблону.

Usercontext

Используется при запросе внешней системы. В качестве значения этого свойства любым клиентским приложением может автоматически задаваться удостоверение пользователя, вызывающего внешнюю систему. В дальнейшем это значение может использоваться внешней системой для авторизации и фильтрации возвращаемых результатов.

UserCulture

Username

Password

LastId

SsoTicket

UserProfile

Используется при запросе внешней системы. Для получения значения этого свойства необходимо проверить текущий профиль пользователя. Это значение используется внешней системой для фильтрации возвращаемых результатов.

Comparison

Используется при запросе внешней системы. Внешняя система может сравнить значение **CompareFilter** со значением определенного поля набора **EntityInstances** и только те **EntityInstances**, где значения полей проходят тест сравнения.

Timestamp

Input

Используется при вызове операции во внешней системе. Внешняя система может использовать значение **InputFilter** в качестве дополнительных аргументов для операции.

Выходные данные

Используется при вызове операции во внешней системе. Дополнительные результаты операции, которые не могут быть записаны **ReturnTypeDescriptor**, можно получить в виде значения **InputOutputFilter**.

InputOutput

Используется при вызове операции во внешней системе. Внешняя система может использовать значение **InputOutputFilter** в качестве дополнительных аргументов для операции, а дополнительные результаты операции, которые не могут быть записаны с помощью **ReturnTypeDescriptor**, можно получить в виде значения **InputOutputFilter**.

Пакетная обработка

BatchingTermination

Activityid

**ActivityId** используется при вызове операции во внешней системе. Этому атрибуту присваивается значение, соответствующее идентификатору GUID, который представляет текущий контекст операции. Если это значение недоступно, формируется случайный идентификатор GUID. В SharePoint Foundation 2010 этот фильтр использует **CorrelationID**.

**FilterField**

Необязательный параметр.

Тип атрибута: **String**

**Имя**

Обязательно.

Имя дескриптора фильтра.

Тип атрибута: **String**

**DefaultDisplayName**

Необязательный параметр.

Установленное по умолчанию отображаемое имя дескриптора фильтра.

Тип атрибута: **String**

**IsCached**

Необязательный параметр.

Задает частоту использования этого дескриптора фильтра. Если задано значение **true**, служба подключения к бизнес-данным (BDC) кэширует этот дескриптор фильтра в памяти.

Значение по умолчанию: **true**

Тип атрибута: **Boolean**

Дочерние элементы

Элемент Описание
Элемент LocalizedDisplayNames в MetadataObject (схема BDCMetadata) Локализованные отображаемые имена дескриптора фильтра.
Элемент Properties в элементе MetadataObject (схема BDCMetadata) Свойства дескриптора фильтра.

Родительские элементы

Элемент Описание
Элемент FilterDescriptors в элементе Method (схема BDCMetadata) Список дескрипторов фильтра для метода.