Skip to content
Documentation

IAttributeStore Interface

Used to find, load, save or delete IAttributes. Should only be instantiated by an IAttributeStoreFactory.

public interface IAttributeStore : HAKOM.Persistence.Core.Net.Api.Storage.IStore<HAKOM.Persistence.Core.Net.Api.Storage.IStorageProvider>

Derived
↳ IAttributeStore<TIdentifier>

Implements HAKOM.Persistence.Core.Net.Api.Storage.IStore<IStorageProvider>

Gets the IAttributeSearchParametersFactory for creating new search parameters.

HAKOM.TSM.Net.Api.Attributes.Persistence.IAttributeSearchParametersFactory SearchParameters { get; }

IAttributeSearchParametersFactory

IAttributeStore.Delete(IAttributeReference, bool, CancellationToken) Method

Section titled “IAttributeStore.Delete(IAttributeReference, bool, CancellationToken) Method”

Deletes the IAttribute referred to by the given attributeReference from the repository.

If force is true, all assignments with this attribute will be deleted (cascade delete).
If force is false and assignments exist, the result will contain an error listing the assignments.

System.Threading.Tasks.Task Delete(HAKOM.TSM.Net.Api.Attributes.Persistence.References.IAttributeReference attributeReference, bool force=false, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));

attributeReference IAttributeReference

An IAttributeReference to the IAttribute which will be deleted.

force System.Boolean

If true, deletes all assignments with this attribute. If false, throws if assignments exist. Default is false.

cancellationToken System.Threading.CancellationToken

A token that may be used to cancel the operation.

System.Threading.Tasks.Task
A System.Threading.Tasks.Task indicating that the process is finished.

IAttributeStore.Delete(string, bool, CancellationToken) Method

Section titled “IAttributeStore.Delete(string, bool, CancellationToken) Method”

Deletes the IAttribute with the given name from the repository.

If force is true, all assignments with this attribute will be deleted (cascade delete).
If force is false and assignments exist, the result will contain an error listing the assignments.

System.Threading.Tasks.Task Delete(string name, bool force=false, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));

name System.String

The name of the attribute which will be deleted.

force System.Boolean

If true, deletes all assignments with this attribute. If false, throws if assignments exist. Default is false.

cancellationToken System.Threading.CancellationToken

A token that may be used to cancel the operation.

System.Threading.Tasks.Task
A System.Threading.Tasks.Task indicating that the process is finished.

IAttributeStore.Find(IAttributeSearchParameters, Range<IAttribute>, IEnumerable<Order<IAttribute>>, CancellationToken) Method

Section titled “IAttributeStore.Find(IAttributeSearchParameters, Range<IAttribute>, IEnumerable<Order<IAttribute>>, CancellationToken) Method”

Finds IAttribute objects by the given IAttributeSearchParameters.

System.Collections.Generic.IAsyncEnumerable<HAKOM.TSM.Net.Api.Attributes.Persistence.References.IAttributeReference> Find(HAKOM.TSM.Net.Api.Attributes.Persistence.IAttributeSearchParameters? searchParameters=null, HAKOM.Persistence.Core.Net.Api.Paging.Range<HAKOM.TSM.Net.Api.Attributes.IAttribute> range=default(HAKOM.Persistence.Core.Net.Api.Paging.Range<HAKOM.TSM.Net.Api.Attributes.IAttribute>), System.Collections.Generic.IEnumerable<HAKOM.Persistence.Core.Net.Api.Ordering.Order<HAKOM.TSM.Net.Api.Attributes.IAttribute>>? orderings=null, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));

searchParameters IAttributeSearchParameters

The IAttributeSearchParameters by which the search will be filtered.

range HAKOM.Persistence.Core.Net.Api.Paging.Range<IAttribute>

An optional System.Range by which the results should be limited.

orderings System.Collections.Generic.IEnumerable<HAKOM.Persistence.Core.Net.Api.Ordering.Order<IAttribute>>

A collection of Order<TResult> by which the results will be ordered.

cancellationToken System.Threading.CancellationToken

A token that may be used to cancel the operation.

System.Collections.Generic.IAsyncEnumerable<IAttributeReference>
An System.Collections.Generic.IAsyncEnumerable<>.

Removes consecutive duplicate orderings, retaining only the last specified Direction for each.

IAttributeStore.FindByNames(IEnumerable<string>, CancellationToken) Method

Section titled “IAttributeStore.FindByNames(IEnumerable<string>, CancellationToken) Method”

Finds groups of IAttributes by the given names. The names may contain wildcards, so each name may find multiple attributes. Each group contains an System.Collections.Generic.IEnumerable<> to the attributes, that were found with one name. That name is then used as the key to the group.

System.Collections.Generic.IAsyncEnumerable<System.Collections.Generic.KeyValuePair<string,System.Collections.Generic.IEnumerable<HAKOM.TSM.Net.Api.Attributes.Persistence.References.IAttributeReference>>> FindByNames(System.Collections.Generic.IEnumerable<string> names, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));

names System.Collections.Generic.IEnumerable<System.String>

The System.String names, which will be used in the search.

cancellationToken System.Threading.CancellationToken

A token that may be used to cancel the operation.

System.Collections.Generic.IAsyncEnumerable<System.Collections.Generic.KeyValuePair<System.String,System.Collections.Generic.IEnumerable<IAttributeReference>>>
An System.Collections.Generic.IAsyncEnumerable<> where the key of each entry is the System.String name used to find the IAttributeReferences which are in the value.

The results will contain unique keys.

IAttributeStore.Load(IAttributeReference, CancellationToken) Method

Section titled “IAttributeStore.Load(IAttributeReference, CancellationToken) Method”

Uses the given attributeReference to load the IAttribute it refers to.

System.Threading.Tasks.Task<HAKOM.TSM.Net.Api.Attributes.Persistence.References.IAttributeReference> Load(HAKOM.TSM.Net.Api.Attributes.Persistence.References.IAttributeReference attributeReference, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));

attributeReference IAttributeReference

The reference to the IAttribute which will be loaded.

cancellationToken System.Threading.CancellationToken

A token that may be used to cancel the operation.

System.Threading.Tasks.Task<IAttributeReference>
A System.Threading.Tasks.Task<> containing a reference to the desired attribute.

IAttributeStore.Load(string, CancellationToken) Method

Section titled “IAttributeStore.Load(string, CancellationToken) Method”

Loads a single IAttribute from storage, if one with the given name exists.

System.Threading.Tasks.Task<HAKOM.TSM.Net.Api.Attributes.Persistence.References.IAttributeReference> Load(string name, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));

name System.String

The unique name of the attribute.

cancellationToken System.Threading.CancellationToken

A token that may be used to cancel the operation.

System.Threading.Tasks.Task<IAttributeReference>
A System.Threading.Tasks.Task<> containing a reference to the desired attribute.

IAttributeStore.Save(IAttribute, CancellationToken) Method

Section titled “IAttributeStore.Save(IAttribute, CancellationToken) Method”

Persists the given IAttribute to the repository.

System.Threading.Tasks.Task<HAKOM.TSM.Net.Api.Attributes.Persistence.References.IAttributeReference> Save(HAKOM.TSM.Net.Api.Attributes.IAttribute attribute, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));

attribute IAttribute

The attribute which will be persisted.

cancellationToken System.Threading.CancellationToken

A token that may be used to cancel the operation.

System.Threading.Tasks.Task<IAttributeReference>
A System.Threading.Tasks.Task<> containing a reference to the persisted attribute.

IAttributeStore.SaveOrUpdate(IAttribute, CancellationToken) Method

Section titled “IAttributeStore.SaveOrUpdate(IAttribute, CancellationToken) Method”

Persists the given IAttribute to the repository or updates it, if it already exists.

System.Threading.Tasks.Task<HAKOM.TSM.Net.Api.Attributes.Persistence.References.IAttributeReference> SaveOrUpdate(HAKOM.TSM.Net.Api.Attributes.IAttribute attribute, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));

attribute IAttribute

The attribute which will be persisted.

cancellationToken System.Threading.CancellationToken

A token that may be used to cancel the operation.

System.Threading.Tasks.Task<IAttributeReference>
A System.Threading.Tasks.Task<> containing a reference to the persisted attribute.

IAttributeStore.TryDelete(IAttributeReference, bool, CancellationToken) Method

Section titled “IAttributeStore.TryDelete(IAttributeReference, bool, CancellationToken) Method”

Attempts to delete the IAttribute referred to by the given attributeReference from the repository.

If force is true, all assignments with this attribute will be deleted (cascade delete).
If force is false and assignments exist, the result will contain an error listing the assignments.

System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result> TryDelete(HAKOM.TSM.Net.Api.Attributes.Persistence.References.IAttributeReference attributeReference, bool force=false, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));

attributeReference IAttributeReference

An IAttributeReference to the IAttribute which will be deleted.

force System.Boolean

If true, deletes all assignments with this attribute. If false, fails if assignments exist. Default is false.

cancellationToken System.Threading.CancellationToken

A token that may be used to cancel the operation.

System.Threading.Tasks.Task<Result>
A System.Threading.Tasks.Task<> indicating that the process is finished.

The Result contains an error, when the operation fails.

IAttributeStore.TryDelete(string, bool, CancellationToken) Method

Section titled “IAttributeStore.TryDelete(string, bool, CancellationToken) Method”

Attempts to delete the IAttribute with the given name from the repository.

If force is true, all assignments with this attribute will be deleted (cascade delete).
If force is false and assignments exist, the result will contain an error listing the assignments.

System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result> TryDelete(string name, bool force=false, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));

name System.String

The name of the attribute which will be deleted.

force System.Boolean

cancellationToken System.Threading.CancellationToken

A token that may be used to cancel the operation.

System.Threading.Tasks.Task<Result>
A System.Threading.Tasks.Task<> indicating that the process is finished.

The Result contains an error, when the operation fails.

IAttributeStore.TryFind(IAttributeSearchParameters, Range<IAttribute>, IEnumerable<Order<IAttribute>>, CancellationToken) Method

Section titled “IAttributeStore.TryFind(IAttributeSearchParameters, Range<IAttribute>, IEnumerable<Order<IAttribute>>, CancellationToken) Method”

Finds IAttribute objects by the given IAttributeSearchParameters.

System.Collections.Generic.IAsyncEnumerable<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.Attributes.Persistence.References.IAttributeReference>> TryFind(HAKOM.TSM.Net.Api.Attributes.Persistence.IAttributeSearchParameters? searchParameters=null, HAKOM.Persistence.Core.Net.Api.Paging.Range<HAKOM.TSM.Net.Api.Attributes.IAttribute> range=default(HAKOM.Persistence.Core.Net.Api.Paging.Range<HAKOM.TSM.Net.Api.Attributes.IAttribute>), System.Collections.Generic.IEnumerable<HAKOM.Persistence.Core.Net.Api.Ordering.Order<HAKOM.TSM.Net.Api.Attributes.IAttribute>>? orderings=null, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));

searchParameters IAttributeSearchParameters

The IAttributeSearchParameters by which the search will be filtered.

range HAKOM.Persistence.Core.Net.Api.Paging.Range<IAttribute>

An optional System.Range by which the results should be limited.

orderings System.Collections.Generic.IEnumerable<HAKOM.Persistence.Core.Net.Api.Ordering.Order<IAttribute>>

A collection of Order<TResult> by which the results will be ordered.

cancellationToken System.Threading.CancellationToken

A token that may be used to cancel the operation.

System.Collections.Generic.IAsyncEnumerable<HAKOM.ErrorHandling.Core.Net.Api.Result<IAttributeReference>>
An System.Collections.Generic.IAsyncEnumerable<> of Result<TValue>.

Removes consecutive duplicate orderings, retaining only the last specified Direction for each.

IAttributeStore.TryFindByNames(IEnumerable<string>, CancellationToken) Method

Section titled “IAttributeStore.TryFindByNames(IEnumerable<string>, CancellationToken) Method”

Attempts to find groups of IAttributes by the given names. The names may contain wildcards, so each name may find multiple attributes. Each group contains an System.Collections.Generic.IEnumerable<> to the attributes, that were found with one name. That name is then used as the key to the group.

System.Collections.Generic.IAsyncEnumerable<HAKOM.ErrorHandling.Core.Net.Api.Result<System.Collections.Generic.KeyValuePair<string,System.Collections.Generic.IEnumerable<HAKOM.TSM.Net.Api.Attributes.Persistence.References.IAttributeReference>>>> TryFindByNames(System.Collections.Generic.IEnumerable<string> names, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));

names System.Collections.Generic.IEnumerable<System.String>

The System.String names, which will be used in the search.

cancellationToken System.Threading.CancellationToken

A token that may be used to cancel the operation.

System.Collections.Generic.IAsyncEnumerable<HAKOM.ErrorHandling.Core.Net.Api.Result<System.Collections.Generic.KeyValuePair<System.String,System.Collections.Generic.IEnumerable<IAttributeReference>>>>
An System.Collections.Generic.IAsyncEnumerable<> which contains a Result<TValue> with information about success or failure.

On success the Result<TValue> will contain a System.Collections.Generic.KeyValuePair where the key is the System.String name used to find the IAttributeReferences which are in the values.

The results will contain unique keys.

IAttributeStore.TryLoad(IAttributeReference, CancellationToken) Method

Section titled “IAttributeStore.TryLoad(IAttributeReference, CancellationToken) Method”

Attempts to use the given attributeReference to load the IAttribute it refers to.

System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.Attributes.Persistence.References.IAttributeReference>> TryLoad(HAKOM.TSM.Net.Api.Attributes.Persistence.References.IAttributeReference attributeReference, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));

attributeReference IAttributeReference

The reference to the IAttribute which will be loaded.

cancellationToken System.Threading.CancellationToken

A token that may be used to cancel the operation.

System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<IAttributeReference>>
A System.Threading.Tasks.Task<> of Result<TValue> containing a reference to the desired attribute.

IAttributeStore.TryLoad(string, CancellationToken) Method

Section titled “IAttributeStore.TryLoad(string, CancellationToken) Method”

Attempts to load a single IAttribute from storage, if one with the given name exists.

System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.Attributes.Persistence.References.IAttributeReference>> TryLoad(string name, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));

name System.String

The unique name of the attribute.

cancellationToken System.Threading.CancellationToken

A token that may be used to cancel the operation.

System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<IAttributeReference>>
A System.Threading.Tasks.Task<> of Result<TValue> containing a reference to the desired attribute.

IAttributeStore.TrySave(IAttribute, CancellationToken) Method

Section titled “IAttributeStore.TrySave(IAttribute, CancellationToken) Method”

Attempts to persist the given IAttribute to the repository.

System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.Attributes.Persistence.References.IAttributeReference>> TrySave(HAKOM.TSM.Net.Api.Attributes.IAttribute attribute, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));

attribute IAttribute

The attribute which will be persisted.

cancellationToken System.Threading.CancellationToken

A token that may be used to cancel the operation.

System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<IAttributeReference>>
A System.Threading.Tasks.Task<> of Result<TValue> containing a reference to the persisted attribute.

IAttributeStore.TrySaveOrUpdate(IAttribute, CancellationToken) Method

Section titled “IAttributeStore.TrySaveOrUpdate(IAttribute, CancellationToken) Method”

Attempts to persist the given IAttribute to the repository or updates it, if it already exists.

System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.Attributes.Persistence.References.IAttributeReference>> TrySaveOrUpdate(HAKOM.TSM.Net.Api.Attributes.IAttribute attribute, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));

attribute IAttribute

The attribute which will be persisted.

cancellationToken System.Threading.CancellationToken

A token that may be used to cancel the operation.

System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<IAttributeReference>>
A System.Threading.Tasks.Task<> of Result<TValue> containing a reference to the persisted attribute.

© 2026 Volue.Version v0.6.38017 November 2026