 | RepositoryReadOnlyTInitializeSubEntities Method |
Populates any of the sub-entities of the passed top-level entity that were not already populated by Ignition's auto-population mechanisms.
Namespace: Ignition.Framework.RepositoriesAssembly: CatalystFire.Ignition (in CatalystFire.Ignition.dll) Version: 12.0.28229
Syntaxprotected virtual void InitializeSubEntities(
T topLevelEntity
)
Protected Overridable Sub InitializeSubEntities (
topLevelEntity As T
)
protected:
virtual void InitializeSubEntities(
T topLevelEntity
)
abstract InitializeSubEntities :
topLevelEntity : 'T -> unit
override InitializeSubEntities :
topLevelEntity : 'T -> unit Parameters
- topLevelEntity T
- The top-level entity whose sub-entities should be populated
Remarks
Notes for Inheritors
This method is called once per top-level entity that the repository retrieves. Note that this means
that if a large number of entities are retrieved at once (via a
GetAll(GetAllOptions) call for example)
this method will be called many times in quick succession.
If top-level caching is enabled, it will occur after this method is called so that the cached
entity is already populated with sub-entities.
For any sub-entity collections pulled manually, this method should honor the settings defined in the
Settings field's
SubEntityFetchPlan property with regard to how it retrieves sub-entities used for population.
If you make use of any ValueTypeProvider instances for managing your value types, you should also override
ClearAuxiliaryCaches
in order to clear the caches of those providers upon request.
See Also