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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ebean Show documentation

composite of common runtime dependencies for all platforms

There is a newer version: 15.8.1

package io.ebeanservice.docstore.api;

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 {

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

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

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

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

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

}