Click or drag to resize

DataAccessAdapterBaseFetchNewEntity Method (IEntityFactory2, IRelationPredicateBucket, IPrefetchPath2, Context, ExcludeIncludeFieldsList)

Fetches a new entity using the filter/relation combination filter passed in via filterBucket and the new entity is created using the passed in entity factory. Use this method when fetching a related entity using a current entity (for example, fetch the related Customer entity of an existing Order entity)

Namespace:  SD.LLBLGen.Pro.ORMSupportClasses
Assembly:  SD.LLBLGen.Pro.ORMSupportClasses (in SD.LLBLGen.Pro.ORMSupportClasses.dll) Version: 5.6.0.0 (5.6.19.0117)
Syntax
public override IEntity2 FetchNewEntity(
	IEntityFactory2 entityFactoryToUse,
	IRelationPredicateBucket filterBucket,
	IPrefetchPath2 prefetchPath,
	Context contextToUse,
	ExcludeIncludeFieldsList excludedIncludedFields
)

Parameters

entityFactoryToUse
Type: SD.LLBLGen.Pro.ORMSupportClassesIEntityFactory2
The factory which will be used to create a new entity object which will be fetched
filterBucket
Type: SD.LLBLGen.Pro.ORMSupportClassesIRelationPredicateBucket
the completely filled in IRelationPredicateBucket object which will be used as a filter for the fetch. The fetch will only load the first entity loaded, even if the filter results into more entities being fetched
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: IEntity2
The new entity fetched, or a previous entity fetched if that entity was in the context specified

Implements

IDataAccessAdapterFetchNewEntity(IEntityFactory2, IRelationPredicateBucket, IPrefetchPath2, Context, ExcludeIncludeFieldsList)
See Also