com.marklogic.client.query.SearchQueryDefinition Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of marklogic-client-api Show documentation

The official MarkLogic Java client API.

The newest version!

/*
 * Copyright © 2024 MarkLogic Corporation. All Rights Reserved.
 */
package com.marklogic.client.query;

import com.marklogic.client.document.ServerTransform;

/**
 * A SearchQueryDefinition represents the common parts of all kinds of searches that can be performed.
 */
public interface SearchQueryDefinition {
    /**
     * Returns the name of the query options used for this query.
     * @return The options name.
     */
    String getOptionsName();

    /**
     * Sets the name of the query options to be used for this query.
     *
     * If no query options node with the specified name exists, the search will fail.
     *
     * @param name The name of the saved query options node on the server.
     */
    void setOptionsName(String name);

    /**
     * Returns the transform that modifies responses to this query
     * on the server.
     * @return The transform.
     */
    ServerTransform getResponseTransform();

    /**
     * Specifies a transform that modifies responses to this query
     * on the server.
     * @param transform	A server transform to modify the query response.
     */
    void setResponseTransform(ServerTransform transform);
}