com.marklogic.xcc.AdhocQuery Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of xmlcalabash-extension-stubs Show documentation

This artifact defines API stubs for compiling extension classes.

The newest version!

package com.marklogic.xcc;

/**
 * A specialization of {@link Request} which contains an ad-hoc query (XQuery
 * code as a literal String) to be submitted and evaluated by the MarkLogic
 * Server.
 *
 * @see 
 * Interface AdhocQuery
 */
public interface AdhocQuery extends Request {

    /**
     * Replace the XQuery code to be submitted and evaluated with this
     * {@link Request}.
     *
     * @param query 
     */
    void setQuery(String query);

    /**
     * Returns the currently set ad-hoc XQuery string.
     *
     * @return A {@link String} which is the ad-hoc query to run when this
     * {@link Request} is next passed to {@link Session#submitRequest(Request)}.
     */
    String getQuery();

}