INodeStore Interface
HAKOM.TSM.Net.Api.Attributes.Nodes.Persistence
Section titled “HAKOM.TSM.Net.Api.Attributes.Nodes.Persistence”Used to find, load, save or delete INodes. Should only be instantiated by an INodeStoreFactory.
public interface INodeStore : HAKOM.Persistence.Core.Net.Api.Storage.IStore<HAKOM.Persistence.Core.Net.Api.Storage.IStorageProvider>Derived
↳ INodeStore<TIdentifier>
Implements HAKOM.Persistence.Core.Net.Api.Storage.IStore<IStorageProvider>
Properties
Section titled “Properties”INodeStore.SearchParameters Property
Section titled “INodeStore.SearchParameters Property”Gets the INodeSearchParametersFactory for creating new search parameters.
HAKOM.TSM.Net.Api.Attributes.Nodes.Persistence.INodeSearchParametersFactory SearchParameters { get; }Property Value
Section titled “Property Value”Methods
Section titled “Methods”INodeStore.Delete(IAttributeReference, CancellationToken) Method
Section titled “INodeStore.Delete(IAttributeReference, CancellationToken) Method”Deletes all INode with the given rootReference from the repository.
System.Threading.Tasks.Task Delete(HAKOM.TSM.Net.Api.Attributes.Persistence.References.IAttributeReference rootReference, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”rootReference IAttributeReference
The root of the nodes which will be deleted.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task
A System.Threading.Tasks.Task indicating that the process is finished.
INodeStore.Find(INodeSearchParameters, Range<INode>, IEnumerable<Order<INode>>, CancellationToken) Method
Section titled “INodeStore.Find(INodeSearchParameters, Range<INode>, IEnumerable<Order<INode>>, CancellationToken) Method”Finds INode objects by the given INodeSearchParameters.
System.Collections.Generic.IAsyncEnumerable<HAKOM.TSM.Net.Api.Attributes.Nodes.Persistence.References.INodeReference> Find(HAKOM.TSM.Net.Api.Attributes.Nodes.Persistence.INodeSearchParameters? searchParameters=null, HAKOM.Persistence.Core.Net.Api.Paging.Range<HAKOM.TSM.Net.Api.Attributes.Nodes.INode> range=default(HAKOM.Persistence.Core.Net.Api.Paging.Range<HAKOM.TSM.Net.Api.Attributes.Nodes.INode>), System.Collections.Generic.IEnumerable<HAKOM.Persistence.Core.Net.Api.Ordering.Order<HAKOM.TSM.Net.Api.Attributes.Nodes.INode>>? orderings=null, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”searchParameters INodeSearchParameters
The INodeSearchParameters by which the search will be filtered.
range HAKOM.Persistence.Core.Net.Api.Paging.Range<INode>
An optional System.Range by which the results should be limited.
orderings System.Collections.Generic.IEnumerable<HAKOM.Persistence.Core.Net.Api.Ordering.Order<INode>>
A collection of Order<TResult> by which the results will be ordered.
cancellationToken System.Threading.CancellationToken
Returns
Section titled “Returns”System.Collections.Generic.IAsyncEnumerable<INodeReference>
An System.Collections.Generic.IAsyncEnumerable<>.
Remarks
Section titled “Remarks”Removes consecutive duplicate orderings, retaining only the last specified Direction for each.
INodeStore.Load(INodeReference, CancellationToken) Method
Section titled “INodeStore.Load(INodeReference, CancellationToken) Method”Uses the given reference to load the INode it refers to.
System.Threading.Tasks.Task<HAKOM.TSM.Net.Api.Attributes.Nodes.Persistence.References.INodeReference> Load(HAKOM.TSM.Net.Api.Attributes.Nodes.Persistence.References.INodeReference reference, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”reference INodeReference
The reference to the INodeReference of the node to be loaded.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<INodeReference>
A System.Threading.Tasks.Task<> containing a reference to the desired node.
INodeStore.Load(IAttributeReference, INodeReference, string, CancellationToken) Method
Section titled “INodeStore.Load(IAttributeReference, INodeReference, string, CancellationToken) Method”Uses the given parameters to load the INode it refers to.
System.Threading.Tasks.Task<HAKOM.TSM.Net.Api.Attributes.Nodes.Persistence.References.INodeReference> Load(HAKOM.TSM.Net.Api.Attributes.Persistence.References.IAttributeReference rootReference, HAKOM.TSM.Net.Api.Attributes.Nodes.Persistence.References.INodeReference? parentReference, string name, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”rootReference IAttributeReference
The reference to the IAttributeReference which is the root of the node to be loaded.
parentReference INodeReference
The reference to the parent of the INode which will be loaded.
name System.String
The name of the node which will be loaded.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<INodeReference>
A System.Threading.Tasks.Task<> containing a reference to the desired node.
INodeStore.Save(INode, CancellationToken) Method
Section titled “INodeStore.Save(INode, CancellationToken) Method”Persists the given INode to the repository.
System.Threading.Tasks.Task<HAKOM.TSM.Net.Api.Attributes.Nodes.Persistence.References.INodeReference> Save(HAKOM.TSM.Net.Api.Attributes.Nodes.INode node, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”node INode
The node which will be persisted.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<INodeReference>
A System.Threading.Tasks.Task<> containing a reference to the persisted node.
INodeStore.TryDelete(IAttributeReference, CancellationToken) Method
Section titled “INodeStore.TryDelete(IAttributeReference, CancellationToken) Method”Attempts to delete the INode with the given rootReference from the repository.
System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result> TryDelete(HAKOM.TSM.Net.Api.Attributes.Persistence.References.IAttributeReference rootReference, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”rootReference IAttributeReference
The root of the nodes which will be deleted.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<Result>
A System.Threading.Tasks.Task<> indicating that the process is finished.
Remarks
Section titled “Remarks”The Result contains an error, when the operation fails.
INodeStore.TryFind(INodeSearchParameters, Range<INode>, IEnumerable<Order<INode>>, CancellationToken) Method
Section titled “INodeStore.TryFind(INodeSearchParameters, Range<INode>, IEnumerable<Order<INode>>, CancellationToken) Method”Finds INode objects by the given INodeSearchParameters.
System.Collections.Generic.IAsyncEnumerable<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.Attributes.Nodes.Persistence.References.INodeReference>> TryFind(HAKOM.TSM.Net.Api.Attributes.Nodes.Persistence.INodeSearchParameters? searchParameters=null, HAKOM.Persistence.Core.Net.Api.Paging.Range<HAKOM.TSM.Net.Api.Attributes.Nodes.INode> range=default(HAKOM.Persistence.Core.Net.Api.Paging.Range<HAKOM.TSM.Net.Api.Attributes.Nodes.INode>), System.Collections.Generic.IEnumerable<HAKOM.Persistence.Core.Net.Api.Ordering.Order<HAKOM.TSM.Net.Api.Attributes.Nodes.INode>>? orderings=null, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”searchParameters INodeSearchParameters
The INodeSearchParameters by which the search will be filtered.
range HAKOM.Persistence.Core.Net.Api.Paging.Range<INode>
An optional System.Range by which the results should be limited.
orderings System.Collections.Generic.IEnumerable<HAKOM.Persistence.Core.Net.Api.Ordering.Order<INode>>
A collection of Order<TResult> by which the results will be ordered.
cancellationToken System.Threading.CancellationToken
Returns
Section titled “Returns”System.Collections.Generic.IAsyncEnumerable<HAKOM.ErrorHandling.Core.Net.Api.Result<INodeReference>>
An System.Collections.Generic.IAsyncEnumerable<> of Result<TValue> .
Remarks
Section titled “Remarks”Removes consecutive duplicate orderings, retaining only the last specified Direction for each.
INodeStore.TryLoad(INodeReference, CancellationToken) Method
Section titled “INodeStore.TryLoad(INodeReference, CancellationToken) Method”Attempts to use the given reference to load the INode it refers to.
System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.Attributes.Nodes.Persistence.References.INodeReference>> TryLoad(HAKOM.TSM.Net.Api.Attributes.Nodes.Persistence.References.INodeReference reference, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”reference INodeReference
The reference to the INodeReference of the node to be loaded.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<INodeReference>>
A System.Threading.Tasks.Task<> of Result<TValue> containing a reference to the desired node.
INodeStore.TryLoad(IAttributeReference, INodeReference, string, CancellationToken) Method
Section titled “INodeStore.TryLoad(IAttributeReference, INodeReference, string, CancellationToken) Method”Attempts to use the given parameters to load the INode it refers to.
System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.Attributes.Nodes.Persistence.References.INodeReference>> TryLoad(HAKOM.TSM.Net.Api.Attributes.Persistence.References.IAttributeReference rootReference, HAKOM.TSM.Net.Api.Attributes.Nodes.Persistence.References.INodeReference? parentReference, string name, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”rootReference IAttributeReference
The reference to the IAttributeReference which is the root of the node to be loaded.
parentReference INodeReference
The reference to the parent of the INode which will be loaded.
name System.String
The name of the node which will be loaded.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<INodeReference>>
A System.Threading.Tasks.Task<> of Result<TValue> containing a reference to the desired node.
INodeStore.TrySave(INode, CancellationToken) Method
Section titled “INodeStore.TrySave(INode, CancellationToken) Method”Attempts to persist the given INode to the repository.
System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.Attributes.Nodes.Persistence.References.INodeReference>> TrySave(HAKOM.TSM.Net.Api.Attributes.Nodes.INode node, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”node INode
The node which will be persisted.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<INodeReference>>
A System.Threading.Tasks.Task<> of Result<TValue> containing a reference to the persisted node.
INodeStore.TryUpdate(INodeReference, INode, CancellationToken) Method
Section titled “INodeStore.TryUpdate(INodeReference, INode, CancellationToken) Method”Attempts to modify the given oldNode with the modifiedNode and persist it to the repository.
System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.Attributes.Nodes.Persistence.References.INodeReference>> TryUpdate(HAKOM.TSM.Net.Api.Attributes.Nodes.Persistence.References.INodeReference oldNode, HAKOM.TSM.Net.Api.Attributes.Nodes.INode modifiedNode, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”oldNode INodeReference
The node which will be updated with the modifiedNode.
modifiedNode INode
The node which will be persisted.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<INodeReference>>
A System.Threading.Tasks.Task<> of Result<TValue> containing a reference to the persisted node.
INodeStore.Update(INodeReference, INode, CancellationToken) Method
Section titled “INodeStore.Update(INodeReference, INode, CancellationToken) Method”Modifies the given oldNode with the modifiedNode and persist it to the repository.
System.Threading.Tasks.Task<HAKOM.TSM.Net.Api.Attributes.Nodes.Persistence.References.INodeReference> Update(HAKOM.TSM.Net.Api.Attributes.Nodes.Persistence.References.INodeReference oldNode, HAKOM.TSM.Net.Api.Attributes.Nodes.INode modifiedNode, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”oldNode INodeReference
The node which will be updated with the modifiedNode.
modifiedNode INode
The node which will be persisted.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<INodeReference>
A System.Threading.Tasks.Task<> containing a reference to the persisted node.