IDataAccessAdapterFetchEntity Method (IEntity2, IPrefetchPath2, Context) |
Fetches an entity from the persistent storage into the passed in Entity2 object using a primary key filter. The primary key fields of
the entity passed in have to have the primary key values. (Example: CustomerID has to have a value, when you want to fetch a CustomerEntity
from the persistent storage into the passed in object)
Namespace:
SD.LLBLGen.Pro.ORMSupportClasses
Assembly:
SD.LLBLGen.Pro.ORMSupportClasses (in SD.LLBLGen.Pro.ORMSupportClasses.dll) Version: 5.4.0.0 (5.4.0)
Syntax bool FetchEntity(
IEntity2 entityToFetch,
IPrefetchPath2 prefetchPath,
Context contextToUse
)
Function FetchEntity (
entityToFetch As IEntity2,
prefetchPath As IPrefetchPath2,
contextToUse As Context
) As Boolean
Parameters
- entityToFetch
- Type: SD.LLBLGen.Pro.ORMSupportClassesIEntity2
The entity object in which the fetched entity data will be stored. The primary key fields have to have a value. - prefetchPath
- Type: SD.LLBLGen.Pro.ORMSupportClassesIPrefetchPath2
The prefetch path to use for this fetch, which will fetch all related entities defined by the path as well. - contextToUse
- Type: SD.LLBLGen.Pro.ORMSupportClassesContext
The context to add the entity to if the fetch was succesful, and before the prefetch path is fetched. This ensures
that the prefetch path is fetched using the context specified and will re-use already loaded entity objects.
Return Value
Type:
Booleantrue if the Fetch was succesful, false otherwise
Remarks Will use a current transaction if a transaction is in progress, so MVCC or other concurrency scheme used by the database can be utilized
See Also