Dynamic Collections and query execution support.
Declaration Syntax| C# | Visual Basic | Visual C++ |
public abstract class DOCollection : MarshalByRefObject, IDisposable, IEnumerable
Public MustInherit Class DOCollection _ Inherits MarshalByRefObject _ Implements IDisposable, IEnumerable
public ref class DOCollection abstract : public MarshalByRefObject, IDisposable, IEnumerable
Members| All Members | Constructors | Methods | Properties | Fields | |
| Icon | Member | Description |
|---|---|---|
 | DOCollection(DOFactory) |
Constructor
|
 | Active |
The state of the current collection; Has it had a Find() or Fetch() invoked?
|
| ActiveDataSet | |
| ActiveFind(SQLBuilder) | Obsolete.
Performs a find which populates the collection and loads objects in to cache.
|
 | Average(DataObject, Enum, DBColumnType) |
Gets the average of the values in the specified column in the collection, using
the current query as a base.
|
| BindDataSource(Enum, ListControl, String) |
Bind a UI control to this DOCollection as a Data Source
Empty line will provide a message as the first item in the bound list -
validation code should handle a value of -1 the the combo is on this element.
|
| BindDataSource(Enum, ListControl) |
Bind a UI control to this DOCollection as a Data Source
Empty line will provide a message as the first item in the bound list -
validation code should handle a value of -1 the the combo is on this element.
|
| BindDataSource(Enum, ListControl, String) |
Bind a UI control to this DOCollection as a Data Source
Empty line will provide a message as the first item in the bound list -
validation code should handle a value of -1 the the combo is on this element.
|
| BindDataSource(Enum, ListControl) |
Bind a UI control to this DOCollection as a Data Source
Empty line will provide a message as the first item in the bound list -
validation code should handle a value of -1 the the combo is on this element.
|
| Count |
Get the number of elements in the collection.
|
| CreateDataSource(Boolean, array<Enum>[]()[]) |
Create a datasource
|
| CreateDataView(Boolean, array<Enum>[]()[]) |
Create a datasource
|
| Delete(SQLBuilder) | Obsolete.
Performs a DELETE
|
| Delete(SQLBuilder, DOTransaction) | Obsolete.
Performs a DELETE
|
| Delete()()() |
Perform a DELETE using the set SQLBuilder which filters the collection
|
| Delete(DOTransaction) |
Perform a DELETE using the set SQLBuilder which filters the collection
|
| Dispose()()() | |
| Fetch()()() |
Perform a Find to populate and prefetch the DOCollection, using the SQLBuilder that has been
previously set in the SetCurrentQuery() method.
|
| FetchAll()()() |
Populate and prefetch the collection by the finding all entries in a table
which matches the subclassed DataObject.
|
| FetchRange(Int32, Int32) |
Populate the DOCollection with a subset of the search results
generated using the set query.
|
| FetchSelected()()() |
Fetches only the selected columns in the query, returning
all matching rows. This allows you to retrieve partially loaded DataObject, instead
of retrieving all columns in the object.
|
| FetchSelected(array<DOSelection>[]()[], Int32, Int32) | |
| FetchSelected(Int32, Int32) |
Fetches only the selected columns in the query, returning
matching rows between the specified index. This allows you to retrieve partially loaded DataObject, instead
of retrieving all columns in the object.
|
| Finalize()()() | (Overrides Object.Finalize()()().) |
| Find(SQLBuilder) | Obsolete.
Performs a find which populates the collection.
|
| Find()()() |
Perform a Find to populate the DOCollection, using the SQLBuilder that has been
previously set in the SetCurrentQuery() method.
|
| FindAll()()() |
Populate (lazy load) the collection by the finding all entries in a table
which matches the subclassed DataObject.
|
| FindByPK(Guid) |
Populate the collection by the finding a record with the specified primary key value.
|
| FindRange(Int32, Int32, SQLBuilder) |
Populate the DOCollection with a subset of the search results
generated using the specified SQLBuilder.
|
| FindRange(Int32, Int32) |
Populate the DOCollection with a subset of the search results,
using the SQLBuilder that has been previously set in the SetCurrentQuery() method
|
| FlushLocalCache()()() |
Explicit refresh of data in the cache. Any request for a dataObject will
force a new database query.
|
| GetCurrentQuery()()() |
Get the current SQLBuilder for this collection.
|
| GetEnumerator()()() | |
| GetNext(Guid, Boolean%, Boolean%) |
Find the next Item in the DOCollection after the Item with the specified UID.
|
| GetPrevious(Guid, Boolean%, Boolean%) |
Find the Item in the DOCollection that precedes the Item with the specified UID.
|
| GetPrimaryKeyIDs()()() |
Get the list of primary key IDs
|
| GetSearchBuilder()()() |
Return a new (empty) instance of a SearchBuilder.
|
| GetSqlBuilder()()() |
Get a new (empty) instance of a SQLBuilder for this DOCollection.
|
| GetUidColumnName()()() |
Get the name of the Primary Key column.
|
| GetValueByName(Int32, Enum) |
Get the value of the column specified in the index.
|
| IndexOf(Guid) |
Return the index of the data object in the collection.
|
| IndexOf(Enum, String) |
Return the index of the data object in the collection.
|
| Item[([(Int32])]) |
Retrieve the DataObject from the collection using the specified index.
|
 | m_objDA | |
| PKExists(Guid) |
Check if the primary key value exists in the database.
|
| ResetCurrentQuery()()() |
Clears the current SQLBuilder, and replaces it with a fresh SQLBuilder.
|
| SetCurrentQuery(SQLBuilder) |
Set the current SQLBuilder for this collection
|
| Sum(DataObject, Enum, DBColumnType) |
Gets the sum of the values in the specified column in the collection, using the current query as a base.
|
| ToArray(Type) |
Copy all dataobjects to an array of DOTOs. The type passed in will
be the type of DOTO which is created and returned.
|
Remarks
This class is designed to be overridden by the
matching DataObject client class Collection to
maintain the specific 'where' clauses which are
extended methods on the object - which call down
to the find passing simply a 'where' clause to
perform the find filter.
Must dispose this object when finished with it.
Inheritance Hierarchy| Object | ||
 | MarshalByRefObject | |
| DOCollection | |