|
From: Mark P. <mar...@us...> - 2007-09-19 22:58:14
|
Update of /cvsroot/springnet/Spring.Net/src/Spring/Spring.Data.NHibernate12/Data/NHibernate/Generic In directory sc8-pr-cvs8.sourceforge.net:/tmp/cvs-serv12270/Generic Modified Files: FindHibernateDelegate.cs HibernateDaoSupport.cs HibernateDelegate.cs HibernateTemplate.cs IFindHibernateCallback.cs IHibernateCallback.cs IHibernateOperations.cs Log Message: SPRNET-729 - Improve API documentation in NHibernate12 project using comment-checker program SPRNET-728 - Add missing ExecuteFind<T> method on IHibernateOperations interface Index: IHibernateCallback.cs =================================================================== RCS file: /cvsroot/springnet/Spring.Net/src/Spring/Spring.Data.NHibernate12/Data/NHibernate/Generic/IHibernateCallback.cs,v retrieving revision 1.1 retrieving revision 1.2 diff -C2 -d -r1.1 -r1.2 *** IHibernateCallback.cs 1 Jun 2007 02:34:12 -0000 1.1 --- IHibernateCallback.cs 19 Sep 2007 22:58:10 -0000 1.2 *************** *** 30,33 **** --- 30,34 ---- /// Callback interface (Generic version) for NHibernate code. /// </summary> + /// <typeparam name="T">The type of result object</typeparam> /// <remarks>To be used with HibernateTemplate execute /// method. The typical implementation will call *************** *** 52,55 **** --- 53,58 ---- /// </p> /// </remarks> + /// <returns>A result object.</returns> + /// <param name="session">The active Hibernate session</param> T DoInHibernate(ISession session); } Index: IFindHibernateCallback.cs =================================================================== RCS file: /cvsroot/springnet/Spring.Net/src/Spring/Spring.Data.NHibernate12/Data/NHibernate/Generic/IFindHibernateCallback.cs,v retrieving revision 1.1 retrieving revision 1.2 diff -C2 -d -r1.1 -r1.2 *** IFindHibernateCallback.cs 1 Jun 2007 02:34:12 -0000 1.1 --- IFindHibernateCallback.cs 19 Sep 2007 22:58:10 -0000 1.2 *************** *** 28,31 **** --- 28,32 ---- /// returns a List of objects. /// </summary> + /// <typeparam name="T">The type of result object</typeparam> /// <remarks>To be used with HibernateTemplate execute /// method. The typical implementation will call *************** *** 50,53 **** --- 51,55 ---- /// </p> /// </remarks> + /// <returns>Collection result object.</returns> IList<T> DoInHibernate(ISession session); } Index: IHibernateOperations.cs =================================================================== RCS file: /cvsroot/springnet/Spring.Net/src/Spring/Spring.Data.NHibernate12/Data/NHibernate/Generic/IHibernateOperations.cs,v retrieving revision 1.1 retrieving revision 1.2 diff -C2 -d -r1.1 -r1.2 *** IHibernateOperations.cs 1 Jun 2007 02:34:12 -0000 1.1 --- IHibernateOperations.cs 19 Sep 2007 22:58:10 -0000 1.2 *************** *** 19,25 **** --- 19,27 ---- #endregion + using System; using System.Collections.Generic; using NHibernate; using NHibernate.Type; + using Spring.Dao; namespace Spring.Data.NHibernate.Generic *************** *** 36,39 **** --- 38,42 ---- /// </p> /// </remarks> + /// <threadsafety statis="true" instance="true"/> /// <author>Sree Nivask (.NET)</author> /// <author>Mark Pollack (.NET)</author> *************** *** 44,53 **** /// <summary> /// Return the persistent instance of the given entity type ! /// with the given identifier, or null if not found. /// Obtains the specified lock mode if the instance exists. /// </summary> /// <param name="id">The id of the object to get.</param> ! /// <returns>the persistent instance, or null if not found</returns> ! /// T Get<T>(object id); --- 47,57 ---- /// <summary> /// Return the persistent instance of the given entity type ! /// with the given identifier, or <see langword="null" /> if not found. /// Obtains the specified lock mode if the instance exists. /// </summary> + /// <typeparam name="T">The object type to get.</typeparam> /// <param name="id">The id of the object to get.</param> ! /// <returns>the persistent instance, or <see langword="null" /> if not found</returns> ! /// <exception cref="DataAccessException">In case of Hibernate errors</exception> T Get<T>(object id); *************** *** 57,63 **** --- 61,69 ---- /// Obtains the specified lock mode if the instance exists. /// </summary> + /// <typeparam name="T">The object type to get.</typeparam> /// <param name="id">The lock mode to obtain.</param> /// <param name="lockMode">The lock mode.</param> /// <returns>the persistent instance, or null if not found</returns> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> T Get<T>(object id, LockMode lockMode); *************** *** 66,71 **** --- 72,80 ---- /// with the given identifier, throwing an exception if not found. /// </summary> + /// <typeparam name="T">The object type to load.</typeparam> /// <param name="id">An identifier of the persistent instance.</param> /// <returns>The persistent instance</returns> + /// <exception cref="ObjectRetrievalFailureException">If not found</exception> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> T Load<T>(object id); *************** *** 75,81 **** --- 84,93 ---- /// Obtains the specified lock mode if the instance exists. /// </summary> + /// <typeparam name="T">The object type to load.</typeparam> /// <param name="id">An identifier of the persistent instance.</param> /// <param name="lockMode">The lock mode.</param> /// <returns>The persistent instance</returns> + /// <exception cref="ObjectRetrievalFailureException">If not found</exception> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> T Load<T>(object id, LockMode lockMode); *************** *** 84,88 **** --- 96,102 ---- /// Note: Use queries or criteria for retrieving a specific subset. /// </summary> + /// <typeparam name="T">The object type to load.</typeparam> /// <returns>A generic List containing 0 or more persistent instances</returns> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> IList<T> LoadAll<T>(); *************** *** 90,97 **** --- 104,113 ---- /// Execute a query for persistent instances. /// </summary> + /// <typeparam name="T">The object type to find.</typeparam> /// <param name="queryString">a query expressed in Hibernate's query language</param> /// <returns> /// a generic List containing 0 or more persistent instances /// </returns> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> IList<T> Find<T>(string queryString); *************** *** 100,103 **** --- 116,120 ---- /// one value to a "?" parameter in the query string. /// </summary> + /// <typeparam name="T">The object type to find.</typeparam> /// <param name="queryString">a query expressed in Hibernate's query language</param> /// <param name="value">the value of the parameter</param> *************** *** 105,108 **** --- 122,126 ---- /// a generic List containing 0 or more persistent instances /// </returns> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> IList<T> Find<T>(string queryString, object value); *************** *** 111,114 **** --- 129,133 ---- /// to a "?" parameter of the given type in the query string. /// </summary> + /// <typeparam name="T">The object type to find.</typeparam> /// <param name="queryString">a query expressed in Hibernate's query language</param> /// <param name="value">The value of the parameter.</param> *************** *** 117,120 **** --- 136,140 ---- /// a generic List containing 0 or more persistent instances /// </returns> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> IList<T> Find<T>(string queryString, object value, IType type); *************** *** 123,129 **** --- 143,151 ---- /// number of values to "?" parameters in the query string. /// </summary> + /// <typeparam name="T">The object type to find.</typeparam> /// <param name="queryString">a query expressed in Hibernate's query language</param> /// <param name="values">the values of the parameters</param> /// <returns>a generic List containing 0 or more persistent instances</returns> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> IList<T> Find<T>(string queryString, object[] values); *************** *** 132,135 **** --- 154,158 ---- /// values to "?" parameters of the given types in the query string. /// </summary> + /// <typeparam name="T">The object type to find.</typeparam> /// <param name="queryString">A query expressed in Hibernate's query language</param> /// <param name="values">The values of the parameters</param> *************** *** 138,141 **** --- 161,166 ---- /// a generic List containing 0 or more persistent instances /// </returns> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> + /// <exception cref="ArgumentException">If values and types are not null and their lenths are not equal</exception> IList<T> Find<T>(string queryString, object[] values, IType[] types); *************** *** 144,151 **** --- 169,178 ---- /// one value to a named parameter in the query string. /// </summary> + /// <typeparam name="T">The object type to find.</typeparam> /// <param name="queryName">The name of a Hibernate query in a mapping file</param> /// <param name="paramName">The name of the parameter</param> /// <param name="value">The value of the parameter</param> /// <returns>a generic List containing 0 or more persistent instances</returns> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> IList<T> FindByNamedParam<T>(string queryName, string paramName, object value); *************** *** 154,157 **** --- 181,185 ---- /// one value to a named parameter in the query string. /// </summary> + /// <typeparam name="T">The object type to find.</typeparam> /// <param name="queryName">The name of a Hibernate query in a mapping file</param> /// <param name="paramName">The name of the parameter</param> *************** *** 159,162 **** --- 187,191 ---- /// <param name="type">Hibernate type of the parameter (or null)</param> /// <returns>A generic List containing 0 or more persistent instances</returns> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> IList<T> FindByNamedParam<T>(string queryName, string paramName, object value, IType type); *************** *** 165,172 **** --- 194,203 ---- /// number of values to named parameters in the query string. /// </summary> + /// <typeparam name="T">The object type to find.</typeparam> /// <param name="queryString">A query expressed in Hibernate's query language</param> /// <param name="paramNames">The names of the parameters</param> /// <param name="values">The values of the parameters</param> /// <returns>A generic List containing 0 or more persistent instances</returns> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> IList<T> FindByNamedParam<T>(string queryString, string[] paramNames, object[] values); *************** *** 175,178 **** --- 206,210 ---- /// number of values to named parameters in the query string. /// </summary> + /// <typeparam name="T">The object type to find.</typeparam> /// <param name="queryString">A query expressed in Hibernate's query language</param> /// <param name="paramNames">The names of the parameters</param> *************** *** 180,183 **** --- 212,218 ---- /// <param name="types">Hibernate types of the parameters (or null)</param> /// <returns>A generic List containing 0 or more persistent instances</returns> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> + /// <exception cref="ArgumentOutOfRangeException">If paramNames length is not equal to values length or + /// if paramNames length is not equal to types length (when types is not null)</exception> IList<T> FindByNamedParam<T>(string queryString, string[] paramNames, object[] values, IType[] types); *************** *** 186,191 **** --- 221,228 ---- /// A named query is defined in a Hibernate mapping file. /// </summary> + /// <typeparam name="T">The object type to find.</typeparam> /// <param name="queryName">The name of a Hibernate query in a mapping file</param> /// <returns>A generic List containing 0 or more persistent instances</returns> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> IList<T> FindByNamedQuery<T>(string queryName); *************** *** 195,201 **** --- 232,240 ---- /// A named query is defined in a Hibernate mapping file. /// </summary> + /// <typeparam name="T">The object type to find.</typeparam> /// <param name="queryName">The name of a Hibernate query in a mapping file</param> /// <param name="value">The value of the parameter</param> /// <returns>A generic List containing 0 or more persistent instances</returns> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> IList<T> FindByNamedQuery<T>(string queryName, object value); *************** *** 205,212 **** --- 244,253 ---- /// A named query is defined in a Hibernate mapping file. /// </summary> + /// <typeparam name="T">The object type to find.</typeparam> /// <param name="queryName">The name of a Hibernate query in a mapping file</param> /// <param name="value">The value of the parameter</param> /// <param name="type">Hibernate type of the parameter (or null)</param> /// <returns>A generic List containing 0 or more persistent instances</returns> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> IList<T> FindByNamedQuery<T>(string queryName, object value, IType type); *************** *** 216,222 **** --- 257,265 ---- /// A named query is defined in a Hibernate mapping file. /// </summary> + /// <typeparam name="T">The object type to find.</typeparam> /// <param name="queryName">The name of a Hibernate query in a mapping file</param> /// <param name="values">The values of the parameters</param> /// <returns>A generic List containing 0 or more persistent instances</returns> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> IList<T> FindByNamedQuery<T>(string queryName, object[] values); *************** *** 226,233 **** --- 269,279 ---- /// A named query is defined in a Hibernate mapping file. /// </summary> + /// <typeparam name="T">The object type to find.</typeparam> /// <param name="queryName">The name of a Hibernate query in a mapping file</param> /// <param name="values">The values of the parameters</param> /// <param name="types">Hibernate types of the parameters (or null)</param> /// <returns>A generic List containing 0 or more persistent instances</returns> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> + /// <exception cref="ArgumentOutOfRangeException">If values and types are not null and their lengths differ.</exception> IList<T> FindByNamedQuery<T>(string queryName, object[] values, IType[] types); *************** *** 237,244 **** --- 283,292 ---- /// A named query is defined in a Hibernate mapping file. /// </summary> + /// <typeparam name="T">The object type to find.</typeparam> /// <param name="queryName">The name of a Hibernate query in a mapping file</param> /// <param name="paramName">Name of the parameter</param> /// <param name="value">The value of the parameter</param> /// <returns>A generic List containing 0 or more persistent instances</returns> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> IList<T> FindByNamedQueryAndNamedParam<T>(string queryName, string paramName, object value); *************** *** 248,251 **** --- 296,300 ---- /// A named query is defined in a Hibernate mapping file. /// </summary> + /// <typeparam name="T">The object type to find.</typeparam> /// <param name="queryName">The name of a Hibernate query in a mapping file</param> /// <param name="paramName">Name of the parameter</param> *************** *** 253,256 **** --- 302,306 ---- /// <param name="type">The Hibernate type of the parameter (or null)</param> /// <returns>A generic List containing 0 or more persistent instances</returns> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> IList<T> FindByNamedQueryAndNamedParam<T>(string queryName, string paramName, object value, IType type); *************** *** 260,267 **** --- 310,319 ---- /// A named query is defined in a Hibernate mapping file. /// </summary> + /// <typeparam name="T">The object type to find.</typeparam> /// <param name="queryName">The name of a Hibernate query in a mapping file</param> /// <param name="paramNames">The names of the parameters</param> /// <param name="values">The values of the parameters.</param> /// <returns>A generic List containing 0 or more persistent instances</returns> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> IList<T> FindByNamedQueryAndNamedParam<T>(string queryName, string[] paramNames, object[] values); *************** *** 271,274 **** --- 323,327 ---- /// A named query is defined in a Hibernate mapping file. /// </summary> + /// <typeparam name="T">The object type to find.</typeparam> /// <param name="queryName">The name of a Hibernate query in a mapping file</param> /// <param name="paramNames">The names of the parameters</param> *************** *** 276,279 **** --- 329,335 ---- /// <param name="types">Hibernate types of the parameters (or null)</param> /// <returns>A generic List containing 0 or more persistent instances</returns> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> + /// <exception cref="ArgumentOutOfRangeException">If paramNames length is not equal to values length or + /// if paramNames length is not equal to types length (when types is not null)</exception> IList<T> FindByNamedQueryAndNamedParam<T>(string queryName, string[] paramNames, object[] values, IType[] types); *************** *** 283,289 **** --- 339,347 ---- /// A named query is defined in a Hibernate mapping file. /// </summary> + /// <typeparam name="T">The object type to find.</typeparam> /// <param name="queryName">The name of a Hibernate query in a mapping file</param> /// <param name="valueObject">The values of the parameters</param> /// <returns>A generic List containing 0 or more persistent instances</returns> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> IList<T> FindByNamedQueryAndValueObject<T>(string queryName, object valueObject); *************** *** 292,298 **** --- 350,358 ---- /// of the given object to <i>named</i> parameters in the query string. /// </summary> + /// <typeparam name="T">The object type to find.</typeparam> /// <param name="queryString">A query expressed in Hibernate's query language</param> /// <param name="valueObject">The values of the parameters</param> /// <returns>A generic List containing 0 or more persistent instances</returns> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> IList<T> FindByValueObject<T>(string queryString, object valueObject); *************** *** 310,316 **** --- 370,378 ---- /// </p> /// </remarks> + /// <typeparam name="T">The object type retrieved.</typeparam> /// <param name="del">The delegate callback object that specifies the Hibernate action.</param> /// <returns>a result object returned by the action, or null /// </returns> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> T Execute<T>(HibernateDelegate<T> del); *************** *** 318,321 **** --- 380,384 ---- /// Execute the action specified by the delegate within a Session. /// </summary> + /// <typeparam name="T">The object type retrieved.</typeparam> /// <param name="del">The HibernateDelegate that specifies the action /// to perform.</param> *************** *** 324,327 **** --- 387,391 ---- /// <returns>a result object returned by the action, or null /// </returns> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> T Execute<T>(HibernateDelegate<T> del, bool exposeNativeSession); *************** *** 329,332 **** --- 393,397 ---- /// Execute the action specified by the given action object within a Session. /// </summary> + /// <typeparam name="T">The object type retrieved.</typeparam> /// <param name="action">The callback object that specifies the Hibernate action.</param> /// <returns> *************** *** 343,346 **** --- 408,412 ---- /// </p> /// </remarks> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> T Execute<T>(IHibernateCallback<T> action); *************** *** 348,351 **** --- 414,418 ---- /// Execute the action specified by the given action object within a Session. /// </summary> + /// <typeparam name="T">The object type retrieved.</typeparam> /// <param name="action">callback object that specifies the Hibernate action.</param> /// <param name="exposeNativeSession">if set to <c>true</c> expose the native hibernate session to *************** *** 354,357 **** --- 421,425 ---- /// a result object returned by the action, or null /// </returns> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> T Execute<T>(IHibernateCallback<T> action, bool exposeNativeSession); *************** *** 369,375 **** --- 437,445 ---- /// </p> /// </remarks> + /// <typeparam name="T">The object type to find.</typeparam> /// <param name="del">The delegate callback object that specifies the Hibernate action.</param> /// <returns>A generic IList returned by the action, or null /// </returns> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> IList<T> ExecuteFind<T>(FindHibernateDelegate<T> del); *************** *** 377,380 **** --- 447,451 ---- /// Execute the action specified by the delegate within a Session. /// </summary> + /// <typeparam name="T">The object type to find.</typeparam> /// <param name="del">The FindHibernateDelegate that specifies the action /// to perform.</param> *************** *** 383,391 **** --- 454,484 ---- /// <returns>A generic IList returned by the action, or null /// </returns> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> IList<T> ExecuteFind<T>(FindHibernateDelegate<T> del, bool exposeNativeSession); /// <summary> + /// Execute the action specified by the given action object within a Session. + /// </summary> + /// <typeparam name="T">The object type to find.</typeparam> + /// <param name="action">The callback object that specifies the Hibernate action.</param> + /// <returns> + /// A generic IList returned by the action, or null + /// </returns> + /// <remarks> + /// Application exceptions thrown by the action object get propagated to the + /// caller (can only be unchecked). Hibernate exceptions are transformed into + /// appropriate DAO ones. Allows for returning the result object. + /// <p>Note: Callback code is not supposed to handle transactions itself! + /// Use an appropriate transaction manager like HibernateTransactionManager. + /// Generally, callback code must not touch any Session lifecycle methods, + /// like close, disconnect, or reconnect, to let the template do its work. + /// </p> + /// </remarks> + IList<T> ExecuteFind<T>(IFindHibernateCallback<T> action); + + /// <summary> /// Execute the action specified by the given action object within a Session assuming that an IList is returned. /// </summary> + /// <typeparam name="T">The object type to find.</typeparam> /// <param name="action">callback object that specifies the Hibernate action.</param> /// <param name="exposeNativeSession">if set to <c>true</c> expose the native hibernate session to *************** *** 394,397 **** --- 487,491 ---- /// an IList returned by the action, or null /// </returns> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> IList<T> ExecuteFind<T>(IFindHibernateCallback<T> action, bool exposeNativeSession); } Index: HibernateDaoSupport.cs =================================================================== RCS file: /cvsroot/springnet/Spring.Net/src/Spring/Spring.Data.NHibernate12/Data/NHibernate/Generic/HibernateDaoSupport.cs,v retrieving revision 1.2 retrieving revision 1.3 diff -C2 -d -r1.2 -r1.3 *** HibernateDaoSupport.cs 28 Aug 2007 15:26:29 -0000 1.2 --- HibernateDaoSupport.cs 19 Sep 2007 22:58:10 -0000 1.3 *************** *** 145,148 **** --- 145,149 ---- /// </p> /// </remarks> + /// <returns>The new HibernateTemplate instance</returns> protected virtual HibernateTemplate CreateHibernateTemplate(ISessionFactory sessionFactory) { *************** *** 153,156 **** --- 154,158 ---- /// Check if the hibernate template property has been set. /// </summary> + /// <exception cref="ArgumentException">If HibernateTemplate property is null.</exception> protected override void CheckDaoConfig() { Index: HibernateDelegate.cs =================================================================== RCS file: /cvsroot/springnet/Spring.Net/src/Spring/Spring.Data.NHibernate12/Data/NHibernate/Generic/HibernateDelegate.cs,v retrieving revision 1.1 retrieving revision 1.2 diff -C2 -d -r1.1 -r1.2 *** HibernateDelegate.cs 1 Jun 2007 02:34:12 -0000 1.1 --- HibernateDelegate.cs 19 Sep 2007 22:58:10 -0000 1.2 *************** *** 39,42 **** --- 39,43 ---- /// </p> /// </remarks> + /// <typeparam name="T">The type of result object</typeparam> /// <author>Sree Nivask (.NET)</author> /// <version>$Id$</version> Index: FindHibernateDelegate.cs =================================================================== RCS file: /cvsroot/springnet/Spring.Net/src/Spring/Spring.Data.NHibernate12/Data/NHibernate/Generic/FindHibernateDelegate.cs,v retrieving revision 1.1 retrieving revision 1.2 diff -C2 -d -r1.1 -r1.2 *** FindHibernateDelegate.cs 1 Jun 2007 02:34:12 -0000 1.1 --- FindHibernateDelegate.cs 19 Sep 2007 22:58:10 -0000 1.2 *************** *** 40,43 **** --- 40,44 ---- /// </p> /// </remarks> + /// <typeparam name="T">The type of result object</typeparam> /// <author>Sree Nivask (.NET)</author> /// <version>$Id$</version> Index: HibernateTemplate.cs =================================================================== RCS file: /cvsroot/springnet/Spring.Net/src/Spring/Spring.Data.NHibernate12/Data/NHibernate/Generic/HibernateTemplate.cs,v retrieving revision 1.1 retrieving revision 1.2 diff -C2 -d -r1.1 -r1.2 *** HibernateTemplate.cs 1 Jun 2007 02:34:12 -0000 1.1 --- HibernateTemplate.cs 19 Sep 2007 22:58:10 -0000 1.2 *************** *** 26,29 **** --- 26,30 ---- using NHibernate.Type; using Spring.Aop.Framework; + using Spring.Dao; using Spring.Data.Common; using Spring.Data.Support; *************** *** 221,224 **** --- 222,226 ---- /// </p> /// </remarks> + /// <value>The name of the entity interceptor in the object factory/application context.</value> public override string EntityInterceptorObjectName { *************** *** 240,243 **** --- 242,246 ---- /// Set the object factory instance. /// </summary> + /// <value>The object factory instance</value> public override IObjectFactory ObjectFactory { *************** *** 376,383 **** --- 379,388 ---- } + /// <summary> /// Delete the given persistent instance. /// </summary> /// <param name="entity">The persistent instance to delete.</param> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> public void Delete(object entity) { *************** *** 385,391 **** --- 390,399 ---- } + /// <summary> /// Delete the given persistent instance. /// </summary> + /// <param name="entity">Tthe persistent instance to delete.</param> + /// <param name="lockMode">The lock mode to obtain.</param> /// <remarks> /// Obtains the specified lock mode if the instance exists, implicitly *************** *** 393,398 **** /// (throwing an OptimisticLockingFailureException if not found). /// </remarks> ! /// <param name="entity">The persistent instance to delete.</param> ! /// <param name="lockMode">The lock mode to obtain.</param> public void Delete(object entity, LockMode lockMode) { --- 401,405 ---- /// (throwing an OptimisticLockingFailureException if not found). /// </remarks> ! /// <exception cref="DataAccessException">In case of Hibernate errors</exception> public void Delete(object entity, LockMode lockMode) { *************** *** 405,408 **** --- 412,416 ---- /// <param name="queryString">a query expressed in Hibernate's query language.</param> /// <returns>The number of entity instances deleted.</returns> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> public int Delete(string queryString) { *************** *** 417,420 **** --- 425,429 ---- /// <param name="type">The Hibernate type of the parameter (or <code>null</code>).</param> /// <returns>The number of entity instances deleted.</returns> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> public int Delete(string queryString, object value, IType type) { *************** *** 429,432 **** --- 438,442 ---- /// <param name="types"> Hibernate types of the parameters (or <code>null</code>)</param> /// <returns>The number of entity instances deleted.</returns> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> public int Delete(string queryString, object[] values, IType[] types) { *************** *** 442,445 **** --- 452,456 ---- /// to rely on auto-flushing at transaction completion. /// </remarks> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> public void Flush() { *************** *** 453,456 **** --- 464,469 ---- /// <param name="entity">Entity the object (of the target class) to load into.</param> /// <param name="id">An identifier of the persistent instance.</param> + /// <exception cref="ObjectRetrievalFailureException">If object not found.</exception> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> public void Load(object entity, object id) { *************** *** 462,465 **** --- 475,479 ---- /// </summary> /// <param name="entity">The persistent instance to re-read.</param> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> public void Refresh(object entity) { *************** *** 473,476 **** --- 487,491 ---- /// <param name="entity">The persistent instance to re-read.</param> /// <param name="lockMode">The lock mode to obtain.</param> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> public void Refresh(object entity, LockMode lockMode) { *************** *** 485,488 **** --- 500,504 ---- /// <c>true</c> if session cache contains the specified entity; otherwise, <c>false</c>. /// </returns> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> public bool Contains(object entity) { *************** *** 494,497 **** --- 510,514 ---- /// </summary> /// <param name="entity">The persistent instance to evict.</param> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> public void Evict(object entity) { *************** *** 506,509 **** --- 523,528 ---- /// <param name="entity">The he persistent instance to lock.</param> /// <param name="lockMode">The lock mode to obtain.</param> + /// <exception cref="ObjectOptimisticLockingFailureException">If not found</exception> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> public void Lock(object entity, LockMode lockMode) { *************** *** 516,519 **** --- 535,539 ---- /// <param name="entity">The transient instance to persist.</param> /// <returns>The generated identifier.</returns> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> public object Save(object entity) { *************** *** 526,529 **** --- 546,550 ---- /// <param name="entity">The transient instance to persist.</param> /// <param name="id">The identifier to assign.</param> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> public void Save(object entity, object id) { *************** *** 535,538 **** --- 556,560 ---- /// </summary> /// <param name="entity">The persistent instance to update.</param> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> public void Update(object entity) { *************** *** 548,551 **** --- 570,574 ---- /// <param name="entity">The persistent instance to update.</param> /// <param name="lockMode">The lock mode to obtain.</param> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> public void Update(object entity, LockMode lockMode) { *************** *** 559,562 **** --- 582,586 ---- /// <param name="entity">Tthe persistent instance to save or update /// (to be associated with the Hibernate Session).</param> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> public void SaveOrUpdate(object entity) { *************** *** 575,578 **** --- 599,603 ---- /// <returns>The actually associated persistent object. /// (either an already loaded instance with the same id, or the given object)</returns> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> public object SaveOrUpdateCopy(object entity) { *************** *** 589,595 **** /// Obtains the specified lock mode if the instance exists. /// </summary> /// <param name="id">The id of the object to get.</param> /// <returns>the persistent instance, or null if not found</returns> ! /// public T Get<T>(object id) { --- 614,621 ---- /// Obtains the specified lock mode if the instance exists. /// </summary> + /// <typeparam name="T">The object type to get.</typeparam> /// <param name="id">The id of the object to get.</param> /// <returns>the persistent instance, or null if not found</returns> ! /// <exception cref="DataAccessException">In case of Hibernate errors</exception> public T Get<T>(object id) { *************** *** 602,608 **** --- 628,636 ---- /// Obtains the specified lock mode if the instance exists. /// </summary> + /// <typeparam name="T">The object type to get.</typeparam> /// <param name="id">The lock mode to obtain.</param> /// <param name="lockMode">The lock mode.</param> /// <returns>the persistent instance, or null if not found</returns> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> public T Get<T>(object id, LockMode lockMode) { *************** *** 618,623 **** --- 646,654 ---- /// with the given identifier, throwing an exception if not found. /// </summary> + /// <typeparam name="T">The object type to load.</typeparam> /// <param name="id">An identifier of the persistent instance.</param> /// <returns>The persistent instance</returns> + /// <exception cref="ObjectRetrievalFailureException">If not found</exception> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> public T Load<T>(object id) { *************** *** 630,636 **** --- 661,670 ---- /// Obtains the specified lock mode if the instance exists. /// </summary> + /// <typeparam name="T">The object type to load.</typeparam> /// <param name="id">An identifier of the persistent instance.</param> /// <param name="lockMode">The lock mode.</param> /// <returns>The persistent instance</returns> + /// <exception cref="ObjectRetrievalFailureException">If not found</exception> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> public T Load<T>(object id, LockMode lockMode) { *************** *** 642,646 **** --- 676,682 ---- /// Note: Use queries or criteria for retrieving a specific subset. /// </summary> + /// <typeparam name="T">The object type to load.</typeparam> /// <returns>A generic List containing 0 or more persistent instances</returns> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> public IList<T> LoadAll<T>() { *************** *** 655,662 **** --- 691,700 ---- /// Execute a query for persistent instances. /// </summary> + /// <typeparam name="T">The object type to find.</typeparam> /// <param name="queryString">a query expressed in Hibernate's query language</param> /// <returns> /// a generic List containing 0 or more persistent instances /// </returns> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> public IList<T> Find<T>(string queryString) { *************** *** 668,671 **** --- 706,710 ---- /// one value to a "?" parameter in the query string. /// </summary> + /// <typeparam name="T">The object type to find.</typeparam> /// <param name="queryString">a query expressed in Hibernate's query language</param> /// <param name="value">the value of the parameter</param> *************** *** 673,676 **** --- 712,716 ---- /// a generic List containing 0 or more persistent instances /// </returns> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> public IList<T> Find<T>(string queryString, object value) { *************** *** 682,685 **** --- 722,726 ---- /// to a "?" parameter of the given type in the query string. /// </summary> + /// <typeparam name="T">The object type to find.</typeparam> /// <param name="queryString">a query expressed in Hibernate's query language</param> /// <param name="value">The value of the parameter.</param> *************** *** 688,691 **** --- 729,733 ---- /// a generic List containing 0 or more persistent instances /// </returns> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> public IList<T> Find<T>(string queryString, object value, IType type) { *************** *** 697,703 **** --- 739,747 ---- /// number of values to "?" parameters in the query string. /// </summary> + /// <typeparam name="T">The object type to find.</typeparam> /// <param name="queryString">a query expressed in Hibernate's query language</param> /// <param name="values">the values of the parameters</param> /// <returns>a generic List containing 0 or more persistent instances</returns> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> public IList<T> Find<T>(string queryString, object[] values) { *************** *** 709,712 **** --- 753,757 ---- /// values to "?" parameters of the given types in the query string. /// </summary> + /// <typeparam name="T">The object type to find.</typeparam> /// <param name="queryString">A query expressed in Hibernate's query language</param> /// <param name="values">The values of the parameters</param> *************** *** 715,718 **** --- 760,765 ---- /// a generic List containing 0 or more persistent instances /// </returns> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> + /// <exception cref="ArgumentException">If values and types are not null and their lengths are not equal</exception> public IList<T> Find<T>(string queryString, object[] values, IType[] types) { *************** *** 728,735 **** --- 775,784 ---- /// one value to a named parameter in the query string. /// </summary> + /// <typeparam name="T">The object type to find.</typeparam> /// <param name="queryName">The name of a Hibernate query in a mapping file</param> /// <param name="paramName">The name of the parameter</param> /// <param name="value">The value of the parameter</param> /// <returns>a generic List containing 0 or more persistent instances</returns> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> public IList<T> FindByNamedParam<T>(string queryName, string paramName, object value) { *************** *** 741,744 **** --- 790,794 ---- /// one value to a named parameter in the query string. /// </summary> + /// <typeparam name="T">The object type to find.</typeparam> /// <param name="queryName">The name of a Hibernate query in a mapping file</param> /// <param name="paramName">The name of the parameter</param> *************** *** 746,749 **** --- 796,800 ---- /// <param name="type">Hibernate type of the parameter (or null)</param> /// <returns>A generic List containing 0 or more persistent instances</returns> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> public IList<T> FindByNamedParam<T>(string queryName, string paramName, object value, IType type) { *************** *** 755,762 **** --- 806,815 ---- /// number of values to named parameters in the query string. /// </summary> + /// <typeparam name="T">The object type to find.</typeparam> /// <param name="queryString">A query expressed in Hibernate's query language</param> /// <param name="paramNames">The names of the parameters</param> /// <param name="values">The values of the parameters</param> /// <returns>A generic List containing 0 or more persistent instances</returns> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> public IList<T> FindByNamedParam<T>(string queryString, string[] paramNames, object[] values) { *************** *** 768,771 **** --- 821,825 ---- /// number of values to named parameters in the query string. /// </summary> + /// <typeparam name="T">The object type to find.</typeparam> /// <param name="queryString">A query expressed in Hibernate's query language</param> /// <param name="paramNames">The names of the parameters</param> *************** *** 773,776 **** --- 827,833 ---- /// <param name="types">Hibernate types of the parameters (or null)</param> /// <returns>A generic List containing 0 or more persistent instances</returns> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> + /// <exception cref="ArgumentOutOfRangeException">If paramNames length is not equal to values length or + /// if paramNames length is not equal to types length (when types is not null)</exception> public IList<T> FindByNamedParam<T>(string queryString, string[] paramNames, object[] values, IType[] types) { *************** *** 794,799 **** --- 851,858 ---- /// A named query is defined in a Hibernate mapping file. /// </summary> + /// <typeparam name="T">The object type to find.</typeparam> /// <param name="queryName">The name of a Hibernate query in a mapping file</param> /// <returns>A generic List containing 0 or more persistent instances</returns> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> public IList<T> FindByNamedQuery<T>(string queryName) { *************** *** 806,812 **** --- 865,873 ---- /// A named query is defined in a Hibernate mapping file. /// </summary> + /// <typeparam name="T">The object type to find.</typeparam> /// <param name="queryName">The name of a Hibernate query in a mapping file</param> /// <param name="value">The value of the parameter</param> /// <returns>A generic List containing 0 or more persistent instances</returns> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> public IList<T> FindByNamedQuery<T>(string queryName, object value) { *************** *** 819,826 **** --- 880,889 ---- /// A named query is defined in a Hibernate mapping file. /// </summary> + /// <typeparam name="T">The object type to find.</typeparam> /// <param name="queryName">The name of a Hibernate query in a mapping file</param> /// <param name="value">The value of the parameter</param> /// <param name="type">Hibernate type of the parameter (or null)</param> /// <returns>A generic List containing 0 or more persistent instances</returns> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> public IList<T> FindByNamedQuery<T>(string queryName, object value, IType type) { *************** *** 833,839 **** --- 896,904 ---- /// A named query is defined in a Hibernate mapping file. /// </summary> + /// <typeparam name="T">The object type to find.</typeparam> /// <param name="queryName">The name of a Hibernate query in a mapping file</param> /// <param name="values">The values of the parameters</param> /// <returns>A generic List containing 0 or more persistent instances</returns> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> public IList<T> FindByNamedQuery<T>(string queryName, object[] values) { *************** *** 846,853 **** --- 911,921 ---- /// A named query is defined in a Hibernate mapping file. /// </summary> + /// <typeparam name="T">The object type to find.</typeparam> /// <param name="queryName">The name of a Hibernate query in a mapping file</param> /// <param name="values">The values of the parameters</param> /// <param name="types">Hibernate types of the parameters (or null)</param> /// <returns>A generic List containing 0 or more persistent instances</returns> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> + /// <exception cref="ArgumentOutOfRangeException">If values and types are not null and their lengths differ.</exception> public IList<T> FindByNamedQuery<T>(string queryName, object[] values, IType[] types) { *************** *** 864,871 **** --- 932,941 ---- /// A named query is defined in a Hibernate mapping file. /// </summary> + /// <typeparam name="T">The object type to find.</typeparam> /// <param name="queryName">The name of a Hibernate query in a mapping file</param> /// <param name="paramName">Name of the parameter</param> /// <param name="value">The value of the parameter</param> /// <returns>A generic List containing 0 or more persistent instances</returns> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> public IList<T> FindByNamedQueryAndNamedParam<T>(string queryName, string paramName, object value) { *************** *** 878,881 **** --- 948,952 ---- /// A named query is defined in a Hibernate mapping file. /// </summary> + /// <typeparam name="T">The object type to find.</typeparam> /// <param name="queryName">The name of a Hibernate query in a mapping file</param> /// <param name="paramName">Name of the parameter</param> *************** *** 883,886 **** --- 954,958 ---- /// <param name="type">The Hibernate type of the parameter (or null)</param> /// <returns>A generic List containing 0 or more persistent instances</returns> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> public IList<T> FindByNamedQueryAndNamedParam<T>(string queryName, string paramName, object value, IType type) { *************** *** 894,901 **** --- 966,975 ---- /// A named query is defined in a Hibernate mapping file. /// </summary> + /// <typeparam name="T">The object type to find.</typeparam> /// <param name="queryName">The name of a Hibernate query in a mapping file</param> /// <param name="paramNames">The names of the parameters</param> /// <param name="values">The values of the parameters.</param> /// <returns>A generic List containing 0 or more persistent instances</returns> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> public IList<T> FindByNamedQueryAndNamedParam<T>(string queryName, string[] paramNames, object[] values) { *************** *** 908,911 **** --- 982,986 ---- /// A named query is defined in a Hibernate mapping file. /// </summary> + /// <typeparam name="T">The object type to find.</typeparam> /// <param name="queryName">The name of a Hibernate query in a mapping file</param> /// <param name="paramNames">The names of the parameters</param> *************** *** 913,916 **** --- 988,994 ---- /// <param name="types">Hibernate types of the parameters (or null)</param> /// <returns>A generic List containing 0 or more persistent instances</returns> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> + /// <exception cref="ArgumentOutOfRangeException">If paramNames length is not equal to values length or + /// if paramNames length is not equal to types length (when types is not null)</exception> public IList<T> FindByNamedQueryAndNamedParam<T>(string queryName, string[] paramNames, object[] values, IType[] types) *************** *** 921,925 **** "Length of paramNames array must match length of values array"); } ! if (values != null && types != null && paramNames.Length != types.Length) { throw new ArgumentOutOfRangeException("paramNams", --- 999,1003 ---- "Length of paramNames array must match length of values array"); } ! if (paramNames != null && types != null && paramNames.Length != types.Length) { throw new ArgumentOutOfRangeException("paramNams", *************** *** 937,943 **** --- 1015,1023 ---- /// A named query is defined in a Hibernate mapping file. /// </summary> + /// <typeparam name="T">The object type to find.</typeparam> /// <param name="queryName">The name of a Hibernate query in a mapping file</param> /// <param name="valueObject">The values of the parameters</param> /// <returns>A generic List containing 0 or more persistent instances</returns> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> public IList<T> FindByNamedQueryAndValueObject<T>(string queryName, object valueObject) { *************** *** 950,956 **** --- 1030,1038 ---- /// of the given object to <i>named</i> parameters in the query string. /// </summary> + /// <typeparam name="T">The object type to find.</typeparam> /// <param name="queryString">A query expressed in Hibernate's query language</param> /// <param name="valueObject">The values of the parameters</param> /// <returns>A generic List containing 0 or more persistent instances</returns> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> public IList<T> FindByValueObject<T>(string queryString, object valueObject) { *************** *** 975,981 **** --- 1057,1065 ---- /// </p> /// </remarks> + /// <typeparam name="T">The object type retrieved.</typeparam> /// <param name="del">The delegate callback object that specifies the Hibernate action.</param> /// <returns>a result object returned by the action, or null /// </returns> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> public T Execute<T>(HibernateDelegate<T> del) { *************** *** 986,989 **** --- 1070,1074 ---- /// Execute the action specified by the delegate within a Session. /// </summary> + /// <typeparam name="T">The object type retrieved.</typeparam> /// <param name="del">The HibernateDelegate that specifies the action /// to perform.</param> *************** *** 992,995 **** --- 1077,1081 ---- /// <returns>a result object returned by the action, or null /// </returns> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> public T Execute<T>(HibernateDelegate<T> del, bool exposeNativeSession) { *************** *** 1000,1003 **** --- 1086,1090 ---- /// Execute the action specified by the given action object within a Session. /// </summary> + /// <typeparam name="T">The object type retrieved.</typeparam> /// <param name="action">The callback object that specifies the Hibernate action.</param> /// <returns> *************** *** 1014,1017 **** --- 1101,1105 ---- /// </p> /// </remarks> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> public T Execute<T>(IHibernateCallback<T> action) { *************** *** 1022,1025 **** --- 1110,1114 ---- /// Execute the action specified by the given action object within a Session. /// </summary> + /// <typeparam name="T">The object type retrieved.</typeparam> /// <param name="action">callback object that specifies the Hibernate action.</param> /// <param name="exposeNativeSession">if set to <c>true</c> expose the native hibernate session to *************** *** 1028,1031 **** --- 1117,1121 ---- /// a result object returned by the action, or null /// </returns> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> public T Execute<T>(IHibernateCallback<T> action, bool exposeNativeSession) { *************** *** 1097,1100 **** --- 1187,1191 ---- /// Execute the action specified by the given action object within a Session assuming that an IList is returned. /// </summary> + /// <typeparam name="T">The object type to find.</typeparam> /// <param name="action">callback object that specifies the Hibernate action.</param> /// <param name="exposeNativeSession">if set to <c>true</c> expose the native hibernate session to *************** *** 1103,1106 **** --- 1194,1198 ---- /// an IList returned by the action, or null /// </returns> + /// <exception cref="DataAccessException">In case of Hibernate errors</exception> public IList<T> ExecuteFind<T>(IFindHibernateCallback<T> action, bool exposeNativeSession) { *************** *** 1177,1183 **** --- 1269,1277 ---- /// </p> /// </remarks> + /// <typeparam name="T">The object type to find.</typeparam> /// <param name="del">The delegate callback object that specifies the Hibernate action.</param> /// <returns>A generic IList returned by the action, or null /// </returns> + /// <exception cref="DataAccessException">In case of Hibernate errors</ex... [truncated message content] |
