IMultiQuery.cs

using System;
using System.Collections;
using NHibernate.Transform;
using NHibernate.Type;

namespace NHibernate
{
	/// <summary>
	/// Combines several queries into a single database call
	/// </summary>
	// Since v5.2
	[Obsolete("Use Multi.IQueryBatch instead, obtainable with ISession.CreateQueryBatch.")]
	public partial interface IMultiQuery
	{
		/// <summary>
		/// Get all the results
		/// </summary>
		/// <remarks>
		/// The result is a IList of IList.
		/// </remarks>
		IList List();

		/// <summary>
		/// Adds the specified query to the query. The result will be contained in a <see cref="System.Collections.Generic.List{T}"/>
		/// </summary>
		/// <param name="resultGenericListType">Return results in a <see cref="System.Collections.Generic.List{resultGenericListType}"/></param>
		/// <param name="query">The query.</param>
		/// <returns>The instance for method chain.</returns>
		IMultiQuery Add(System.Type resultGenericListType, IQuery query);

		/// <summary>
		/// Add the specified HQL query to the multi query. The result will be contained in a <see cref="System.Collections.Generic.List{T}"/>
		/// </summary>
		/// <param name="query">The query</param>
		IMultiQuery Add<T>(IQuery query);

		/// <summary>
		/// Add the specified HQL query to the multi query, and associate it with the given key. The result will be contained in a <see cref="System.Collections.Generic.List{T}"/>
		/// </summary>
		/// <param name="key">The key to get results of the specific query.</param>
		/// <param name="query">The query</param>
		/// <returns>The instance for method chain.</returns>
		/// <seealso cref="GetResult(string)"/>
		IMultiQuery Add<T>(string key, IQuery query);

		/// <summary>
		/// Add the specified HQL Query to the multi query, and associate it with the given key. The result will be contained in a <see cref="System.Collections.Generic.List{T}"/>
		/// </summary>
		/// <param name="key">The key to get results of the specific query.</param>
		/// <param name="hql">The query</param>
		/// <returns>The instance for method chain.</returns>
		/// <seealso cref="GetResult(string)"/>
		IMultiQuery Add<T>(string key, string hql);

		/// <summary>
		/// Add the specified HQL query to the multi query. The result will be contained in a <see cref="System.Collections.Generic.List{T}"/>
		/// </summary>
		/// <param name="hql">The query</param>
		/// <returns>The instance for method chain.</returns>
		IMultiQuery Add<T>(string hql);

		/// <summary>
		/// Add a named query to the multi query. The result will be contained in a <see cref="System.Collections.Generic.List{T}"/>
		/// </summary>
		/// <param name="queryName">The query</param>
		/// <returns>The instance for method chain.</returns>
		IMultiQuery AddNamedQuery<T>(string queryName);

		/// <summary>
		/// Add a named query to the multi query, and associate it with the given key. The result will be contained in a <see cref="System.Collections.Generic.List{T}"/>
		/// </summary>
		/// <param name="key">The key to get results of the specific query.</param>
		/// <param name="queryName">The query</param>
		/// <returns>The instance for method chain.</returns>
		/// <seealso cref="GetResult(string)"/>
		IMultiQuery AddNamedQuery<T>(string key, string queryName);

		/// <summary>
		/// Add the specified HQL query to the multi query, and associate it with the given key
		/// </summary>
		/// <param name="key">The key to get results of the specific query.</param>
		/// <param name="query">The query</param>
		/// <returns>The instance for method chain.</returns>
		/// <seealso cref="GetResult(string)"/>
		IMultiQuery Add(string key, IQuery query);

		/// <summary>
		/// Add the specified HQL query to the multi query
		/// </summary>
		/// <param name="query">The query</param>
		/// <returns>The instance for method chain.</returns>
		IMultiQuery Add(IQuery query);

		/// <summary>
		/// Add the specified HQL Query to the multi query, and associate it with the given key
		/// </summary>
		/// <param name="key">The key to get results of the specific query.</param>
		/// <param name="hql">The query</param>
		/// <returns>The instance for method chain.</returns>
		/// <seealso cref="GetResult(string)"/>
		IMultiQuery Add(string key, string hql);

		/// <summary>
		/// Add the specified HQL query to the multi query
		/// </summary>
		/// <returns>The instance for method chain.</returns>
		IMultiQuery Add(string hql);

		/// <summary>
		/// Add a named query to the multi query
		/// </summary>
		/// <param name="queryName">The query</param>
		/// <returns>The instance for method chain.</returns>
		IMultiQuery AddNamedQuery(string queryName);

		/// <summary>
		/// Add a named query to the multi query, and associate it with the given key
		/// </summary>
		/// <param name="key">The key to get results of the specific query.</param>
		/// <param name="queryName">The query</param>
		/// <returns>The instance for method chain.</returns>
		/// <seealso cref="GetResult(string)"/>
		IMultiQuery AddNamedQuery(string key, string queryName);

		/// <summary>
		/// Enable caching of this query result set.
		/// </summary>
		/// <param name="cacheable">Should the query results be cacheable?</param>
		/// <returns>The instance for method chain.</returns>
		IMultiQuery SetCacheable(bool cacheable);

		/// Set the name of the cache region.
		/// <param name="region">The name of a query cache region, or <see langword="null" />
		/// for the default query cache</param>
		/// <returns>The instance for method chain.</returns>
		IMultiQuery SetCacheRegion(string region);

		/// Should the query force a refresh of the specified query cache region?
		/// This is particularly useful in cases where underlying data may have been
		/// updated via a separate process (i.e., not modified through Hibernate) and
		/// allows the application to selectively refresh the query cache regions
		/// based on its knowledge of those events.
		/// <param name="forceCacheRefresh">Should the query result in a forcible refresh of
		/// the query cache?</param>
		/// <returns>The instance for method chain.</returns>
		IMultiQuery SetForceCacheRefresh(bool forceCacheRefresh);

		/// <summary>
		/// Set a timeout for the underlying ADO.NET query.
		/// </summary>
		/// <param name="timeout">The timeout in seconds.</param>
		/// <returns>The instance for method chain.</returns>
		IMultiQuery SetTimeout(int timeout);

		/// <summary>
		/// Bind a value to a named query parameter
		/// </summary>
		/// <param name="name">The name of the parameter</param>
		/// <param name="val">The possibly null parameter value</param>
		/// <param name="type">The NHibernate <see cref="IType"/>.</param>
		/// <returns>The instance for method chain.</returns>
		IMultiQuery SetParameter(string name, object val, IType type);

		/// <summary>
		/// Bind a value to a named query parameter, guessing the NHibernate <see cref="IType"/>
		/// from the class of the given object.
		/// </summary>
		/// <param name="name">The name of the parameter</param>
		/// <param name="val">The non-null parameter value</param>
		/// <returns>The instance for method chain.</returns>
		IMultiQuery SetParameter(string name, object val);

		/// <summary>
		/// Bind multiple values to a named query parameter. This is useful for binding a list
		/// of values to an expression such as <c>foo.bar in (:value_list)</c>
		/// </summary>
		/// <param name="name">The name of the parameter</param>
		/// <param name="vals">A collection of values to list</param>
		/// <param name="type">The Hibernate type of the values</param>
		/// <returns>The instance for method chain.</returns>
		IMultiQuery SetParameterList(string name, IEnumerable vals, IType type);

		/// <summary>
		/// Bind multiple values to a named query parameter, guessing the Hibernate
		/// type from the class of the first object in the collection. This is useful for binding a list
		/// of values to an expression such as <c>foo.bar in (:value_list)</c>
		/// </summary>
		/// <param name="name">The name of the parameter</param>
		/// <param name="vals">A collection of values to list</param>
		/// <returns>The instance for method chain.</returns>
		IMultiQuery SetParameterList(string name, IEnumerable vals);

		/// <summary>
		/// Bind an instance of a <see cref="string" /> to a named parameter
		/// using an NHibernate <see cref="AnsiStringType"/>.
		/// </summary>
		/// <param name="name">The name of the parameter</param>
		/// <param name="val">A non-null instance of a <see cref="string"/>.</param>
		/// <returns>The instance for method chain.</returns>
		IMultiQuery SetAnsiString(string name, string val);

		/// <summary>
		/// Bind an instance of a <see cref="byte" /> array to a named parameter
		/// using an NHibernate <see cref="BinaryType"/>.
		/// </summary>
		/// <param name="name">The name of the parameter</param>
		/// <param name="val">A non-null instance of a <see cref="byte"/> array.</param>
		/// <returns>The instance for method chain.</returns>
		IMultiQuery SetBinary(string name, byte[] val);

		/// <summary>
		/// Bind an instance of a <see cref="bool" /> to a named parameter
		/// using an NHibernate <see cref="BooleanType"/>.
		/// </summary>
		/// <param name="name">The name of the parameter</param>
		/// <param name="val">A non-null instance of a <see cref="bool"/>.</param>
		/// <returns>The instance for method chain.</returns>
		IMultiQuery SetBoolean(string name, bool val);

		/// <summary>
		/// Bind an instance of a <see cref="byte" /> to a named parameter
		/// using an NHibernate <see cref="ByteType"/>.
		/// </summary>
		/// <param name="name">The name of the parameter</param>
		/// <param name="val">A non-null instance of a <see cref="byte"/>.</param>
		/// <returns>The instance for method chain.</returns>
		IMultiQuery SetByte(string name, byte val);

		/// <summary>
		/// Bind an instance of a <see cref="char" /> to a named parameter
		/// using an NHibernate <see cref="CharType"/>.
		/// </summary>
		/// <param name="name">The name of the parameter</param>
		/// <param name="val">A non-null instance of a <see cref="char"/>.</param>
		/// <returns>The instance for method chain.</returns>
		IMultiQuery SetCharacter(string name, char val);

		/// <summary>
		/// Bind an instance of a <see cref="DateTime" /> to a named parameter
		/// using an NHibernate <see cref="DateTimeType"/>.
		/// </summary>
		/// <param name="val">A non-null instance of a <see cref="DateTime"/>.</param>
		/// <param name="name">The name of the parameter</param>
		/// <returns>The instance for method chain.</returns>
		/// <remarks>Since v5.0, does no more cut fractional seconds. Use <see cref="SetDateTimeNoMs" />
		/// for this</remarks>
		IMultiQuery SetDateTime(string name, DateTime val);

		/// <summary>
		/// Bind an instance of a <see cref="DateTime" /> to a named parameter
		/// using an NHibernate <see cref="DateTimeNoMsType"/>.
		/// </summary>
		/// <param name="val">A non-null instance of a <see cref="DateTime"/>.</param>
		/// <param name="name">The name of the parameter</param>
		/// <returns>The instance for method chain.</returns>
		IMultiQuery SetDateTimeNoMs(string name, DateTime val);

		// Since v5.0
		[Obsolete("Use SetDateTime instead, it uses DateTime2 with dialects supporting it.")]
		IMultiQuery SetDateTime2(string name, DateTime val);
		IMultiQuery SetTimeSpan(string name, TimeSpan val);
		IMultiQuery SetTimeAsTimeSpan(string name, TimeSpan val);
		IMultiQuery SetDateTimeOffset(string name, DateTimeOffset val);

		/// <summary>
		/// Bind an instance of a <see cref="Decimal" /> to a named parameter
		/// using an NHibernate <see cref="DecimalType"/>.
		/// </summary>
		/// <param name="name">The name of the parameter</param>
		/// <param name="val">A non-null instance of a <see cref="Decimal"/>.</param>
		/// <returns>The instance for method chain.</returns>
		IMultiQuery SetDecimal(string name, decimal val);

		/// <summary>
		/// Bind an instance of a <see cref="Double" /> to a named parameter
		/// using an NHibernate <see cref="DoubleType"/>.
		/// </summary>
		/// <param name="name">The name of the parameter</param>
		/// <param name="val">A non-null instance of a <see cref="Double"/>.</param>
		/// <returns>The instance for method chain.</returns>
		IMultiQuery SetDouble(string name, double val);

		/// <summary>
		/// Bind an instance of a mapped persistent class to a named parameter.
		/// </summary>
		/// <param name="name">The name of the parameter</param>
		/// <param name="val">A non-null instance of a persistent class</param>
		/// <returns>The instance for method chain.</returns>
		IMultiQuery SetEntity(string name, object val);

		/// <summary>
		/// Bind an instance of a persistent enumeration class to a named parameter
		/// using an NHibernate <see cref="PersistentEnumType"/>.
		/// </summary>
		/// <param name="name">The name of the parameter</param>
		/// <param name="val">A non-null instance of a persistent enumeration</param>
		/// <returns>The instance for method chain.</returns>
		IMultiQuery SetEnum(string name, Enum val);

		/// <summary>
		/// Bind an instance of a <see cref="Int16" /> to a named parameter
		/// using an NHibernate <see cref="Int16Type"/>.
		/// </summary>
		/// <param name="name">The name of the parameter</param>
		/// <param name="val">A non-null instance of a <see cref="Int16"/>.</param>
		/// <returns>The instance for method chain.</returns>
		IMultiQuery SetInt16(string name, short val);

		/// <summary>
		/// Bind an instance of a <see cref="Int32" /> to a named parameter
		/// using an NHibernate <see cref="Int32Type"/>.
		/// </summary>
		/// <param name="name">The name of the parameter</param>
		/// <param name="val">A non-null instance of a <see cref="Int32"/>.</param>
		/// <returns>The instance for method chain.</returns>
		IMultiQuery SetInt32(string name, int val);

		/// <summary>
		/// Bind an instance of a <see cref="Int64" /> to a named parameter
		/// using an NHibernate <see cref="Int64Type"/>.
		/// </summary>
		/// <param name="name">The name of the parameter</param>
		/// <param name="val">A non-null instance of a <see cref="Int64"/>.</param>
		/// <returns>The instance for method chain.</returns>
		IMultiQuery SetInt64(string name, long val);

		/// <summary>
		/// Bind an instance of a <see cref="Single" /> to a named parameter
		/// using an NHibernate <see cref="SingleType"/>.
		/// </summary>
		/// <param name="name">The name of the parameter</param>
		/// <param name="val">A non-null instance of a <see cref="Single"/>.</param>
		/// <returns>The instance for method chain.</returns>
		IMultiQuery SetSingle(string name, float val);

		/// <summary>
		/// Bind an instance of a <see cref="String" /> to a named parameter
		/// using an NHibernate <see cref="StringType"/>.
		/// </summary>
		/// <param name="name">The name of the parameter</param>
		/// <param name="val">A non-null instance of a <see cref="String"/>.</param>
		/// <returns>The instance for method chain.</returns>
		IMultiQuery SetString(string name, string val);

		/// <summary>
		/// Bind an instance of a <see cref="Guid" /> to a named parameter
		/// using an NHibernate <see cref="GuidType"/>.
		/// </summary>
		/// <param name="name">The name of the parameter</param>
		/// <param name="val">An instance of a <see cref="Guid"/>.</param>
		/// <returns>The instance for method chain.</returns>
		IMultiQuery SetGuid(string name, Guid val);

		/// <summary>
		/// Bind an instance of a <see cref="DateTime" /> to a named parameter
		/// using an NHibernate <see cref="DateTimeType"/>.
		/// </summary>
		/// <param name="name">The name of the parameter</param>
		/// <param name="val">A non-null instance of a <see cref="DateTime"/>.</param>
		/// <returns>The instance for method chain.</returns>
		IMultiQuery SetTime(string name, DateTime val);

		// Obsolete since v5.0
		/// <summary>
		/// Bind an instance of a <see cref="DateTime" /> to a named parameter
		/// using an NHibernate <see cref="TimestampType"/>.
		/// </summary>
		/// <param name="name">The name of the parameter</param>
		/// <param name="val">A non-null instance of a <see cref="DateTime"/>.</param>
		/// <returns>The instance for method chain.</returns>
		[Obsolete("Use SetDateTime instead.")]
		IMultiQuery SetTimestamp(string name, DateTime val);

		/// <summary>
		/// Override the current session flush mode, just for this query.
		/// </summary>
		/// <returns>The instance for method chain.</returns>
		IMultiQuery SetFlushMode(FlushMode mode);

		/// <summary>
		/// Set a strategy for handling the query results. This can be used to change
		/// "shape" of the query result.
		/// </summary>
		/// <remarks>
		/// The <param name="transformer"/> will be applied after the transformer of each single query.
		/// </remarks>
		/// <returns>The instance for method chain.</returns>
		IMultiQuery SetResultTransformer(IResultTransformer transformer);

		/// <summary>
		/// Returns the result of one of the query based on the key
		/// </summary>
		/// <param name="key">The key</param>
		/// <returns>The instance for method chain.</returns>
		object GetResult(string key);
	}
}