final long took) {
        this.numberOfSuggestDocs = numberOfSuggestDocs;
        this.numberOfInputDocs = numberOfInputDocs;
        this.took = took;
        if (errors == null || errors.isEmpty()) {
            hasError = false;
        } else {
            hasError = true;
            errors.forEach(this.errors::add);
        }
    }

        this.builder = builder;
    }

    public String getQueryDsl() {
        return builder.toString();
    }

    public long getTook() {
        return took;
    }

    public void setTook(long took) {
        this.took = took;
    }

    public int getTotalShards() {
        return totalShards;
    }

    public void setTotalShards(int totalShards) {
        this.totalShards = totalShards;

        this.builder = builder;
    }

    public String getQueryDsl() {
        return builder.toString();
    }

    public long getTook() {
        return took;
    }

    public void setTook(long took) {
        this.took = took;
    }

    public int getTotalShards() {
        return totalShards;
    }

    public void setTotalShards(int totalShards) {
        this.totalShards = totalShards;

        this.builder = builder;
    }

    public String getQueryDsl() {
        return builder.toString();
    }

    public long getTook() {
        return took;
    }

    public void setTook(long took) {
        this.took = took;
    }

    public int getTotalShards() {
        return totalShards;
    }

    public void setTotalShards(int totalShards) {
        this.totalShards = totalShards;

     * @param hook the validation error hook for handling errors
     * @return OptionalEntity containing the created synonym item or empty if creation failed
     */
    protected OptionalEntity<SynonymItem> createSynonymItem(final CreateForm form, final VaErrorHook hook) {
        try {
            return createSynonymItem(this, form, hook);
        } catch (final ValidationErrorException e) {

    }

    // Test hook method when MultiThreadedHttpConnectionManager class is not available
    public void test_hook_classNotFound() {
        // Create a custom hook that simulates class not found scenario
        FessCurtainFinallyHook customHook = new FessCurtainFinallyHook() {
            @Override
            public void hook(final FwAssistantDirector assistantDirector) {

This code won't be executed in your app, we only need it to *document* how that *external API* should look like.

But, you already know how to easily create automatic documentation for an API with **FastAPI**.

So we are going to use that same knowledge to document how the *external API* should look like... by creating the *path operation(s)* that the external API should implement (the ones your API will call).

/// tip

    //                                                                               Hook
    //                                                                              ======
    // to suppress unexpected override by sub-class
    // you should remove the 'final' if you need to override this
    /**
     * Hook method called before action execution.
     * This method refreshes the user information if a user is logged in

    /**
     * Get the protected word item.
     * @param form The create form.
     * @param hook The error hook.
     * @return The protected word item.
     */
    protected OptionalEntity<ProtwordsItem> createProtwordsItem(final CreateForm form, final VaErrorHook hook) {
        try {
            return createProtwordsItem(this, form, hook);
        } catch (final ValidationErrorException e) {
            saveToken();

     * @param form The create form.
     * @param hook The error hook.
     * @return An optional entity of a stemmer override item.
     */
    protected OptionalEntity<StemmerOverrideItem> createStemmerOverrideItem(final CreateForm form, final VaErrorHook hook) {
        try {
            return createStemmerOverrideItem(this, form, hook);
        } catch (final ValidationErrorException e) {
            saveToken();