import { AdvancedSearchState, AdvancedSearch } from '../../PredefinedConfig/RunTimeState/AdvancedSearchState';
import { TypeUuid } from '../../PredefinedConfig/Uuid';
/**
 * Provides full and comprehensive run-time access to the Advanced Search function and associated state.
 */
export interface IAdvancedSearchApi {
    /**
     * Retrieves the Advanced Search State
     */
    getAdvancedSearchState(): AdvancedSearchState;
    /**
     * Replaces the current Advanced Search state with the inputted one
     *
     * **warning: use this method very carefully!**
     * @param advancedSearchState
     */
    setAdvancedSearchState(advancedSearchState: AdvancedSearchState): void;
    /**
     * Applies the Advanced Search function using the given Advanced Search name
     *
     * **note: the name provided must be in one of the Advanced Searches currently in the State**
     * @param advancedSearchName
     */
    setAdvancedSearch(advancedSearchName: string): void;
    /**
     * Clears the Advanced Search so that all rows in the Grid are displayed (subject to any other filters or quick search you might have applied).
     *
     * **note: this method does not delete the current Advanced Search**
     */
    clearAdvancedSearch(): void;
    /**
     * Adds a new Advanced Search to the State
     * @param advancedSearch advanced search to add
     */
    addAdvancedSearch(advancedSearch: AdvancedSearch): void;
    /**
     * Updates (essentially) an existing Advanced Search with the provided alternative.
     *
     * The comparison will be on Uuid not *Name*, which allows you to change the name of an Advanced Search.
     * @param advancedSearch
     */
    editAdvancedSearch(advancedSearch: AdvancedSearch): void;
    /**
     *Deletes the advanced search from the State
     * @param advancedSearch
     */
    deleteAdvancedSearch(advancedSearch: AdvancedSearch): void;
    /**
     *Deletes the advanced search with the given name from the State
     * @param advancedSearchName
     */
    deleteAdvancedSearchByName(advancedSearchName: string): void;
    /**
     *Deletes the advanced search with the given Uuid from the State
     * @param uuid
     */
    deleteAdvancedSearchByUuid(uuid: TypeUuid): void;
    /**
     *Returns the currently selected Advanced Search
     */
    getCurrentAdvancedSearch(): AdvancedSearch | undefined;
    /**
     * Returns the name of the currently selected Advanced Search
     */
    getCurrentAdvancedSearchName(): string | undefined;
    /**
     * Returns the Advanced Search in the State which has the inputted uuid
     * @param uuid the uuid of the Advanced Search to retrieve
     */
    getAdvancedSearchByUuid(uuid: TypeUuid): AdvancedSearch | undefined;
    /**
     * Returns the Advanced Search in the State which has the inputted name
     * @param advancedSearchName the name of the Advanced Search to retrieve
     */
    getAdvancedSearchByName(advancedSearchName: string): AdvancedSearch | undefined;
    /**
     * Returns all the Advanced Searches in the State
     */
    getAllAdvancedSearch(): AdvancedSearch[];
}