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

Интерфейс WorkflowSearchPanelStoreType

Интерфейс для хранилища поисковой панели бизнес-процесса

interface WorkflowSearchPanelStoreType {
    advancedSearchKey: (keyof ISearchPayload) | undefined;
    advancedSearchMode: boolean;
    handleClear?: () => void;
    keyword: string;
    MAX_LOGIC_TERM_COUNT: number;
    MAX_LOGIC_TERM_DEEP: number;
    routerStore: RouterStoreType;
    searchTerms: IObservableArray<AbstractSearchTerm>;
    setSystemVariables: (
        systemVariable: ITaskProcessSystemVariables | IProcessSystemVariables,
    ) => void;
    get hasAdvancedSearch(): boolean;
    get hasTermErrors(): boolean;
    get listST(): ST[];
    get listSTJson(): JsonData[];
    get rootAdvancedST(): LogicGroupST<ST> | undefined;
    get selectedProcessDefinition(): ProcessDefinition | undefined;
    get SystemCriteria(): Record<string, AbstractSearchTerm>;
    addTerm(
        term: AbstractSearchTerm | JsonData,
        key: keyof ISearchPayload,
    ): void;
    clearSearch(): void;
    deleteTerm(term: AbstractSearchTerm, key: keyof ISearchPayload): void;
    findSearchTerm(key: string): any;
    getAllTermsCount(): number;
    getQuery(
        params?: SearchPanelGetQueryParams,
    ): Promise<Partial<ISearchPayload>>;
    initDefaultSearchTerms(): void;
    isOnlyMyTasks(): boolean;
    registerQuery(
        key: keyof ISearchPayload,
        searchQuery: SearchQuery<any>,
    ): void;
    setAdvancedSearchMode(advanced: boolean): void;
    setKeyword(keyword: string): void;
    setProcessDefinitions(processDefinitions: ProcessDefinition[]): void;
    unregisterQuery(key: keyof ISearchPayload): void;
}

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

Индекс

Свойства

advancedSearchKey: (keyof ISearchPayload) | undefined

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

advancedSearchMode: boolean

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

handleClear?: () => void

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

keyword: string

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

MAX_LOGIC_TERM_COUNT: number

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

MAX_LOGIC_TERM_DEEP: number

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

routerStore: RouterStoreType

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

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

setSystemVariables: (
    systemVariable: ITaskProcessSystemVariables | IProcessSystemVariables,
) => void

Метод, который устанавливает системные переменные

Объявление типа

Акцессоры

  • 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

  • get SystemCriteria(): Record<string, AbstractSearchTerm>

    Геттер системного поискового критерия

    Возвращает Record<string, AbstractSearchTerm>

Методы

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

    Параметры

    • term: AbstractSearchTerm

      поисковый критерий

    • key: keyof ISearchPayload

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

    Возвращает void

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

    Параметры

    • key: string

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

    Возвращает any

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

    Возвращает number

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

    Параметры

    • Optionalparams: SearchPanelGetQueryParams

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

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

  • Метод, инициализирующий поисковые критерии по умолчанию

    Возвращает void

  • Метод, проверяющий относятся ли задачи процесса к текущему пользователю

    Возвращает boolean

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

    Параметры

    • key: keyof ISearchPayload

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

    • searchQuery: SearchQuery<any>

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

    Возвращает void

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

    Параметры

    • advanced: boolean

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

    Возвращает void

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

    Параметры

    • keyword: string

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

    Возвращает void

  • Метод, устанавливающий массив процессов

    Параметры

    • processDefinitions: ProcessDefinition[]

      массив, который нужно установить

    Возвращает void

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

    Параметры

    • key: keyof ISearchPayload

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

    Возвращает void