The EntitySpaces 2008 API Reference (Full)
CollectionBase Class
EntitySpaces.CoreBusinessObjectsCollectionBase
Persistence Layer and Business Objects for Microsoft .NET
Used to change the inheritance hierarchy.
Declaration Syntax
C#Visual Basic
[SerializableAttribute]
public abstract class CollectionBase : esEntityCollection
<SerializableAttribute> _
Public MustInherit Class CollectionBase _
	Inherits esEntityCollection
Members
All MembersConstructorsMethodsPropertiesFieldsEvents



IconMemberDescription
CollectionBase()()()
Initializes a new instance of the CollectionBase class

AcceptChanges()()()
Makes all of the proposed values be the current values. You should not call this before Save(). In fact, in most case you will never call this method.
(Inherited from esEntityCollection.)
Add(Object) Obsolete. (Inherited from esEntityCollection.)
AddNewEntity()()()
Called by the generated collection class when AddNew() is called. This method implements the true AddNew() logic for collections.
(Inherited from esEntityCollection.)
AllowDelete
After loading your Collection you can disable AllowDelete by setting this to false. See also AllowNew and AllowEdit.
(Inherited from esEntityCollection.)
AllowEdit
After loading your Collection you can disable AllowEdit by setting this to false. See also AllowDelete and AllowNew.
(Inherited from esEntityCollection.)
AllowNew
After loading your Collection you can disable AllowNew by setting this to false. See also AllowDelete and AllowEdit.
(Inherited from esEntityCollection.)
AssignPrimaryKeys()()()
Assigns the underlying DataTable's PrimaryKey data member using the primary keys as defined in the collections associated esColumnMetadataCollection.
(Inherited from esEntityCollection.)
AttachEntity(esEntity)
Attaches the entity.
(Inherited from esEntityCollection.)
ClearData()()()
Used internally by esEntityCollection to dispose of the table in a collection.
(Inherited from esEntityData.)
Combine(esEntityCollection)
Combines two collections into a single collection.
(Inherited from esEntityCollection.)
Count
The number of esEntity in the collection.
(Inherited from esEntityCollection.)
CreateColumnsForBinding(array<String>[]()[])
Useful when binding to a collection with no data, this will create the columns for the Grid using property names passed in.
(Inherited from esEntityCollection.)
CreateColumnsForBinding()()()
Useful when binding to a collection with no data, this will create the columns for the Grid.
(Inherited from esEntityCollection.)
CreateEntity()()()
Called internally anytime a single esEntity class of the proper type is needed. This is implemented in the generated collection class.
(Inherited from esEntityCollection.)
CreateEntityForCollection(DataRow)
Overloaded by the generated collection class to create the esEntity class of the proper type.
(Inherited from esEntityCollection.)
CreateRequest()()()
Called internally anytime the esEntityCollection class is about to make a call to one of the EntitySpaces' DataPoviders. This method wraps up most of the common logic required to make the actual call.
(Inherited from esEntityCollection.)
CreateSchema()()()
Called during AddNew() by EntitySpaces to populate the entity's schema information. This populates the DataTable with its corresponding DataColumns without accessing the database, therefore AddNew() is safe to call on the client side of a webservice.
(Inherited from esEntityCollection.)
DeleteAll()()() Obsolete.
Obsolete, see MarkAllAsDeleted()()()
(Inherited from esEntityCollection.)
DetachEntity(esEntity)
Detaches the entity.
(Inherited from esEntityCollection.)
Dispose()()()
For IDisposable support.
(Inherited from esEntityCollection.)
Disposed
For IDisposable support.
(Inherited from esEntityCollection.)
EnableHierarchicalBinding
This method is valid for Windows.Forms applications only
(Inherited from esEntityCollection.)
Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Errors
If an error occurs during Save you can iterate through the errors. You use foreach to iterator over the esEntity's who had an error during save checking their RowError property
(Inherited from esEntityCollection.)
es
The IEntityCollection interface serves to semi-hide many of the base class functionality required by EntitySpaces. This serves two purposes, it keeps intellisense from getting polluted by noise and prevents the EntitySpaces "core" functionaltiy from colliding with your properties during code generation.
(Inherited from esEntityCollection.)
ExecuteNonQuery(esQueryType, String)
Can be called by a method in your Custom collection. This does not populate your entity.
(Inherited from esEntityCollection.)
ExecuteNonQuery(esQueryType, String, array<Object>[]()[])
Can be called by a method in your Custom collection. This does not populate your entity.
(Inherited from esEntityCollection.)
ExecuteNonQuery(esQueryType, String, esParameters)
Can be called by a method in your Custom collection. This does not populate your entity.
(Inherited from esEntityCollection.)
ExecuteNonQuery(String, String)
Can be called by a method in your Custom collection. This does not populate your entity.
(Inherited from esEntityCollection.)
ExecuteNonQuery(String, String, array<Object>[]()[])
Can be called by a method in your Custom collection. This does not populate your entity.
(Inherited from esEntityCollection.)
ExecuteNonQuery(String, String, esParameters)
Can be called by a method in your Custom collection. This does not populate your entity.
(Inherited from esEntityCollection.)
ExecuteNonQuery(String, String, String)
Can be called by a method in your Custom collection. This does not populate your entity.
(Inherited from esEntityCollection.)
ExecuteNonQuery(String, String, String, array<Object>[]()[])
Can be called by a method in your Custom collection. This does not populate your entity.
(Inherited from esEntityCollection.)
ExecuteNonQuery(String, String, String, esParameters)
Can be called by a method in your Custom collection. This does not populate your entity.
(Inherited from esEntityCollection.)
ExecuteReader(esQueryType, String)
Can be called by a method in your Custom collection. This does not populate your entity.
(Inherited from esEntityCollection.)
ExecuteReader(esQueryType, String, array<Object>[]()[])
Can be called by a method in your Custom collection. This does not populate your entity.
(Inherited from esEntityCollection.)
ExecuteReader(esQueryType, String, esParameters)
Can be called by a method in your Custom collection. This does not populate your entity.
(Inherited from esEntityCollection.)
ExecuteReader(String, String)
Can be called by a method in your Custom collection. This does not populate your entity.
(Inherited from esEntityCollection.)
ExecuteReader(String, String, array<Object>[]()[])
Can be called by a method in your Custom collection. This does not populate your entity.
(Inherited from esEntityCollection.)
ExecuteReader(String, String, esParameters)
Can be called by a method in your Custom collection. This does not populate your entity.
(Inherited from esEntityCollection.)
ExecuteReader(String, String, String)
Can be called by a method in your Custom collection. This does not populate your entity.
(Inherited from esEntityCollection.)
ExecuteReader(String, String, String, array<Object>[]()[])
Can be called by a method in your Custom collection. This does not populate your entity.
(Inherited from esEntityCollection.)
ExecuteReader(String, String, String, esParameters)
Can be called by a method in your Custom collection. This does not populate your entity.
(Inherited from esEntityCollection.)
ExecuteScalar(esQueryType, String)
Can be called by a method in your Custom collection. This does not populate your entity.
(Inherited from esEntityCollection.)
ExecuteScalar(esQueryType, String, array<Object>[]()[])
Can be called by a method in your Custom collection. This does not populate your entity.
(Inherited from esEntityCollection.)
ExecuteScalar(esQueryType, String, esParameters)
Can be called by a method in your Custom collection. This does not populate your entity.
(Inherited from esEntityCollection.)
ExecuteScalar(String, String)
Can be called by a method in your Custom collection. This does not populate your entity.
(Inherited from esEntityCollection.)
ExecuteScalar(String, String, array<Object>[]()[])
Can be called by a method in your Custom collection. This does not populate your entity.
(Inherited from esEntityCollection.)
ExecuteScalar(String, String, esParameters)
Can be called by a method in your Custom collection. This does not populate your entity.
(Inherited from esEntityCollection.)
ExecuteScalar(String, String, String)
Can be called by a method in your Custom collection. This does not populate your entity.
(Inherited from esEntityCollection.)
ExecuteScalar(String, String, String, array<Object>[]()[])
Can be called by a method in your Custom collection. This does not populate your entity.
(Inherited from esEntityCollection.)
ExecuteScalar(String, String, String, esParameters)
Can be called by a method in your Custom collection. This does not populate your entity.
(Inherited from esEntityCollection.)
FillDataSet(esQueryType, String)
Can be called by a method in your Custom entity. This does not populate your entity.
(Inherited from esEntityCollection.)
FillDataSet(esQueryType, String, array<Object>[]()[])
Can be called by a method in your Custom entity. This does not populate your entity.
(Inherited from esEntityCollection.)
FillDataSet(esQueryType, String, esParameters)
Can be called by a method in your Custom entity. This does not populate your entity.
(Inherited from esEntityCollection.)
FillDataSet(String, String)
Can be called by a method in your Custom entity. This does not populate your entity.
(Inherited from esEntityCollection.)
FillDataSet(String, String, array<Object>[]()[])
Can be called by a method in your Custom entity. This does not populate your entity.
(Inherited from esEntityCollection.)
FillDataSet(String, String, esParameters)
Can be called by a method in your Custom entity. This does not populate your entity.
(Inherited from esEntityCollection.)
FillDataSet(String, String, String)
Can be called by a method in your Custom collection. This does not populate your entity.
(Inherited from esEntityCollection.)
FillDataSet(String, String, String, array<Object>[]()[])
Can be called by a method in your Custom collection. This does not populate your entity.
(Inherited from esEntityCollection.)
FillDataSet(String, String, String, esParameters)
Can be called by a method in your Custom collection. This does not populate your entity.
(Inherited from esEntityCollection.)
FillDataTable(esQueryType, String)
Can be called by a method in your Custom entity. This does not populate your entity.
(Inherited from esEntityCollection.)
FillDataTable(esQueryType, String, array<Object>[]()[])
Can be called by a method in your Custom entity. This does not populate your entity.
(Inherited from esEntityCollection.)
FillDataTable(esQueryType, String, esParameters)
Can be called by a method in your Custom entity. This does not populate your entity.
(Inherited from esEntityCollection.)
FillDataTable(String, String)
Can be called by a method in your Custom entity. This does not populate your entity.
(Inherited from esEntityCollection.)
FillDataTable(String, String, array<Object>[]()[])
Can be called by a method in your Custom entity. This does not populate your entity.
(Inherited from esEntityCollection.)
FillDataTable(String, String, esParameters)
Can be called by a method in your Custom entity. This does not populate your entity.
(Inherited from esEntityCollection.)
FillDataTable(String, String, String)
Can be called by a method in your Custom collection. This does not populate your entity.
(Inherited from esEntityCollection.)
FillDataTable(String, String, String, array<Object>[]()[])
Can be called by a method in your Custom collection. This does not populate your entity.
(Inherited from esEntityCollection.)
FillDataTable(String, String, String, esParameters)
Can be called by a method in your Custom collection. This does not populate your entity.
(Inherited from esEntityCollection.)
Filter
After loading a Collection it can be filtered to temporarily hide rows using this property.
(Inherited from esEntityCollection.)
Finalize()()()
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
FindByIndex(Int32)
After a collection is loaded this method can be called to locate a particular entity by its index in the collection
(Inherited from esEntityCollection.)
FindByPrimaryKey(Object)
After a collection is loaded this method can be called to locate a particular entity by its primary key.
(Inherited from esEntityCollection.)
FindByPrimaryKey(array<Object>[]()[])
After a collection is loaded this method can be called to locate a particular entity by its primary key.
(Inherited from esEntityCollection.)
fks
This is used by the Hierarchical Code.
(Inherited from esEntityCollection.)
GetCollectionName()()()
Overloaded by the generated class, this can be used during databinding and for other purposes.
(Inherited from esEntityCollection.)
GetDynamicQuery()()()
Overloaded by the generated collection class to return the proper generated query object.
(Inherited from esEntityCollection.)
GetEntityType()()()
You can call this to get the Type of the Entity contained in this collection
(Inherited from esEntityCollection.)
GetHashCode()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetType()()()
Gets the Type of the current instance.
(Inherited from Object.)
HasData
This method returns true if this Collection has been loaded with data and has at least one row of data that isn't marked as deleted.
(Inherited from esEntityCollection.)
HookupQuery(esDynamicQuery)
Called internally by EntitySpaces
(Inherited from esEntityCollection.)
IsDirty
This is set to true if AddNew(), MarkAsDeleted(), or if any of the contained esEntities table based properties have been modified. After a successful call to Save()()() IsDirty will report false.
(Inherited from esEntityCollection.)
Item[([(Int32])])
Index by position. This also respects the Sort and Filter properties just as using the foreach syntax does.
(Inherited from esEntityCollection.)
ListChanged
Called whenever the esEntityCollection data is changed.
(Inherited from esEntityCollection.)
Load(DataContext, IQueryable)
Allows you to use LinqToSql to load your Collection
(Inherited from esEntityCollection.)
Load(esQueryType, String)
Called by the EntitySpaces Dynamic Query mechanism to load a collection. It can also be called from a method in your Custom entity.
(Inherited from esEntityCollection.)
Load(esQueryType, String, array<Object>[]()[])
Called by the EntitySpaces Dynamic Query mechanism to load a collection. It can also be called from a method in your Custom entity.
(Inherited from esEntityCollection.)
Load(esQueryType, String, esParameters)
Called by the EntitySpaces Dynamic Query mechanism to load a collection. It can also be called from a method in your Custom entity.
(Inherited from esEntityCollection.)
LoadAll()()()
Loads all of the entities from the database.
(Inherited from esEntityCollection.)
LoadAll(esSqlAccessType)
Loads all of the entities from the database.
(Inherited from esEntityCollection.)
LowLevelBind()()()
Used to bind directly to the underlying DataTables "DefaultView" or DataView. This is useful when displaying read only information, especially when you are bringing back columns via a DynamicQuery that are not in your entity.
(Inherited from esEntityCollection.)
MarkAllAsDeleted()()()
This method marks all rows as deleted. Save still needs to be called to commit the changes to the database.
(Inherited from esEntityCollection.)
MemberwiseClone()()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
Meta
Read-only metadata for the entity.
(Inherited from esEntityCollection.)
PopulateCollection(DataTable)
Any time an esCollection is loaded with data, internally this method is called to create an esEntity to represent each DataRow in the underlying DataTable.
(Inherited from esEntityCollection.)
RejectChanges()()()
Rolls back all changes that have been made to the table since it was loaded, or the last time AcceptChanges was called.
(Inherited from esEntityCollection.)
RemovePrimaryKeys()()()
Removes the DataTable's 'PrimaryKey' information by setting it to null. Call this to undo AssignPrimaryKeys()
(Inherited from esEntityCollection.)
Row
Used internally by esEntity and esEntityCollection. An esEntityCollection never uses the Row property, however an esEntity always has a valid Row property after it has been successfully loaded with data.
(Inherited from esEntityData.)
RowCount
Used internally by esEntityCollection to retrieve the number of records in a collection.
(Inherited from esEntityData.)
RowStateFilter
Gets or sets the RowStateFilter for the collection's Table.DefaultView.
(Inherited from esEntityCollection.)
Save()()()
Called to save all of the modified entities in the collection.
(Inherited from esEntityCollection.)
Save(esSqlAccessType)
Called to save all of the modified entities in the collection.
(Inherited from esEntityCollection.)
SaveAndDiscard()()()
This is a quick way to save data, however, it doesn't save hierarchical data or bring back identity columns, timestamps, or other computed columns.
(Inherited from esEntityCollection.)
SaveAndDiscard(esSqlAccessType)
This is a quick way to save data, however, it doesn't save hierarchical data or bring back identity columns, timestamps, or other computed columns.
(Inherited from esEntityCollection.)
SaveToProvider(esSqlAccessType)
Called by Save. It calls SaveToProviderDeletes or SaveToProviderInsertsUpdates.
(Inherited from esEntityCollection.)
SaveToProviderDeletes(esSqlAccessType)
Called by SaveToProvider. This method commits DELETES only, not INSERTS or UPDATES
(Inherited from esEntityCollection.)
SaveToProviderInsertsUpdates(esSqlAccessType)
Called by SaveToProvider. This method commits INSERTS and UPDATES, not DELETES.
(Inherited from esEntityCollection.)
Sort
After loading a Collection it can be sorted.
(Inherited from esEntityCollection.)
Table
Used internally by esEntity and esEntityCollection. An esEntityCollection always has a valid Table property after successfully loading data. When an esEntity exists outside of an esEntityCollection the esEntity also has a valid Table property, however, when an esEntity is contained in an esEntityCollection the Table property will be null or Nothing.
(Inherited from esEntityData.)
ToString()()()
Returns a String that represents the current Object.
(Inherited from Object.)
Remarks
By checking "Use Custom Base Class" in the Generated Classes Master template Advanced Options, and copying the prototype base classes into your project, you can add custom code that affects all collections. The empty prototype classes are located in your EntitySpaces Program Folder.
Inheritance Hierarchy

Assembly: BusinessObjects (Module: BusinessObjects) Version: 2008.1.811.0 (2008.1.0811.0)