Preparing search index...

    Interface DGSearchStoreFacade<P, C, SR>

    interface DGSearchStoreFacade<
        P extends AbstractSearchPanelStore = AbstractSearchPanelStore,
        C extends AbstractSearchColumnsStore = AbstractSearchColumnsStore,
        SR extends AbstractSearchResultStore<P> = AbstractSearchResultStore<P>,
    > {
        innerColumnsStore: undefined | C;
        isDataLoadedInner: boolean;
        isLoadingInner: boolean;
        isQueryInvalid: boolean;
        metaSearchStore: AssetTypeMetaSearchStoreFacade;
        routerStore: RouterStoreType;
        savedSearchStore: SavedSearchStore<JsonData>;
        searchEntityKey: SearchEntityKey;
        searchPanel: P;
        searchResult: SR;
        get columns(): ISearchColumn[];
        get columnsStore(): undefined | C;
        get displayName(): string;
        get isDataLoaded(): boolean;
        get isLoading(): boolean;
        get isSilent(): boolean;
        get namespaceId(): keyof INamespace;
        get savedSearchId(): string;
        get savedSearchNamespaces(): SearchNamespaceId[];
        get searchHits(): SearchHit[];
        get searchNamespaceId(): SearchNamespaceId;
        get tableColumns(): (
            | TableColumnWithoutData<SearchHit, undefined>
            | (
                TableColumnWithoutData<SearchHit, ISearchColumn> & { data: ISearchColumn; }
            )
        )[];
        get totalRecords(): number;
        get typeName(): string;
        changeShow(column: ISearchColumn, checked: boolean): void;
        checkResourceRight(item: ILastSearchItem<JsonData>): boolean;
        clearSearch(): void;
        clearSearchEntityKey(): void;
        createColumnStore(metaModel: undefined | IMetaModel): undefined | C;
        doSearch(): Promise<void>;
        doSearch(
            namespaceId: SearchNamespaceId,
            typeName: string,
            displayName: string,
        ): Promise<void>;
        getSavedSearchItems(
            isSystem?: boolean,
        ): Map<string, ILastSearchItem<JsonData>[]>;
        initialize(): Promise<void>;
        loadData(): Promise<void>;
        loadMeta(): Promise<undefined | IMetaModel>;
        registerSearchQuery(): void;
        searchData(): Promise<void>;
        setIsQueryInvalid(isInvalid: boolean): void;
        setLoading(isLoading: boolean): void;
        toggleAdvancedMode(advanced: boolean): void;
        validateSearchTerms(): Promise<void>;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    innerColumnsStore isDataLoadedInner isLoadingInner isQueryInvalid metaSearchStore routerStore savedSearchStore searchEntityKey searchPanel searchResult

    Accessors

    columns columnsStore displayName isDataLoaded isLoading isSilent namespaceId savedSearchId savedSearchNamespaces searchHits searchNamespaceId tableColumns totalRecords typeName

    Methods

    changeShow checkResourceRight clearSearch clearSearchEntityKey createColumnStore doSearch getSavedSearchItems initialize loadData loadMeta registerSearchQuery searchData setIsQueryInvalid setLoading toggleAdvancedMode validateSearchTerms

    Properties

    innerColumnsStore: undefined | C
    isDataLoadedInner: boolean

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

    isLoadingInner: boolean
    isQueryInvalid: boolean

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

    metaSearchStore: AssetTypeMetaSearchStoreFacade
    routerStore: RouterStoreType

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

    savedSearchStore: SavedSearchStore<JsonData>

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

    searchEntityKey: SearchEntityKey
    searchPanel: P

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

    searchResult: SR

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

    Accessors

    • get columns(): ISearchColumn[]

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

      Returns ISearchColumn[]

    • get columnsStore(): undefined | C

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

      Returns undefined | C

    • get displayName(): string

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

      Returns string

    • get isDataLoaded(): boolean

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

      Returns boolean

    • get isLoading(): boolean

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

      Returns boolean

    • get isSilent(): boolean

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

      Returns boolean

    • get namespaceId(): keyof INamespace

      Returns keyof INamespace

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

      @universe-platform/search 2.0.0

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

    • get savedSearchId(): string

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

      Returns string

    • get savedSearchNamespaces(): SearchNamespaceId[]

      Returns SearchNamespaceId[]

    • get searchHits(): SearchHit[]

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

      Returns SearchHit[]

    • get searchNamespaceId(): SearchNamespaceId

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

      Returns SearchNamespaceId

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

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

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

    • get totalRecords(): number

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

      Returns number

    • get typeName(): string

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

      Returns string

    Methods

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

      Parameters

      • column: ISearchColumn

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

      • checked: boolean

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

      Returns void

    • Returns Promise<void>

    • Parameters

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

      Returns Promise<void>

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

      Parameters

      • OptionalisSystem: boolean

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

      Returns Map<string, ILastSearchItem<JsonData>[]>

    • Returns Promise<void>

    • Step for load data

      Returns Promise<void>

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

      Returns Promise<undefined | IMetaModel>

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

      Returns Promise<void>

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

      Parameters

      • isInvalid: boolean

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

      Returns void

    • Parameters

      • isLoading: boolean

      Returns void

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

      Parameters

      • advanced: boolean

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

      Returns void

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

      Returns Promise<void>

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

    On This Page

    Properties
    Accessors
    Methods