Class AbstractSearchPanelStore<ST, T>`Abstract`

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

Public

Type Parameters

ST extends AbstractSearchTerm = AbstractSearchTerm
T extends JsonData = JsonData

Hierarchy (View Summary)

AbstractSearchPanelStore
- SearchPanelStoreType

Constructors

constructor

new AbstractSearchPanelStore<
    ST extends AbstractSearchTerm = AbstractSearchTerm,
    T extends JsonData = JsonData,
>(
    routerStore: RouterStoreType,
): AbstractSearchPanelStore<ST, T>
Type Parameters
- ST extends AbstractSearchTerm = AbstractSearchTerm
- T extends JsonData = JsonData
Parameters
- routerStore: RouterStoreType
Returns AbstractSearchPanelStore<ST, T>
- Defined in app-sdk/index.d.ts:1605

Properties

`Readonly`advancedSearchKey

advancedSearchKey: undefined | (keyof ISearchPayload)

Ключ расширенного поиска Чтобы его активировать необходимо переопределить этот параметр в дочернем классе

advancedSearchMode

advancedSearchMode: boolean

Флаг определяющий включен ли расширенный поиск

`Optional`handleClear

handleClear?: () => void

Метод обработки очистки критериев

keyword

keyword: string

Ключевое слово поискового критерия

`Readonly`MAX_LOGIC_TERM_COUNT

MAX_LOGIC_TERM_COUNT: number

Максимальное количество критериев

`Readonly`MAX_LOGIC_TERM_DEEP

MAX_LOGIC_TERM_DEEP: number

Максимальная глубина логических критериев

`Protected`queryMap

queryMap: {
    ""?: SearchQuery<any>;
    "org.unidata.dg.rest.v1.data"?: SearchQuery<any>;
    "org.unidata.mdm.rest.v2.data"?: SearchQuery<any>;
}

`Protected`rootAdvancedTerm

rootAdvancedTerm: undefined | LogicGroupST<ST>

`Readonly`routerStore

routerStore: RouterStoreType

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

searchTerms

searchTerms: IObservableArray<ST>

Поисковые критерии

`Protected`searchTermsMapByPayloadKeys

searchTermsMapByPayloadKeys: {
    ""?: ST[];
    "org.unidata.dg.rest.v1.data"?: ST[];
    "org.unidata.mdm.rest.v2.data"?: ST[];
}

Accessors

hasAdvancedSearch

get hasAdvancedSearch(): boolean
Геттер для проверки активен ли расширенный поиск

Returns boolean
- Defined in app-sdk/index.d.ts:1591

hasTermErrors

get hasTermErrors(): boolean
Геттер проверки на ошибки поисковых критериев

Returns boolean
- Defined in app-sdk/index.d.ts:1609

listST

get listST(): ST[]
Геттер получения всех поисковых критериев

Returns ST[]
- Defined in app-sdk/index.d.ts:1650

listSTJson

get listSTJson(): JsonData[]
Геттер получения json-данных

Returns JsonData[]
- Defined in app-sdk/index.d.ts:1646

rootAdvancedST

get rootAdvancedST(): undefined | LogicGroupST<ST>
Геттер получения корневого расширенного критерия

Returns undefined | LogicGroupST<ST>
- Defined in app-sdk/index.d.ts:1596

Methods

addTerm

addTerm(term: ST | T, key: keyof ISearchPayload): void
Метод добавления поискового критерия
Parameters
- term: ST | T
  поисковый критерий
- key: keyof ISearchPayload
  ключ поискового критерия
Returns void
- Defined in app-sdk/index.d.ts:1657

clearSearch

clearSearch(): void
Метод очистки поиска

Returns void
- Defined in app-sdk/index.d.ts:1642

`Protected`createGroupST

createGroupST(groupData: T): LogicGroupST<ST>
Parameters
- groupData: T
Returns LogicGroupST<ST>
- Defined in app-sdk/index.d.ts:1683

`Protected`createST

createST(term: T): ST
Parameters
- term: T
Returns ST
- Defined in app-sdk/index.d.ts:1682

deleteTerm

deleteTerm(term: ST, key: keyof ISearchPayload): void
Метод удаления поискового критерия
Parameters
- term: ST
  поисковый критерий
- key: keyof ISearchPayload
  ключ поискового критерия
Returns void
- Defined in app-sdk/index.d.ts:1664

findSearchTerm

findSearchTerm(key: string): undefined | ST
Метод поиска поискового критерия по ключу
Parameters
- key: string
  ключ поискового критерия
Returns undefined | ST
- Defined in app-sdk/index.d.ts:1632

getAllTermsCount

getAllTermsCount(): number
Метод получения количества всех поисковых критериев

Returns number
- Defined in app-sdk/index.d.ts:1668

getQuery

getQuery(
    _params?: {
        pagination: { count: number; page: number; start: number };
        sortFields?: ISortField[];
    },
): Promise<Partial<ISearchPayload>>
Метод получения запроса для поиска
Parameters
- Optional_params: {
  pagination: { count: number; page: number; start: number };
  sortFields?: ISortField[];
  }
  параметры, которые необходимо передать в поисковый запрос
Returns Promise<Partial<ISearchPayload>>
- Defined in app-sdk/index.d.ts:1674

registerQuery

registerQuery(key: keyof ISearchPayload, searchQuery: SearchQuery<any>): void
Метод регистрации поискового запроса
Parameters
- key: keyof ISearchPayload
  ключ поискового запроса
- searchQuery: SearchQuery<any>
  поисковый запрос
Returns void
- Defined in app-sdk/index.d.ts:1620

setAdvancedSearchMode

setAdvancedSearchMode(advanced: boolean): void
Метод задания параметра advancedSearchMode
Parameters
- advanced: boolean
  флаг, расширенный поиск или нет
Returns void
- Defined in app-sdk/index.d.ts:1587

setKeyword

setKeyword(keyword: string): void
Метод задания ключевого слова
Parameters
- keyword: string
  ключевое слово
Returns void
- Defined in app-sdk/index.d.ts:1638

unregisterQuery

unregisterQuery(key: keyof ISearchPayload): void
Метод удаления поискового запроса
Parameters
- key: keyof ISearchPayload
  ключ поискового запроса
Returns void
- Defined in app-sdk/index.d.ts:1626

Class AbstractSearchPanelStore<ST, T>Abstract

Public

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns AbstractSearchPanelStore<ST, T>

Properties

ReadonlyadvancedSearchKey

advancedSearchMode

OptionalhandleClear

keyword

ReadonlyMAX_LOGIC_TERM_COUNT

ReadonlyMAX_LOGIC_TERM_DEEP

ProtectedqueryMap

ProtectedrootAdvancedTerm

ReadonlyrouterStore

searchTerms

ProtectedsearchTermsMapByPayloadKeys

Accessors

hasAdvancedSearch

Returns boolean

hasTermErrors

Returns boolean

listST

Returns ST[]

listSTJson

Returns JsonData[]

rootAdvancedST

Returns undefined | LogicGroupST<ST>

Methods

addTerm

Parameters

Returns void

clearSearch

Returns void

ProtectedcreateGroupST

Parameters

Returns LogicGroupST<ST>

ProtectedcreateST

Parameters

Returns ST

deleteTerm

Parameters

Returns void

findSearchTerm

Parameters

Returns undefined | ST

getAllTermsCount

Returns number

getQuery

Parameters

Returns Promise<Partial<ISearchPayload>>

registerQuery

Parameters

Returns void

setAdvancedSearchMode

Parameters

Returns void

setKeyword

Parameters

Returns void

unregisterQuery

Parameters

Returns void

On This Page

Class AbstractSearchPanelStore<ST, T>`Abstract`

`Readonly`advancedSearchKey

`Optional`handleClear

`Readonly`MAX_LOGIC_TERM_COUNT

`Readonly`MAX_LOGIC_TERM_DEEP

`Protected`queryMap

`Protected`rootAdvancedTerm

`Readonly`routerStore

`Protected`searchTermsMapByPayloadKeys

`Protected`createGroupST

`Protected`createST