io.ebeanservice.docstore.api.DocQueryRequest Maven / Gradle / Ivy

Go to download
package io.ebeanservice.docstore.api;

import io.ebean.docstore.DocQueryContext;
import io.ebean.text.json.JsonReadOptions;
import io.ebeaninternal.api.SpiQuery;
import io.ebeaninternal.api.SpiTransaction;

/**
 * A Query request for the document store.
 */
public interface DocQueryRequest extends DocQueryContext {

  /**
   * Return the transaction for this request (can be null for document store only queries).
   */
  SpiTransaction transaction();

  /**
   * Set the (document store) transaction to use for this query.
   */
  void transaction(SpiTransaction transaction);

  /**
   * Return the query for this request.
   */
  SpiQuery query();

  /**
   * Create JsonReadOptions taking into account persistence context and lazy loading support.
   */
  JsonReadOptions createJsonReadOptions();

  /**
   * Execute secondary queries.
   */
  void executeSecondaryQueries(boolean forEach);

}