Class EntityBase

EntityBase(IMClient, EntityConstructionArgs)

Initializes a new instance of the EntityBase class.

protected EntityBase(IMClient client, EntityConstructionArgs args)

Client

Gets the client.

protected IMClient Client { get; }

CreatedBy

Gets the id of the user who created this resource. null if it has not been created.

public long? CreatedBy { get; set; }

CreatedOn

Gets the date on which this resource was created. null if it has not been created.

public DateTime? CreatedOn { get; set; }

Cultures

Gets a list of all cultures that the entity was loaded with. Never returns null. All ICultureSensitiveProperty properties can only contains values for these cultures.

public IReadOnlyList<CultureInfo> Cultures { get; }

DefinitionName

Gets the name of the IEntityDefinition that defines this entity.

public string DefinitionName { get; set; }

Id

Gets the id of the entity. The id is an automatically assigned, read only, unique and strictly positive number identifying the entity. The id is null if the entity has not been persisted yet.

public long? Id { get; set; }

Identifier

Gets or sets the identifier of the entity. The identifier can be set on a new entities, until it is persisted. However, it must always be unique. The identifier will be auto generated when it is null when persisting.

public string Identifier { get; set; }

InheritsSecurity

Gets or sets a value indicating whether the entity inherits security from its ancestors connected via relations with InheritsSecurity.

public bool InheritsSecurity { get; set; }

IsDirty

Gets a value indicating whether the object has unsaved changes.

public bool IsDirty { get; }

IsNew

Gets a value indicating whether the entity is new (id is null).

public bool IsNew { get; }

IsPathRoot

Gets or sets a value indicating whether this entity is a top level path.

public bool IsPathRoot { get; set; }

IsRootTaxonomyItem

Gets or sets a value indicating whether this entity is a top level facet.

public bool IsRootTaxonomyItem { get; set; }

IsSystemOwned

Gets or sets a value indicating whether the entity is owned by the system and cannot be modified or deleted by the regular users.

public bool IsSystemOwned { get; set; }

IsTracking

Gets a value indicating whether the object is tracking changes.

public bool IsTracking { get; }

LockedBy

Gets the id of the user who locked this entity. null if it has not been locked.

public long? LockedBy { get; set; }

LockedOn

Gets the date on which this entity was locked. null if it has not been locked.

public DateTime? LockedOn { get; set; }

ModifiedBy

Gets the id of the user who modified this resource. null if it has not been created.

public long? ModifiedBy { get; set; }

ModifiedOn

Gets the date on which this resource was modified. null if it has not been created.

public DateTime? ModifiedOn { get; set; }

Properties

Gets a list of all properties that are currently loaded on the entity. Never returns null.

public IReadOnlyList<IProperty> Properties { get; }

RelatedPaths

Gets a list of all related paths for this entity.

public abstract IReadOnlyList<IRelatedPath> RelatedPaths { get; }

Relations

Gets a list of all relations that are currently loaded on the entity. Never returns null.

public IReadOnlyList<IRelation> Relations { get; }

Renditions

Gets a list of all renditions for this entity. Never returns null.

public abstract IReadOnlyList<IRendition> Renditions { get; }

Version

Gets the current version of the entity. Version is a monotonically increasing number (from 1 up). Any change(s) of the entity propagated to the persistent storage will cause this number to be incremented.

public long Version { get; set; }

CanDoLazyLoading()

Checks if lazy loading is possible. Lazy loading is only possible on persisted entities.

public bool CanDoLazyLoading()

GetEntityDefinitionAsync()

Gets the IEntityDefinition of the entity. It is loaded once and will cache the result.

public Task<IEntityDefinition> GetEntityDefinitionAsync()

GetPermissionsAsync()

Gets the permissions that the current user has on this entity.

public abstract Task<ISet<string>> GetPermissionsAsync()

GetProperty(string)

Gets the specified property. Returns null when the property is not found.

public IProperty GetProperty(string name)

GetProperty(string)

Gets the specified property. Returns null when the property is not found.

public T GetProperty<T>(string name) where T : class, IProperty

GetPropertyAsync(string, MemberLoadOption)

Gets the specified property. Returns null when the property is not found. However, if the property is not present, it can be lazy loaded.

public Task<IProperty> GetPropertyAsync(string name, MemberLoadOption loadOption = MemberLoadOption.LazyLoading)

GetPropertyAsync(string, MemberLoadOption)

Gets the specified property. Returns null when the property is not found. However, if the property is not present, it can be lazy loaded.

public Task<T> GetPropertyAsync<T>(string name, MemberLoadOption loadOption = MemberLoadOption.LazyLoading) where T : class, IProperty

GetPropertyValue(string, CultureInfo)

Gets the value of the specified culture sensitive property. Returns null when the property is not found.

public object GetPropertyValue(string name, CultureInfo culture)

GetPropertyValue(string)

Gets the value of the specified culture insensitive property. Returns null when the property is not found.

public object GetPropertyValue(string name)

GetPropertyValue(string, CultureInfo)

Gets the value of the specified culture sensitive property and casts it to the corresponding type. Returns null when the property is not found.

public T GetPropertyValue<T>(string name, CultureInfo culture)

GetPropertyValue(string)

Gets the value of the specified culture insensitive property and casts it to the corresponding type. Returns null when the property is not found.

public T GetPropertyValue<T>(string name)

GetPropertyValueAsync(string, CultureInfo, MemberLoadOption)

Gets a property value.

public Task<object> GetPropertyValueAsync(string name, CultureInfo culture, MemberLoadOption loadOption = MemberLoadOption.LazyLoading)

GetPropertyValueAsync(string, MemberLoadOption)

Gets the value of the specified culture insensitive property and casts it to the corresponding type. If the property is not present, it can be lazy loaded.

public Task<object> GetPropertyValueAsync(string name, MemberLoadOption loadOption = MemberLoadOption.LazyLoading)

GetPropertyValueAsync(string, CultureInfo, MemberLoadOption)

Gets the value of the specified culture sensitive property and converts it to the corresponding type. If the property is not present, it can be lazy loaded.

public Task<T> GetPropertyValueAsync<T>(string name, CultureInfo culture, MemberLoadOption loadOption = MemberLoadOption.LazyLoading)

GetPropertyValueAsync(string, MemberLoadOption)

Gets the value of the specified culture insensitive property and casts it to the corresponding type. If the property is not present, it can be lazy loaded.

public Task<T> GetPropertyValueAsync<T>(string name, MemberLoadOption loadOption = MemberLoadOption.LazyLoading)

GetRelation(string, RelationRole?)

Gets a relation by name. Returns null when the relation was not found.

public IRelation GetRelation(string name, RelationRole? role = null)

GetRelation(string)

Gets a relation by name and tries to resolve the role automatically by the specified interface. Returns null when the relation was not found.

public T GetRelation<T>(string name) where T : class, IRelation

GetRelationAsync(string, RelationRole?, MemberLoadOption)

Gets the relation from the entity. Returns null when the relation was not found. However, when the relation is not present, it can be lazy loaded.

public Task<IRelation> GetRelationAsync(string name, RelationRole? role = null, MemberLoadOption loadOption = MemberLoadOption.LazyLoading)

GetRelationAsync(string, MemberLoadOption)

Gets a relation by name and tries to resolve the role automatically by the specified interface. Returns null when the relation was not found. If the relation is not present, it can be lazy loaded.

public Task<T> GetRelationAsync<T>(string name, MemberLoadOption loadOption = MemberLoadOption.LazyLoading) where T : class, IRelation

GetRendition(string)

Gets an IRendition by name.

public abstract IRendition GetRendition(string name)

LoadMembersAsync(IPropertyLoadOption, IRelationLoadOption)

Loads the specified members on the current entity. It will only load if it is actually missing members and does not overwrite existing members.

public Task<bool> LoadMembersAsync(IPropertyLoadOption propertyLoadOption, IRelationLoadOption relationLoadOption)

LoadPropertiesAsync(IPropertyLoadOption)

Loads the specified properties on the current entity. It will only load if it is actually missing properties and does not overwrite existing properties.

public Task<bool> LoadPropertiesAsync(IPropertyLoadOption propertyLoadOption)

LoadRelationsAsync(IRelationLoadOption)

Loads the specified relations on the current entity. It will only load if it is actually missing relations and does not overwrite existing relations.

public Task<bool> LoadRelationsAsync(IRelationLoadOption relationLoadOption)

MarkClean()

Marks the object as clean. This will set IsDirty to false.

public void MarkClean()

SetPropertyValue(string, CultureInfo, object)

Sets the value of specified culture sensitive property.

public void SetPropertyValue(string name, CultureInfo culture, object value)

SetPropertyValue(string, object)

Sets the value of specified culture insensitive property.

public void SetPropertyValue(string name, object value)

StartTracking()

Starts tracking the object for changes.

public void StartTracking()

Implements

IEntity

IResource

IDirtyTracking