Class AbstractSearchStore<P, C, SR>Abstract

constructor

• new AbstractSearchStore<
      P extends SearchPanelStoreType<AbstractSearchTerm, JsonData>,
      C extends IAbstractSearchColumnStore,
      SR extends SearchResultStoreType = SearchResultStoreType,
  >(
      routerStore: RouterStoreType,
      mainResponseKey: keyof ISearchPayload,
      searchEntityKey: SearchEntityKey,
      searchResultCtor: ClassCtor<SR>,
      searchPanelCtor: ClassCtor<P>,
      isSilent?: boolean,
      opts?: SearchStoreOpts,
  ): AbstractSearchStore<P, C, SR>

  Type Parameters

  • P extends SearchPanelStoreType<AbstractSearchTerm, JsonData>
  • C extends IAbstractSearchColumnStore
  • SR extends SearchResultStoreType = SearchResultStoreType

  Parameters

  • routerStore: RouterStoreType
  • mainResponseKey: keyof ISearchPayload
  • searchEntityKey: SearchEntityKey
  • searchResultCtor: ClassCtor<SR>
  • searchPanelCtor: ClassCtor<P>
  • OptionalisSilent: boolean
  • Optionalopts: SearchStoreOpts

  Returns AbstractSearchStore<P, C, SR>

isDataLoadedInner

isQueryInvalid

ReadonlyrouterStore

ReadonlysavedSearchStore

ReadonlysearchPanel

ReadonlysearchResult

viewVariant

StaticNAMESPACE_DELIMITER

columns

• get columns(): ISearchColumn[]

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

  Returns ISearchColumn[]

columnsStore

• get columnsStore(): undefined | C

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

  Returns undefined | C

displayName

• get displayName(): string

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

  Returns string

isDataLoaded

• get isDataLoaded(): boolean

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

  Returns boolean

isLoading

• get isLoading(): boolean

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

  Returns boolean

isSilent

• get isSilent(): boolean

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

  Returns boolean

namespaceId

• get namespaceId(): keyof INamespace

  Returns keyof INamespace

  Deprecated

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

  End Of Support

  @universe-platform/search 2.0.0

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

savedSearchId

• get savedSearchId(): string

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

  Returns string

searchHits

• get searchHits(): SearchHit[]

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

  Returns SearchHit[]

searchNamespaceId

• get searchNamespaceId(): SearchNamespaceId

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

  Returns SearchNamespaceId

tableColumns

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

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

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

totalRecords

• get totalRecords(): number

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

  Returns number

typeName

• get typeName(): string

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

  Returns string

changeShow

• changeShow(column: ISearchColumn, checked: boolean): void

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

  Parameters

  • column: ISearchColumn

    колонка для выбора
  • checked: boolean

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

  Returns void

changeShowAll

• changeShowAll(checked: boolean): void

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

  Parameters

  • checked: boolean

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

  Returns void

clearSearch

• clearSearch(): void

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

  Returns void

clearSearchEntityKey

• clearSearchEntityKey(): void

  Метод очистки текущей сущности

  Returns void

doSearch

• doSearch(): Promise<void>

  Returns Promise<void>

• doSearch(
      namespaceId: SearchNamespaceId,
      typeName: string,
      displayName: string,
  ): Promise<void>

  Parameters

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

  Returns Promise<void>

getSavedSearchItems

• getSavedSearchItems(
      isSystem?: boolean,
  ): Map<string, ILastSearchItem<JsonData>[]>

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

  Parameters

  • OptionalisSystem: boolean

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

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

searchData

• searchData(): Promise<void>

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

  Returns Promise<void>

setIsQueryInvalid

• setIsQueryInvalid(isInvalid: boolean): void

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

  Parameters

  • isInvalid: boolean

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

  Returns void

setViewVariant

• setViewVariant(variant: string): void

  Parameters

  • variant: string

  Returns void

toggleAdvancedMode

• toggleAdvancedMode(advanced: boolean): void

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

  Parameters

  • advanced: boolean

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

  Returns void