package io.ebeaninternal.server.core;

import io.ebean.QueryIterator;
import io.ebean.Version;
import io.ebean.event.BeanQueryRequest;
import io.ebeaninternal.api.SpiQuery;
import io.ebeaninternal.server.deploy.BeanDescriptor;
import io.ebeanservice.docstore.api.DocQueryRequest;

import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.function.Consumer;
import java.util.function.Predicate;

Defines the ORM query request api.
/**
 * Defines the ORM query request api.
 */
public interface SpiOrmQueryRequest<T> extends BeanQueryRequest<T>, DocQueryRequest<T> {

  
Return the query.
/**
   * Return the query.
   */
  @Override
  SpiQuery<T> getQuery();

  
Return the associated BeanDescriptor.
/**
   * Return the associated BeanDescriptor.
   */
  BeanDescriptor<T> getBeanDescriptor();

  
Prepare the query for execution.
/**
   * Prepare the query for execution.
   */
  void prepareQuery();

  
This will create a local (readOnly) transaction if no current transaction
exists.

A transaction may have been passed in explicitly or currently be active
in the thread local. If not, then a readOnly transaction is created to
execute this query.

/**
   * This will create a local (readOnly) transaction if no current transaction
   * exists.
   * <p>
   * A transaction may have been passed in explicitly or currently be active
   * in the thread local. If not, then a readOnly transaction is created to
   * execute this query.
   * </p>
   */
  void initTransIfRequired();

  
Will end a locally created transaction.

It ends the transaction by using a rollback() as the transaction is known
to be readOnly.

/**
   * Will end a locally created transaction.
   * <p>
   * It ends the transaction by using a rollback() as the transaction is known
   * to be readOnly.
   * </p>
   */
  void endTransIfRequired();

  
Execute the query as a delete.
/**
   * Execute the query as a delete.
   */
  int delete();

  
Execute the query as a update.
/**
   * Execute the query as a update.
   */
  int update();

  
Execute the query as findById.
/**
   * Execute the query as findById.
   */
  Object findId();

  
Execute the find row count query.
/**
   * Execute the find row count query.
   */
  int findCount();

  
Execute the find ids query.
/**
   * Execute the find ids query.
   */
  <A> List<A> findIds();

  
Execute the find returning a QueryIterator and visitor pattern.
/**
   * Execute the find returning a QueryIterator and visitor pattern.
   */
  void findEach(Consumer<T> consumer);

  
Execute the find returning a QueryIterator and visitor pattern.
/**
   * Execute the find returning a QueryIterator and visitor pattern.
   */
  void findEachWhile(Predicate<T> consumer);

  
Execute the find returning a QueryIterator.
/**
   * Execute the find returning a QueryIterator.
   */
  QueryIterator<T> findIterate();

  
Execute the finVersions() query.
/**
   * Execute the finVersions() query.
   */
  List<Version<T>> findVersions();

  
Execute the query as findList.
/**
   * Execute the query as findList.
   */
  List<T> findList();

  
Execute the query as findSet.
/**
   * Execute the query as findSet.
   */
  Set<T> findSet();

  
Execute the query as findMap.
/**
   * Execute the query as findMap.
   */
  <K> Map<K, T> findMap();

  
Execute the findSingleAttributeList query.
/**
   * Execute the findSingleAttributeList query.
   */
  <A> List<A> findSingleAttributeList();

  
Execute returning the ResultSet.
/**
   * Execute returning the ResultSet.
   */
  SpiResultSet findResultSet();

  
Try to get the query result from the query cache.
/**
   * Try to get the query result from the query cache.
   */
  <A> A getFromQueryCache();

  
Maybe hit the bean cache returning true if everything was obtained from the
cache (that there were no misses).
Do this for findList() on many natural keys or many Ids.
/**
   * Maybe hit the bean cache returning true if everything was obtained from the
   * cache (that there were no misses).
   *
   * Do this for findList() on many natural keys or many Ids.
   */
  boolean getFromBeanCache();

  
Return the bean cache hits (when all hits / no misses).
/**
   * Return the bean cache hits (when all hits / no misses).
   */
  List<T> getBeanCacheHits();

  
Return the bean cache hits for findMap (when all hits / no misses).
/**
   * Return the bean cache hits for findMap (when all hits / no misses).
   */
  <K> Map<K,T> getBeanCacheHitsAsMap();

  
Reset Bean cache mode AUTO - require explicit setting for bean cache use with findList().
/**
   * Reset Bean cache mode AUTO - require explicit setting for bean cache use with findList().
   */
  void resetBeanCacheAutoMode(boolean findOne);

  
Return the Database platform like clause.
/**
   * Return the Database platform like clause.
   */
  String getDBLikeClause(boolean rawLikeExpression);

  
Escapes a string to use it as exact match in Like clause.
/**
   * Escapes a string to use it as exact match in Like clause.
   */
  String escapeLikeString(String value);

  
Mark the underlying transaction as not being query only.
/**
   * Mark the underlying transaction as not being query only.
   */
  void markNotQueryOnly();

  
Return true if this query is expected to use the doc store.
/**
   * Return true if this query is expected to use the doc store.
   */
  boolean isUseDocStore();

  
Return true if delete by statement is allowed for this type given cascade rules etc.
/**
   * Return true if delete by statement is allowed for this type given cascade rules etc.
   */
  boolean isDeleteByStatement();

}