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

Интерфейс SearchPanelStoreType

interface SearchPanelStoreType {
    advancedSearchKey: (keyof ISearchPayload) | undefined;
    advancedSearchMode: boolean;
    createAttributeST: CreateAttributeSTFunction;
    handleClear?: () => void;
    keyword: string;
    mapST: Record<UniverseSearch.TermsGroupId, IAbstractDataSearchTerm[]>;
    MAX_LOGIC_TERM_COUNT: number;
    MAX_LOGIC_TERM_DEEP: number;
    queryMap: {
        ""?: SearchQuery<any>;
        "com.unidata.mdm.rest.v2.workflow.core"?: SearchQuery<any>;
        "org.unidata.dg.rest.v1.data"?: SearchQuery<any>;
        "org.unidata.mdm.rest.v2.data"?: SearchQuery<any>;
        "org.unidata.mdm.rest.v2.dq.data"?: SearchQuery<any>;
    };
    requiredTermGroups: (keyof ITermsGroup)[];
    rootAdvancedTerm: LogicGroupST<IAbstractDataSearchTerm> | undefined;
    routerStore: RouterStoreType;
    searchTermGroups: {
        groupId: keyof ITermsGroup;
        payloadKey: keyof ISearchPayload;
    }[];
    searchTerms: IObservableArray<IAbstractDataSearchTerm>;
    searchTermsMapByPayloadKeys: {
        ""?: IAbstractDataSearchTerm[];
        "com.unidata.mdm.rest.v2.workflow.core"?: IAbstractDataSearchTerm[];
        "org.unidata.dg.rest.v1.data"?: IAbstractDataSearchTerm[];
        "org.unidata.mdm.rest.v2.data"?: IAbstractDataSearchTerm[];
        "org.unidata.mdm.rest.v2.dq.data"?: IAbstractDataSearchTerm[];
    };
    withDraftsOnly: boolean;
    withInactiveOnly: boolean;
    get hasAdvancedSearch(): boolean;
    get hasTermErrors(): boolean;
    get listST(): ST[];
    get listSTJson(): JsonData[];
    get rootAdvancedST(): LogicGroupST<ST> | undefined;
    addTerm(
        term: JsonData | IAbstractDataSearchTerm,
        key: keyof ISearchPayload,
    ): void;
    clearSearch(): void;
    createGroupST(groupData: JsonData): LogicGroupST<IAbstractDataSearchTerm>;
    createST(term: JsonData): IAbstractDataSearchTerm;
    deleteTerm(term: IAbstractDataSearchTerm, key: keyof ISearchPayload): void;
    findSearchTerm(key: string): IAbstractDataSearchTerm | undefined;
    getAllTermsCount(): number;
    getQuery(
        _params?: {
            pagination: { count: number; page: number; start: number };
            sortFields?: ISortField[];
        },
    ): Promise<Partial<ISearchPayload>>;
    hasPrev(key: keyof ITermsGroup): boolean;
    registerQuery(
        key: keyof ISearchPayload,
        searchQuery: SearchQuery<any>,
    ): void;
    setAdvancedSearchMode(advanced: boolean): void;
    setKeyword(keyword: string): void;
    unregisterQuery(key: keyof ISearchPayload): void;
}

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

Индекс

Свойства

advancedSearchKey: (keyof ISearchPayload) | undefined

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

advancedSearchMode: boolean

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

createAttributeST: CreateAttributeSTFunction
handleClear?: () => void

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

keyword: string

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

mapST: Record<UniverseSearch.TermsGroupId, IAbstractDataSearchTerm[]>
MAX_LOGIC_TERM_COUNT: number

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

MAX_LOGIC_TERM_DEEP: number

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

queryMap: {
    ""?: SearchQuery<any>;
    "com.unidata.mdm.rest.v2.workflow.core"?: SearchQuery<any>;
    "org.unidata.dg.rest.v1.data"?: SearchQuery<any>;
    "org.unidata.mdm.rest.v2.data"?: SearchQuery<any>;
    "org.unidata.mdm.rest.v2.dq.data"?: SearchQuery<any>;
}
requiredTermGroups: (keyof ITermsGroup)[]
rootAdvancedTerm: LogicGroupST<IAbstractDataSearchTerm> | undefined
routerStore: RouterStoreType

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

searchTermGroups: {
    groupId: keyof ITermsGroup;
    payloadKey: keyof ISearchPayload;
}[]

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

searchTermsMapByPayloadKeys: {
    ""?: IAbstractDataSearchTerm[];
    "com.unidata.mdm.rest.v2.workflow.core"?: IAbstractDataSearchTerm[];
    "org.unidata.dg.rest.v1.data"?: IAbstractDataSearchTerm[];
    "org.unidata.mdm.rest.v2.data"?: IAbstractDataSearchTerm[];
    "org.unidata.mdm.rest.v2.dq.data"?: IAbstractDataSearchTerm[];
}
withDraftsOnly: boolean
withInactiveOnly: boolean

Акцессоры

  • get hasAdvancedSearch(): boolean

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

    Возвращает boolean

  • get hasTermErrors(): boolean

    Геттер проверки на ошибки поисковых критериев

    Возвращает boolean

  • get listST(): ST[]

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

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

  • get listSTJson(): JsonData[]

    Геттер получения json-данных

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

  • get rootAdvancedST(): LogicGroupST<ST> | undefined

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

    Возвращает LogicGroupST<ST> | undefined

Методы

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

    Возвращает number

  • Метод получения запроса для поиска

    Параметры

    • Optional_params: {
          pagination: { count: number; page: number; start: number };
          sortFields?: ISortField[];
      }

      параметры, которые необходимо передать в поисковый запрос

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

  • Параметры

    • key: keyof ITermsGroup

    Возвращает boolean

  • Метод регистрации поискового запроса

    Параметры

    • key: keyof ISearchPayload

      ключ поискового запроса

    • searchQuery: SearchQuery<any>

      поисковый запрос

    Возвращает void

  • Метод задания параметра advancedSearchMode

    Параметры

    • advanced: boolean

      флаг, расширенный поиск или нет

    Возвращает void

  • Метод задания ключевого слова

    Параметры

    • keyword: string

      ключевое слово

    Возвращает void

  • Метод удаления поискового запроса

    Параметры

    • key: keyof ISearchPayload

      ключ поискового запроса

    Возвращает void