Interface IDataEngine
XData engine interface
Namespace: XData
Assembly: XData.docfx.dll
Syntax
public interface IDataEngine
Properties
| Improve this Doc View SourceConfiguration
XData configuration object
Declaration
IConfiguration Configuration { get; }
Property Value
| Type | Description |
|---|---|
| IConfiguration |
See Also
Methods
| Improve this Doc View SourceGetDataScope(Guid, Boolean)
Request existing or create data scope
Declaration
IDataScope GetDataScope(Guid layer, bool throwIfNotFound = false)
Parameters
| Type | Name | Description |
|---|---|---|
| Guid | layer | Data scope layer |
| Boolean | throwIfNotFound | Throw an exception when data scope is not found |
Returns
| Type | Description |
|---|---|
| IDataScope | Data scope |
See Also
| Improve this Doc View SourceGetDataScope(Guid, String, CancellationToken, Boolean)
Request existing or create data scope
Declaration
IDataScope GetDataScope(Guid layer, string defaultContext, CancellationToken token, bool throwIfNotFound = false)
Parameters
| Type | Name | Description |
|---|---|---|
| Guid | layer | Data scope layer |
| String | defaultContext | Default context of scope (if nof found) |
| CancellationToken | token | Cancellation token |
| Boolean | throwIfNotFound | Throw an exception when data scope is not found |
Returns
| Type | Description |
|---|---|
| IDataScope | Data scope |
See Also
| Improve this Doc View SourceGetDataScope(Guid, String, ISecuritySession, CancellationToken, Boolean)
Request existing or create data scope
Declaration
IDataScope GetDataScope(Guid layer, string defaultContext, ISecuritySession security, CancellationToken token, bool throwIfNotFound = false)
Parameters
| Type | Name | Description |
|---|---|---|
| Guid | layer | Data scope layer |
| String | defaultContext | Default context of scope (if nof found) |
| ISecuritySession | security | Security session |
| CancellationToken | token | Cancellation token |
| Boolean | throwIfNotFound | Throw an exception when data scope is not found |
Returns
| Type | Description |
|---|---|
| IDataScope | Data scope |
See Also
| Improve this Doc View SourceGetDataScope(Guid, CancellationToken, Boolean)
Request existing or create data scope
Declaration
IDataScope GetDataScope(Guid layer, CancellationToken token, bool throwIfNotFound = false)
Parameters
| Type | Name | Description |
|---|---|---|
| Guid | layer | Data scope layer |
| CancellationToken | token | Cancellation token |
| Boolean | throwIfNotFound | Throw an exception when data scope is not found |
Returns
| Type | Description |
|---|---|
| IDataScope | Data scope |
See Also
| Improve this Doc View SourceGetDataScope(Guid, ISecuritySession, CancellationToken, Boolean)
Request existing or create data scope
Declaration
IDataScope GetDataScope(Guid layer, ISecuritySession security, CancellationToken token, bool throwIfNotFound = false)
Parameters
| Type | Name | Description |
|---|---|---|
| Guid | layer | Data scope layer |
| ISecuritySession | security | Security session |
| CancellationToken | token | Cancellation token |
| Boolean | throwIfNotFound | Throw an exception when data scope is not found |
Returns
| Type | Description |
|---|---|
| IDataScope | Data scope |
See Also
| Improve this Doc View SourceNewDataScope()
Create new data scope
Declaration
IDataScope NewDataScope()
Returns
| Type | Description |
|---|---|
| IDataScope | Data scope |
See Also
| Improve this Doc View SourceNewDataScope(String)
Create new data scope
Declaration
IDataScope NewDataScope(string defaultContext)
Parameters
| Type | Name | Description |
|---|---|---|
| String | defaultContext | Default context of scope |
Returns
| Type | Description |
|---|---|
| IDataScope | Data scope |
See Also
| Improve this Doc View SourceNewDataScope(String, CancellationToken)
Create new data scope
Declaration
IDataScope NewDataScope(string defaultContext, CancellationToken token)
Parameters
| Type | Name | Description |
|---|---|---|
| String | defaultContext | Default context of scope |
| CancellationToken | token | Cancellation token |
Returns
| Type | Description |
|---|---|
| IDataScope | Data scope |
See Also
| Improve this Doc View SourceNewDataScope(String, ISecuritySession)
Create new data scope
Declaration
IDataScope NewDataScope(string defaultContext, ISecuritySession security)
Parameters
| Type | Name | Description |
|---|---|---|
| String | defaultContext | Default context of scope |
| ISecuritySession | security | Security session |
Returns
| Type | Description |
|---|---|
| IDataScope | Data scope |
See Also
| Improve this Doc View SourceNewDataScope(String, ISecuritySession, CancellationToken)
Create new data scope
Declaration
IDataScope NewDataScope(string defaultContext, ISecuritySession security, CancellationToken token)
Parameters
| Type | Name | Description |
|---|---|---|
| String | defaultContext | Default context of scope |
| ISecuritySession | security | Security session |
| CancellationToken | token | Cancellation token |
Returns
| Type | Description |
|---|---|
| IDataScope | Data scope |
See Also
| Improve this Doc View SourceNewDataScope(CancellationToken)
Create new data scope
Declaration
IDataScope NewDataScope(CancellationToken token)
Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | token | Cancellation token |
Returns
| Type | Description |
|---|---|
| IDataScope | Data scope |
See Also
| Improve this Doc View SourceNewDataScope(ISecuritySession, CancellationToken)
Create new data scope
Declaration
IDataScope NewDataScope(ISecuritySession security, CancellationToken token)
Parameters
| Type | Name | Description |
|---|---|---|
| ISecuritySession | security | Security session |
| CancellationToken | token | Cancellation token |
Returns
| Type | Description |
|---|---|
| IDataScope | Data scope |
See Also
| Improve this Doc View SourceResetAllDictionaries()
Reset all dictionaries cache
Declaration
void ResetAllDictionaries()
See Also
| Improve this Doc View SourceResetDictionaryCache<T>()
Reset single dictionary cache
Declaration
void ResetDictionaryCache<T>()
where T : class, IDataObject
Type Parameters
| Name | Description |
|---|---|
| T | Dictionary type |