Share via


EntityValueWithId<TEntity,TPropertiesAvailableStatus> Class

Definition

The base class of entity value implementation generated from the model, when it support Id.

[System.Runtime.CompilerServices.Nullable(0)]
public abstract class EntityValueWithId<TEntity,TPropertiesAvailableStatus> : Microsoft.VisualStudio.ProjectSystem.Query.Framework.EntityValueWithId, Microsoft.VisualStudio.ProjectSystem.Query.IEntityWithId<TEntity> where TPropertiesAvailableStatus : class, IPropertiesAvailableStatus, new()
[<System.Runtime.CompilerServices.Nullable(0)>]
type EntityValueWithId<'Entity, 'PropertiesAvailableStatus (requires 'PropertiesAvailableStatus : null and 'PropertiesAvailableStatus :> IPropertiesAvailableStatus and 'PropertiesAvailableStatus : (new : unit -> 'PropertiesAvailableStatus))> = class
    inherit EntityValueWithId
    interface IEntityWithId<'Entity>
    interface IEntityWithId
    interface IEntity
Public MustInherit Class EntityValueWithId(Of TEntity, TPropertiesAvailableStatus)
Inherits EntityValueWithId
Implements IEntityWithId(Of TEntity)

Type Parameters

TEntity

The type of the entity item.

TPropertiesAvailableStatus

A strong type to check whether a property value is available.

Inheritance
EntityValueWithId<TEntity,TPropertiesAvailableStatus>
Derived
Attributes
Implements

Constructors

EntityValueWithId<TEntity,TPropertiesAvailableStatus>(IEntityRuntimeModel, EntityIdentity, TPropertiesAvailableStatus)

Initializes a new instance of the EntityValueWithId<TEntity,TPropertiesAvailableStatus> class.

EntityValueWithId<TEntity,TPropertiesAvailableStatus>(IEntityRuntimeModel)

Initializes a new instance of the EntityValueWithId<TEntity,TPropertiesAvailableStatus> class. Only used to create an instance in the deserialization time.

Properties

EntityRuntime (Inherited from EntityValueBase)
Id (Inherited from EntityValueWithId)
IsFrozen

Gets whether the object is immutable. Once the entity values are initialized, it will be frozen and become immutable.

(Inherited from EntityValueBase)
PropertiesAvailableStatus

Gets the property available status of this entity.

SelfQuery

Gets a base query to query information under this entity.

Site

Gets the site of the entity. (It is a part of infrastructure to attach additional collections to it.

(Inherited from EntityValueBase)

Methods

AsQueryable()
ConvertChildrenCollection<TChildType>(IEnumerable<IEntityValue>)

Converts a generic children collection to a specific collection.

(Inherited from EntityValueBase)
EnsureMutable()

Check and throw, if the object is set to readonly.

(Inherited from EntityValueBase)
EnsurePropertyMarkedAsAvailable(IEntityProperty)

Ensures the property is marked as available.

(Inherited from EntityValueBase)
Freeze()

Freeze the entity value object, so it cannot be changed.

(Inherited from EntityValueBase)
GetEntityType() (Inherited from EntityValueBase)
GetPropertiesAvailableStatus(Boolean)
ReadProperty(String, JsonReader) (Inherited from EntityValueWithId)
SetRelatedEntities(String, IEnumerable<IEntityValue>)

Sets related entities. This method is used by query engine to fill data.

(Inherited from EntityValueBase)
ToString() (Inherited from EntityValueWithId)
TryGetRelatedEntities(String, IEnumerable<IEntity>)

Try to get related entities saved through earlier SetRelatedEntities(String, IEnumerable<IEntityValue>).

(Inherited from EntityValueBase)

Explicit Interface Implementations

IEntity.PropertiesAvailableStatus (Inherited from EntityValueBase)
IEntityValue.LimitAvailableProperties(IPropertiesAvailableStatus) (Inherited from EntityValueBase)
IEntityValue.SetRelatedEntities(String, IReadOnlyCollection<IEntityValue>) (Inherited from EntityValueBase)
IEntityValue.SetSite(IEntitySite) (Inherited from EntityValueBase)
IEntityValue.TryGetRelatedEntities(String, IEnumerable<IEntityValue>) (Inherited from EntityValueBase)
IEntityValueFromProvider.ProviderState (Inherited from EntityValueBase)
IFreezable.IsFrozen (Inherited from EntityValueBase)

Applies to