Supports return TOP records from ObjectsList(). Closes #92.

hisystems · Jun 29, 2014 · f69dd1c · f69dd1c
1 parent 03251d5
commit f69dd1c
Show file tree

Hide file tree

Showing 3 changed files with 103 additions and 3 deletions.
diff --git a/Database/Database.cs b/Database/Database.cs
@@ -846,7 +846,7 @@ public void ObjectsDeleteAll(IDatabaseObjects objCollection)
 			using (ConnectionScope objConnection = new ConnectionScope(this))
 				objConnection.ExecuteNonQuery(objDelete);
 		}
-		
+
 		/// --------------------------------------------------------------------------------
 		/// <summary>
 		/// Returns an IList object containing all of the collection's associated child
@@ -873,11 +873,47 @@ public void ObjectsDeleteAll(IDatabaseObjects objCollection)
 		/// --------------------------------------------------------------------------------
 		///
 		public IList ObjectsList(IDatabaseObjects objCollection)
+		{
+			return ObjectsList(objCollection, maxRecords: 0);
+		}
+
+		/// --------------------------------------------------------------------------------
+		/// <summary>
+		/// Returns an IList object containing the first n of the collection's associated child
+		/// objects. This function is useful when loading a set of objects for a subset or
+		/// for use with the IEnumerable interface.
+		/// </summary>
+		///
+		/// <param name="objCollection">
+		/// The collection which contains the objects to load.
+		/// </param>
+		///
+		/// <param name="maxRecords">
+		/// The maximum number of records to return. 
+		/// Zero returns all of the records.
+		/// </param>
+		///
+		/// <returns><see cref="Collections.IList" />	(System.Collections.IList)</returns>
+		///
+		/// <example>
+		/// <code>
+		/// 'Can be used to provide an enumerator for use with the "For Each" clause
+		/// Private Function GetEnumerator() As System.Collections.IEnumerator Implements System.Collections.IEnumerable.GetEnumerator
+		///
+		///     Return objDatabase.ObjectsList(objGlobalProductsInstance, 1000).GetEnumerator
+		///
+		/// End Function
+		/// </code>
+		/// </example>
+		/// --------------------------------------------------------------------------------
+		///
+		public IList ObjectsList(IDatabaseObjects objCollection, int maxRecords)
 		{
 			IList objArrayList = new ArrayList();
 			SQL.SQLSelect objSelect = new SQL.SQLSelect();
 
 			SQL.SQLSelectTable objPrimaryTable = objSelect.Tables.Add(objCollection.TableName());
+			objSelect.Top = maxRecords;
 			objSelect.Tables.Joins = objCollection.TableJoins(objPrimaryTable, objSelect.Tables);
 			objSelect.Where = objCollection.Subset();
 			objSelect.OrderBy = objCollection.OrderBy();

diff --git a/Database/DatabaseObjects.cs b/Database/DatabaseObjects.cs
@@ -486,7 +486,39 @@ protected IDatabaseObject ObjectFromFieldValues(SQL.SQLFieldValues objFieldValue
 		{
 			return Database.ObjectFromFieldValues(this, objFieldValues);
 		}
-
+
+		/// --------------------------------------------------------------------------------
+		/// <summary>
+		/// Returns an IList object containing the first n of the collection's associated child
+		/// objects. This function is useful when loading a set of objects for a subset or
+		/// for use with the IEnumerable interface.
+		/// </summary>
+		///
+		/// <param name="maxRecords">
+		/// The maximum number of records to return. 
+		/// Zero returns all of the records.
+		/// </param>
+		///
+		/// <returns><see cref="Collections.IList" />	(System.Collections.IList)</returns>
+		///
+		/// <example>
+		/// <code>
+		/// 'Alternatively, the DatabaseObjectsEnumerable class can be used which
+		/// 'automatically incorporates an enumerator
+		/// Private Function GetEnumerator() As System.Collections.IEnumerator Implements System.Collections.IEnumerable.GetEnumerator
+		///
+		///     Return MyBase.ObjectsList(1000).GetEnumerator
+		///
+		/// End Function
+		/// </code>
+		/// </example>
+		/// --------------------------------------------------------------------------------
+		///
+		protected IList ObjectsList(int maxRecords)
+		{
+			return this.ParentDatabase.ObjectsList(this, maxRecords);
+		}
+
 		/// --------------------------------------------------------------------------------
 		/// <summary>
 		/// Returns an IList object containing all of this collection's objects. This

diff --git a/Generic/DatabaseObjects.cs b/Generic/DatabaseObjects.cs
@@ -341,7 +341,39 @@ protected new T[] ObjectsArray()
 
 			return objArray;
 		}
-
+
+		/// --------------------------------------------------------------------------------
+		/// <summary>
+		/// Returns an IList object containing the first n of the collection's associated child
+		/// objects. This function is useful when loading a set of objects for a subset or
+		/// for use with the IEnumerable interface.
+		/// </summary>
+		///
+		/// <param name="maxRecords">
+		/// The maximum number of records to return. 
+		/// Zero returns all of the records.
+		/// </param>
+		///
+		/// <returns><see cref="Collections.IList" />	(System.Collections.IList)</returns>
+		///
+		/// <example>
+		/// <code>
+		/// 'Alternatively, the DatabaseObjectsEnumerable class can be used which
+		/// 'automatically incorporates an enumerator
+		/// Private Function GetEnumerator() As System.Collections.IEnumerator Implements System.Collections.IEnumerable.GetEnumerator
+		///
+		///     Return MyBase.ObjectsList(1000).GetEnumerator
+		///
+		/// End Function
+		/// </code>
+		/// </example>
+		/// --------------------------------------------------------------------------------
+		///
+		protected new IList<T> ObjectsList(int maxRecords)
+		{
+			return this.ObjectsListConvert(base.ObjectsList(maxRecords));
+		}
+
 		/// --------------------------------------------------------------------------------
 		/// <summary>
 		/// Returns an IList object containing all of this collection's objects. This