net.nemerosa.ontrack.model.structure.SearchService.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ontrack-model Show documentation

Ontrack module: ontrack-model

There is a newer version: 4.4.5

package net.nemerosa.ontrack.model.structure

import net.nemerosa.ontrack.model.Ack

/**
 * Service to search based on text
 */
interface SearchService {

    /**
     * Gets the list of types of search
     */
    val searchResultTypes: List

    /**
     * Search entry point
     */
    @Deprecated("Use the paginated search", replaceWith = ReplaceWith("paginatedSearch"))
    fun search(request: SearchRequest): Collection = paginatedSearch(request).items

    /**
     * Paginated search entry point
     */
    fun paginatedSearch(request: SearchRequest): SearchResults

    /**
     * Makes sure all search indexes are initialized.
     */
    fun indexInit()

    /**
     * Resetting all search indexes, optionally restoring them.
     *
     *
     * This method is mostly used for testing but could be used
     * to reset faulty indexes.
     *
     * @param reindex `true` to relaunch the indexation afterwards
     * @return OK if indexation was completed successfully
     */
    fun indexReset(reindex: Boolean): Ack

}