DataAccessAdapterCoreFetchEntity Method (IEntity2, IPrefetchPath2, Context, ExcludeIncludeFieldsList) |
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.1.0.0 (5.1.0)
Syntax public virtual bool FetchEntity(
IEntity2 entityToFetch,
IPrefetchPath2 prefetchPath,
Context contextToUse,
ExcludeIncludeFieldsList excludedIncludedFields
)
Public Overridable Function FetchEntity (
entityToFetch As IEntity2,
prefetchPath As IPrefetchPath2,
contextToUse As Context,
excludedIncludedFields As ExcludeIncludeFieldsList
) 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. - excludedIncludedFields
- Type: SD.LLBLGen.Pro.ORMSupportClassesExcludeIncludeFieldsList
The list of IEntityField2 objects which have to be excluded or included for the fetch.
If null or empty, all fields are fetched (default). If an instance of ExcludeIncludeFieldsList is passed in and its ExcludeContainedFields property
is set to false, the fields contained in excludedIncludedFields are kept in the query, the rest of the fields in the query are excluded.
Return Value
Type:
Booleantrue if the Fetch was succesful, false otherwise
Implements
IDataAccessAdapterFetchEntity(IEntity2, IPrefetchPath2, Context, ExcludeIncludeFieldsList)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