Click or drag to resize

IEntityObjectsLoadOptions Interface

This interface is implemented by the load options classes for loading entity objects in OIS. Entity objects are entity data and must implement IEntityObject.

Namespace:  Omada.OE.Model
Assembly:  Omada.OE.Model (in Omada.OE.Model.dll) Version: 15.0.0.0
Syntax
C#
public interface IEntityObjectsLoadOptions : IEntityDataLoadOptions

The IEntityObjectsLoadOptions type exposes the following members.

Properties
  NameDescription
Public propertyCacheOptions
Contains options related to data caching.
(Inherited from IEntityDataLoadOptions.)
Public propertyEntityDataType
The type of entity data that the options are used to load data of. Must be one of the constants from the EntityDataVersion class.
(Inherited from IEntityDataLoadOptions.)
Public propertyIdList
Ids-to-be-loaded.
Public propertyResultCompletenessState
Representation of whether all data on each object has been loaded. If any options has been specified that excludes parts of the loaded data on each object then it must be reflected in the value. Should contain a value like e.g. "FULL", "NOPROPERTIES".
Public propertyResultInfo
This is not a load option! After having loaded entity data with the load options object this field contains info of e.g. whether the result was fetched from the cache. The information is mainly for unit test purposes.
(Inherited from IEntityDataLoadOptions.)
Public propertySkipCheckForChanges
If true we will return cached objects without checking if they are still current - that is, if they have been modified after they were cached. This can be ok in certain situations where we want to save the cost of determining if the cached objects have been modified.
Public propertyStoredInTableName
Name of the DB table that the objects reside in. The table must have an ID and ChangeTime columns.
Top
Methods
  NameDescription
Public methodBuildCacheKey
The cache key to be used for storing the results of the query for the entity data. The cache key is built based on the various options in the load options class.
(Inherited from IEntityDataLoadOptions.)
Public methodHasNoCriteria
Returns true if no load options (that is, filtering options) has been specified at all - meaning that all objects will be returned. If any options has been specified that will make the result user-specific (e.g. if security rules are applied) then it must return false. Note that it should not affect the result whether or not it is a full or partial representation of the objects that is being loaded.
Public methodIsResultCachable
Returns if the loaded data is suitable to be cached. Should return false if: - load options are specified which makes it unlikely that the data will ever be fetched again and/or the loaded data set is very large. - loaded data are "personal" - e.g. they reflect user specific security options.
Top
See Also