/*
 * Hibernate, Relational Persistence for Idiomatic Java
 *
 * License: GNU Lesser General Public License (LGPL), version 2.1 or later
 * See the lgpl.txt file in the root directory or http://www.gnu.org/licenses/lgpl-2.1.html
 */
package org.hibernate.cache.spi;

import java.io.Serializable;
import java.util.List;
import java.util.Set;

import org.hibernate.HibernateException;
import org.hibernate.cache.CacheException;
import org.hibernate.engine.spi.SharedSessionContractImplementor;
import org.hibernate.type.Type;

Defines the responsibility for managing query result data caching
in regards to a specific region.
Author:
Gavin King, Steve Ebersole/**
 * Defines the responsibility for managing query result data caching
 * in regards to a specific region.
 * 
 * @author Gavin King
 * @author Steve Ebersole
 */
public interface QueryResultsCache extends QueryCache {
	
The underlying cache region being used.
/**
	 * The underlying cache region being used.
	 */
	@Override
	QueryResultsRegion getRegion();

	
Clear items from the query cache.
Throws:
CacheException – Indicates a problem delegating to the underlying cache./**
	 * Clear items from the query cache.
	 *
	 * @throws CacheException Indicates a problem delegating to the underlying cache.
	 */
	@Override
	default void clear() throws CacheException {
		getRegion().clear();
	}

	
Put a result into the query cache.
Params:
key – The cache key
result – The results to cache
session – The originating session
Throws:
HibernateException – Indicates a problem delegating to the underlying cache.
Returns:
Whether the put actually happened./**
	 * Put a result into the query cache.
	 *
	 * @param key The cache key
	 * @param result The results to cache
	 * @param session The originating session
	 *
	 * @return Whether the put actually happened.
	 *
	 * @throws HibernateException Indicates a problem delegating to the underlying cache.
	 */
	boolean put(
			QueryKey key,
			List result,
			Type[] returnTypes,
			SharedSessionContractImplementor session) throws HibernateException;

	
Get results from the cache.
Params:
key – The cache key
spaces – The query spaces (used in invalidation plus validation checks)
session – The originating session
Throws:
HibernateException – Indicates a problem delegating to the underlying cache.
Returns:
The cached results; may be null./**
	 * Get results from the cache.
	 *
	 * @param key The cache key
	 * @param spaces The query spaces (used in invalidation plus validation checks)
	 * @param session The originating session
	 *
	 * @return The cached results; may be null.
	 *
	 * @throws HibernateException Indicates a problem delegating to the underlying cache.
	 */
	List get(
			QueryKey key,
			Set<Serializable> spaces,
			Type[] returnTypes,
			SharedSessionContractImplementor session) throws HibernateException;

	
Get results from the cache.
Params:
key – The cache key
spaces – The query spaces (used in invalidation plus validation checks)
session – The originating session
Throws:
HibernateException – Indicates a problem delegating to the underlying cache.
Returns:
The cached results; may be null./**
	 * Get results from the cache.
	 *
	 * @param key The cache key
	 * @param spaces The query spaces (used in invalidation plus validation checks)
	 * @param session The originating session
	 *
	 * @return The cached results; may be null.
	 *
	 * @throws HibernateException Indicates a problem delegating to the underlying cache.
	 */
	List get(
			QueryKey key,
			String[] spaces,
			Type[] returnTypes,
			SharedSessionContractImplementor session) throws HibernateException;


	// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	// Deprecations

	@Override
	default boolean put(
			QueryKey key,
			Type[] returnTypes,
			List result,
			boolean isNaturalKeyLookup,
			SharedSessionContractImplementor session) {
		return put( key, result, returnTypes, session );
	}

	@Override
	default List get(
			QueryKey key,
			Type[] returnTypes,
			boolean isNaturalKeyLookup,
			Set<Serializable> spaces,
			SharedSessionContractImplementor session) {
		return get( key, spaces, returnTypes, session );
	}

	@Override
	default void destroy() {
		// nothing to do.. the region itself gets destroyed
	}
}