Юниверс DG SDK UI
v2.15.0

Класс AbstractSearchStore<P, C, SR>

Абстрактный стор для страниц поиска

Параметры типа

Иерархия (Просмотр сводки)

Реализует

Индекс

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

Свойства

innerColumnsStore: C | undefined
isDataLoadedInner: boolean

Флаг, отображающий загружены ли данные

isLoadingInner: boolean
isQueryInvalid: boolean

Флаг, отображающий есть ли ошибки в запросе

queryInvalidType: INVALID_QUERY_TYPE | undefined

Тип текущего невалидного поиска

routerStore: RouterStoreType

Стор маршрутизации

savedSearchStore: SavedSearchStore<JsonData>

Хранилище сохраненного поиска

searchEntityKey: SearchEntityKey
searchPanel: P

Поисковая панель

searchResult: SR

Поисковый результат

viewVariant: string | undefined
NAMESPACE_DELIMITER: string

Разделитель для пространства имен

Акцессоры

  • get columns(): ISearchColumn[]

    Геттер получения колонок

    Возвращает ISearchColumn[]

  • get columnsStore(): C | undefined

    Геттер получения хранилища колонок

    Возвращает C | undefined

  • get displayName(): string

    Геттер получения отображаемого имени текущей сущности

    Возвращает string

  • get isDataLoaded(): boolean

    Геттер получения флага isDataLoaded

    Возвращает boolean

  • get isLoading(): boolean

    Геттер получения флага isLoading

    Возвращает boolean

  • get isSilent(): boolean

    Геттер получения флага isSilent, с помощью которого критерии поиска добавляются к url, если он равен false

    Возвращает boolean

  • get namespaceId(): keyof INamespace

    Возвращает keyof INamespace

    Необходимо использовать searchNamespaceId Для проверки принадлежности неймспейса к системным необходимо использовать SearchNamespaceManager.isSystemNamespace

  • get savedSearchId(): string

    Геттер получения id сохраненного поиска

    Возвращает string

  • get savedSearchNamespaces(): SearchNamespaceId[]

    Возвращает SearchNamespaceId[]

  • get searchHits(): SearchHit[]

    Геттер получения поисковых результатов

    Возвращает SearchHit[]

  • get searchNamespaceId(): SearchNamespaceId

    Геттер получения пространства имен текущей сущности

    Возвращает SearchNamespaceId

  • get tableColumns(): (
        | TableColumnWithoutData<SearchHit, undefined>
        | (
            TableColumnWithoutData<SearchHit, ISearchColumn> & { data: ISearchColumn; }
        )
    )[]

    Геттер получения колонки таблицы

    Возвращает (
        | TableColumnWithoutData<SearchHit, undefined>
        | (
            TableColumnWithoutData<SearchHit, ISearchColumn> & { data: ISearchColumn; }
        )
    )[]

  • get totalRecords(): number

    Геттер получения количества найденных записей

    Возвращает number

  • get typeName(): string

    Геттер получения имени текущей сущности

    Возвращает string

Методы

  • Параметры

    • terms: JsonData[]
    • defaultSearchPayloadKey: keyof ISearchPayload

    Возвращает void

  • Метод, изменяющий отображение колонки

    Параметры

    • column: ISearchColumn

      колонка для выбора

    • checked: boolean

      флаг, выбрана ли колонка

    Возвращает void

  • Метод, изменяющий отображение всех колонок

    Параметры

    • checked: boolean

      флаг, выбраны ли все колонки

    Возвращает void

  • Метод очистки поиска

    Возвращает void

  • Параметры

    Возвращает C | undefined

  • Возвращает Promise<void>

  • Параметры

    • namespaceId: SearchNamespaceId
    • typeName: string
    • displayName: string

    Возвращает Promise<void>

  • Метод получения элементов сохранного поиска

    Параметры

    • OptionalisSystem: boolean

      флаг, показывающий системный поиск или нет

    Возвращает Map<string, ILastSearchItem<JsonData>[]>

  • Step for load data

    Возвращает Promise<void>

  • Возвращает void

  • Возвращает void

  • Step for get meta info and fill columns from it. If your columns is static - return undefined.

    Возвращает Promise<IMetaModel | undefined>

  • Возвращает void

  • Метод поиска данных

    Возвращает Promise<void>

  • Метод установки флага isQueryInvalid

    Параметры

    • isInvalid: boolean

      флаг показывающий, есть ли ошибки в поисковом запросе

    • Optionaltype: INVALID_QUERY_TYPE

      тип текущего невалидного поиска

    Возвращает void

  • Параметры

    • isLoading: boolean

    Возвращает void

  • Параметры

    Возвращает void

  • Возвращает void

  • Возвращает void

  • Параметры

    • variant: string

    Возвращает void

  • Метод, переключающий расширенный режим

    Параметры

    • advanced: boolean

      флаг, расширенный режим или нет

    Возвращает void

  • Метод валидации поисковых критериев.

    Возвращает Promise<void>

    Promise.resolve() в случае успешной валидации и Promise.reject() с ValidationException в случае неуспешной.