Skip to content

Commit

Permalink
Updated docs to indicate transaction is an optional param.
Browse files Browse the repository at this point in the history
  • Loading branch information
Jeff Adams committed Jul 12, 2010
1 parent 0e76145 commit 1acea0b
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions IDaLayer.cs
View file
Expand Up @@ -69,7 +69,7 @@ public interface IDaLayer
/// <summary>
/// Deletes a data object record using the mapping and criteria for what's deleted.
/// </summary>
/// <param name="transaction">The transaction to do this as part of.</param>
/// <param name="transaction">The transaction to do this as part of. May be null.</param>
/// <param name="mapping">The mapping of the table from which to delete.</param>
/// <param name="crit">Criteria for deletion. NOTE: Only the expressions are observed,
/// other things (like "order" or start / limit) are ignored.
Expand All @@ -91,7 +91,7 @@ public interface IDaLayer
/// <summary>
/// Inserts a data object record using the "table" and a list of column/value pairs.
/// </summary>
/// <param name="transaction">The transaction to do this as part of.</param>
/// <param name="transaction">The transaction to do this as part of. May be null.</param>
/// <param name="mapping">The mapping of the table or other data container we're dealing with.</param>
/// <param name="propValues">A dictionary of "column"/value pairs for the object to insert.</param>
/// <returns>The number of records affected.</returns>
Expand All @@ -100,7 +100,7 @@ public interface IDaLayer
/// <summary>
/// Inserts a list of data object records of the same type.
/// </summary>
/// <param name="transaction">The transaction to do this as part of.</param>
/// <param name="transaction">The transaction to do this as part of. May be null.</param>
/// <param name="mapping">The mapping of the table or other data container we're dealing with.</param>
/// <param name="propValueDictionaries">A list of dictionaries of column/value pairs.
/// Each item in the list should represent the dictionary of column/value pairs for
Expand All @@ -112,7 +112,7 @@ public interface IDaLayer
/// <summary>
/// Updates a data object record using the "table" and a list of column/value pairs.
/// </summary>
/// <param name="transaction">The transaction to do this as part of.</param>
/// <param name="transaction">The transaction to do this as part of. May be null.</param>
/// <param name="mapping">The mapping of the table or other data container we're dealing with.</param>
/// <param name="crit">All records matching this criteria will be updated per the dictionary of
/// values.</param>
Expand All @@ -123,7 +123,7 @@ public interface IDaLayer
/// <summary>
/// Updates a list of data object records of the same type.
/// </summary>
/// <param name="transaction">The transaction to do this as part of.</param>
/// <param name="transaction">The transaction to do this as part of. May be null.</param>
/// <param name="mapping">The mapping of the table or other data container we're dealing with.</param>
/// <param name="criteriaList">A list of DaoCriteria.
/// Each item in the list should represent the criteria for
Expand All @@ -150,7 +150,7 @@ public interface IDaLayer
/// <summary>
/// Executes a query and invokes a method with a DataReader of results.
/// </summary>
/// <param name="transaction">The transaction to do this as part of.</param>
/// <param name="transaction">The transaction to do this as part of. May be null.</param>
/// <param name="mapping">Class mapping for the table we're querying against. Optional,
/// but not all columns may be properly typed if it is null.</param>
/// <param name="query">The query to execute, should have come from CreateQuery.</param>
Expand All @@ -169,7 +169,7 @@ public interface IDaLayer
/// <summary>
/// Gets a count of records for the given criteria.
/// </summary>
/// <param name="transaction">The transaction to do this as part of.</param>
/// <param name="transaction">The transaction to do this as part of. May be null.</param>
/// <param name="mapping">The mapping of the table for which to build the query string.</param>
/// <param name="crit">The criteria to use for "where" comparisons.</param>
/// <returns>The number of results found that matched the criteria.</returns>
Expand All @@ -180,7 +180,7 @@ public interface IDaLayer
/// aggregated by the given grouping expressions. This matches "GROUP BY" behavior
/// in SQL.
/// </summary>
/// <param name="transaction">The transaction to do this as part of.</param>
/// <param name="transaction">The transaction to do this as part of. May be null.</param>
/// <param name="mapping">The mapping of the table for which to build the query string.</param>
/// <param name="crit">The criteria to use for "where" comparisons.</param>
/// <param name="groupExpressions">The fields/expressions to aggregate on when counting.</param>
Expand All @@ -205,15 +205,15 @@ public interface IDaLayer
/// <summary>
/// Finds the last generated id number for a column.
/// </summary>
/// <param name="transaction">The transaction to do this as part of.</param>
/// <param name="transaction">The transaction to do this as part of. May be null.</param>
/// <param name="mapping">The class mapping for the table being queried.</param>
/// <param name="idCol">The ID column for which to find the last-generated ID.</param>
object GetLastAutoGeneratedId(ITransaction transaction, ClassMapping mapping, string idCol);

/// <summary>
/// Gets the next id number from a sequence in the data source.
/// </summary>
/// <param name="transaction">The transaction to do this as part of.</param>
/// <param name="transaction">The transaction to do this as part of. May be null.</param>
/// <param name="sequenceName">The name of the sequence.</param>
/// <returns>The next number from the sequence.</returns>
int GetNextSequenceValue(ITransaction transaction, string sequenceName);
Expand Down

0 comments on commit 1acea0b

Please sign in to comment.