Documentation

Class OpenAccessContextBase

Inheritance
System.Object
OpenAccessContextBase
Namespace: Telerik.OpenAccess
Assembly: Telerik.OpenAccess.dll

Syntax

public class OpenAccessContextBase : ILevelOneCache, ILevelTwoCache, IDisposable, IOpenAccessContextOptions, IKeyGenerator

Constructors

OpenAccessContextBase(String, String, BackendConfiguration, MetadataContainer)

Declaration
public OpenAccessContextBase(string connectionString, string cacheKey, BackendConfiguration backendConfiguration, MetadataContainer metadataContainer)
Parameters
System.String connectionString

System.String cacheKey

BackendConfiguration backendConfiguration

MetadataContainer metadataContainer

OpenAccessContextBase(String, String, BackendConfiguration, MetadataContainer, Assembly)

Declaration
protected OpenAccessContextBase(string connectionString, string cacheKey, BackendConfiguration backendConfiguration, MetadataContainer metadataContainer, Assembly callingAssembly)
Parameters
System.String connectionString

System.String cacheKey

BackendConfiguration backendConfiguration

MetadataContainer metadataContainer

System.Reflection.Assembly callingAssembly

OpenAccessContextBase(String, String, BackendConfiguration, MetadataSource)

Declaration
public OpenAccessContextBase(string connectionString, string cacheKey, BackendConfiguration backendConfiguration, MetadataSource metadataSource)
Parameters
System.String connectionString

System.String cacheKey

BackendConfiguration backendConfiguration

MetadataSource metadataSource

OpenAccessContextBase(String, String, BackendConfiguration, MetadataSource, Assembly)

Declaration
protected OpenAccessContextBase(string connectionString, string cacheKey, BackendConfiguration backendConfiguration, MetadataSource metadataSource, Assembly callingAssembly)
Parameters
System.String connectionString

System.String cacheKey

BackendConfiguration backendConfiguration

MetadataSource metadataSource

System.Reflection.Assembly callingAssembly

OpenAccessContextBase(String, BackendConfiguration, MetadataContainer)

Declaration
public OpenAccessContextBase(string connectionString, BackendConfiguration backendConfiguration, MetadataContainer metadataContainer)
Parameters
System.String connectionString

BackendConfiguration backendConfiguration

MetadataContainer metadataContainer

OpenAccessContextBase(String, BackendConfiguration, MetadataContainer, Assembly)

Declaration
protected OpenAccessContextBase(string connectionString, BackendConfiguration backendConfiguration, MetadataContainer metadataContainer, Assembly callingAssembly)
Parameters
System.String connectionString

BackendConfiguration backendConfiguration

MetadataContainer metadataContainer

System.Reflection.Assembly callingAssembly

OpenAccessContextBase(String, BackendConfiguration, MetadataSource)

Declaration
public OpenAccessContextBase(string connectionString, BackendConfiguration backendConfiguration, MetadataSource metadataSource)
Parameters
System.String connectionString

BackendConfiguration backendConfiguration

MetadataSource metadataSource

OpenAccessContextBase(String, BackendConfiguration, MetadataSource, Assembly)

Declaration
protected OpenAccessContextBase(string connectionString, BackendConfiguration backendConfiguration, MetadataSource metadataSource, Assembly callingAssembly)
Parameters
System.String connectionString

BackendConfiguration backendConfiguration

MetadataSource metadataSource

System.Reflection.Assembly callingAssembly

OpenAccessContextBase(OpenAccessContextBase)

Declaration
public OpenAccessContextBase(OpenAccessContextBase otherContext)
Parameters
OpenAccessContextBase otherContext

Properties

Cache

Declaration
public ILevelOneCache Cache { get; }
Property Value
ILevelOneCache

CacheKey

Declaration
protected virtual string CacheKey { get; }
Property Value
System.String

Connection

Declaration
public OAConnection Connection { get; }
Property Value
OAConnection

ContextOptions

Declaration
public IOpenAccessContextOptions ContextOptions { get; }
Property Value
IOpenAccessContextOptions

Events

Declaration
public IContextEvents Events { get; }
Property Value
IContextEvents

HasChanges

Declaration
public bool HasChanges { get; }
Property Value
System.Boolean

KeyGenerators

Declaration
public IKeyGenerator KeyGenerators { get; }
Property Value
IKeyGenerator

LevelTwoCache

Declaration
public ILevelTwoCache LevelTwoCache { get; }
Property Value
ILevelTwoCache

Log

Declaration
public TextWriter Log { get; set; }
Property Value
System.IO.TextWriter

Metadata

Declaration
public MetadataContainer Metadata { get; }
Property Value
MetadataContainer

Name

Declaration
public string Name { get; set; }
Property Value
System.String

PersistenceState

Declaration
public static PersistenceStateHelper PersistenceState { get; }
Property Value
PersistenceStateHelper

ReadOnly

Declaration
public bool ReadOnly { get; set; }
Property Value
System.Boolean

SyncRoot

Declaration
protected object SyncRoot { get; }
Property Value
System.Object

Methods

Add(IEnumerable)

Declaration
public void Add(IEnumerable entities)
Parameters
System.Collections.IEnumerable entities

Add(Object)

Declaration
public void Add(object entity)
Parameters
System.Object entity

AttachCopy<T>(T)

Declaration
public T AttachCopy<T>(T entity)
Parameters
T entity

Returns
T

Type Parameters
T

CheckNotDisposed()

Declaration
protected void CheckNotDisposed()

ClearChanges()

Declaration
public void ClearChanges()

CreateDetachedCopy<T>(T)

Declaration
public T CreateDetachedCopy<T>(T entity)
Parameters
T entity

Returns
T

Type Parameters
T

CreateDetachedCopy<T>(T, String[])

Declaration
public T CreateDetachedCopy<T>(T entity, params string[] referenceProperties)
Parameters
T entity

System.String[] referenceProperties

Returns
T

Type Parameters
T

CreateObjectKey(Object)

Declaration
public ObjectKey CreateObjectKey(object entity)
Parameters
System.Object entity

Returns
ObjectKey

CreateObjectKeyWithVersion(Object)

Declaration
public ObjectKey CreateObjectKeyWithVersion(object entity)
Parameters
System.Object entity

Returns
ObjectKey

Delete(IEnumerable)

Declaration
public void Delete(IEnumerable entities)
Parameters
System.Collections.IEnumerable entities

Delete(Object)

Declaration
public void Delete(object entity)
Parameters
System.Object entity

Dispose()

Declaration
public void Dispose()

Dispose(Boolean)

Declaration
protected virtual void Dispose(bool disposing)
Parameters
System.Boolean disposing

DisposeDatabase()

Declaration
public void DisposeDatabase()

DisposeDatabase(String)

Declaration
public void DisposeDatabase(string reason)
Parameters
System.String reason

ExecuteNonQuery(String, CommandType, DbParameter[])

Declaration
public int ExecuteNonQuery(string commandText, CommandType commandType, params DbParameter[] parameters)
Parameters
System.String commandText

System.Data.CommandType commandType

System.Data.Common.DbParameter[] parameters

Returns
System.Int32

ExecuteNonQuery(String, DbParameter[])

Declaration
public int ExecuteNonQuery(string commandText, params DbParameter[] parameters)
Parameters
System.String commandText

System.Data.Common.DbParameter[] parameters

Returns
System.Int32

ExecuteQuery(String, String, CommandType, DbParameter[])

Declaration
public IList<object> ExecuteQuery(string persistentTypeFullName, string commandText, CommandType commandType, params DbParameter[] parameters)
Parameters
System.String persistentTypeFullName

System.String commandText

System.Data.CommandType commandType

System.Data.Common.DbParameter[] parameters

Returns
System.Collections.Generic.IList<System.Object>

ExecuteQuery(String, String, DbParameter[])

Declaration
public IList<object> ExecuteQuery(string persistentTypeFullName, string commandText, params DbParameter[] parameters)
Parameters
System.String persistentTypeFullName

System.String commandText

System.Data.Common.DbParameter[] parameters

Returns
System.Collections.Generic.IList<System.Object>

ExecuteQuery<T>(String, CommandType, DbParameter[])

Declaration
public IList<T> ExecuteQuery<T>(string commandText, CommandType commandType, params DbParameter[] parameters)
Parameters
System.String commandText

System.Data.CommandType commandType

System.Data.Common.DbParameter[] parameters

Returns
System.Collections.Generic.IList<T>

Type Parameters
T

ExecuteQuery<T>(String, DbParameter[])

Declaration
public IList<T> ExecuteQuery<T>(string commandText, params DbParameter[] parameters)
Parameters
System.String commandText

System.Data.Common.DbParameter[] parameters

Returns
System.Collections.Generic.IList<T>

Type Parameters
T

ExecuteScalar<T>(String, CommandType, DbParameter[])

Declaration
public T ExecuteScalar<T>(string commandText, CommandType commandType, params DbParameter[] parameters)
Parameters
System.String commandText

System.Data.CommandType commandType

System.Data.Common.DbParameter[] parameters

Returns
T

Type Parameters
T

ExecuteScalar<T>(String, DbParameter[])

Declaration
public T ExecuteScalar<T>(string commandText, params DbParameter[] parameters)
Parameters
System.String commandText

System.Data.Common.DbParameter[] parameters

Returns
T

Type Parameters
T

ExecuteStoredProcedure<T>(String, IEnumerable<SqlParameter>, out IDictionary<String, Object>, Object[])

Declaration
public T[] ExecuteStoredProcedure<T>(string procedureName, IEnumerable<SqlParameter> parameterDefinition, out IDictionary<string, object> outParameter, params object[] parameterValues)
Parameters
System.String procedureName

System.Collections.Generic.IEnumerable<SqlParameter> parameterDefinition

System.Collections.Generic.IDictionary<System.String, System.Object> outParameter

System.Object[] parameterValues

Returns
T[]

Type Parameters
T

ExecuteStoredProcedure<T>(String, IEnumerable<SqlParameter>, Object[])

Declaration
public T[] ExecuteStoredProcedure<T>(string procedureName, IEnumerable<SqlParameter> parameterDefinition, params object[] parameterValues)
Parameters
System.String procedureName

System.Collections.Generic.IEnumerable<SqlParameter> parameterDefinition

System.Object[] parameterValues

Returns
T[]

Type Parameters
T

FlushChanges()

Declaration
public void FlushChanges()

FlushChanges(Boolean)

Declaration
public void FlushChanges(bool releaseMemory)
Parameters
System.Boolean releaseMemory

GetChanges()

Declaration
public ContextChanges GetChanges()
Returns
ContextChanges

GetContext(Object)

Declaration
public static OpenAccessContextBase GetContext(object persistentObject)
Parameters
System.Object persistentObject

Returns
OpenAccessContextBase

GetIncrementalGuid()

Declaration
[Obsolete("Please use the OpenAccessContextBase.KeyGenerators.GetIncrementalGuid method.", true)]
public Guid GetIncrementalGuid()
Returns
System.Guid

GetIncrementalGuid(Int32)

Declaration
[Obsolete("Please use the OpenAccessContextBase.KeyGenerators.GetIncrementalGuid method.", true)]
public Guid GetIncrementalGuid(int grabSize)
Parameters
System.Int32 grabSize

Returns
System.Guid

GetIncrementalGuids(Int32)

Declaration
[Obsolete("Please use the OpenAccessContextBase.KeyGenerators.GetIncrementalGuids method.", true)]
public IEnumerable<Guid> GetIncrementalGuids(int count)
Parameters
System.Int32 count

Returns
System.Collections.Generic.IEnumerable<System.Guid>

GetLastConflicts()

Declaration
public IList<ConcurrencyConflict> GetLastConflicts()
Returns
System.Collections.Generic.IList<ConcurrencyConflict>

GetMemberNames(Object, ObjectState)

Declaration
public IEnumerable<string> GetMemberNames(object instance, ObjectState state)
Parameters
System.Object instance

ObjectState state

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

GetObject<T>(ObjectKey)

Declaration
[Obsolete("Use GetObjectByKey<T> instead.")]
public T GetObject<T>(ObjectKey key)
Parameters
ObjectKey key

Returns
T

Type Parameters
T

GetObjectByKey(ObjectKey)

Declaration
public object GetObjectByKey(ObjectKey key)
Parameters
ObjectKey key

Returns
System.Object

GetObjectByKey<T>(ObjectKey)

Declaration
public T GetObjectByKey<T>(ObjectKey key)
Parameters
ObjectKey key

Returns
T

Type Parameters
T

GetObjectsByKeys<T>(IEnumerable<ObjectKey>)

Declaration
public IGetObjectsByKeysResult<T> GetObjectsByKeys<T>(IEnumerable<ObjectKey> keys)
Parameters
System.Collections.Generic.IEnumerable<ObjectKey> keys

Returns
IGetObjectsByKeysResult<T>

Type Parameters
T

GetOriginalValue<T>(Object, String)

Declaration
public T GetOriginalValue<T>(object entity, string propertyName)
Parameters
System.Object entity

System.String propertyName

Returns
T

Type Parameters
T

GetPersistentType(String)

Declaration
public Type GetPersistentType(string fullTypeName)
Parameters
System.String fullTypeName

Returns
System.Type

GetSchemaHandler()

Declaration
public ISchemaHandler GetSchemaHandler()
Returns
ISchemaHandler

GetScope()

Declaration
protected IObjectScope GetScope()
Returns
IObjectScope

GetState(Object)

Declaration
public ObjectState GetState(object entity)
Parameters
System.Object entity

Returns
ObjectState

GetState(Object, String)

Declaration
public ObjectState GetState(object entity, string fieldName)
Parameters
System.Object entity

System.String fieldName

Returns
ObjectState

GetUniqueId(UniqueIdGenerator)

Declaration
[Obsolete("Please use the OpenAccessContextBase.KeyGenerators.GetUniqueId method.", true)]
public int GetUniqueId(UniqueIdGenerator generator)
Parameters
UniqueIdGenerator generator

Returns
System.Int32

GetUniqueIds(UniqueIdGenerator, Int32)

Declaration
[Obsolete("Please use the OpenAccessContextBase.KeyGenerators.GetUniqueIds method.", true)]
public IEnumerable<int> GetUniqueIds(UniqueIdGenerator generator, int size)
Parameters
UniqueIdGenerator generator

System.Int32 size

Returns
System.Collections.Generic.IEnumerable<System.Int32>

Init(String, String, BackendConfiguration, MetadataContainer, Assembly)

Declaration
protected virtual void Init(string connectionString, string cacheKey, BackendConfiguration backendConfiguration, MetadataContainer metadataContainer, Assembly callingAssembly)
Parameters
System.String connectionString

System.String cacheKey

BackendConfiguration backendConfiguration

MetadataContainer metadataContainer

System.Reflection.Assembly callingAssembly

Init(String, BackendConfiguration, MetadataContainer)

Declaration
[Obsolete("Override 'Init(string connectionString, string cacheKey, BackendConfiguration backendConfiguration, MetadataContainer metadataContainer, Assembly callingAssembly)' method instead.")]
protected virtual void Init(string connectionString, BackendConfiguration backendConfiguration, MetadataContainer metadataContainer)
Parameters
System.String connectionString

BackendConfiguration backendConfiguration

MetadataContainer metadataContainer

Init(String, BackendConfiguration, MetadataContainer, Assembly)

Declaration
[Obsolete("Override 'Init(string connectionString, string cacheKey, BackendConfiguration backendConfiguration, MetadataContainer metadataContainer, Assembly callingAssembly)' method instead.")]
protected virtual void Init(string connectionString, BackendConfiguration backendConfiguration, MetadataContainer metadataContainer, Assembly callingAssembly)
Parameters
System.String connectionString

BackendConfiguration backendConfiguration

MetadataContainer metadataContainer

System.Reflection.Assembly callingAssembly

LookupObjectByKey(ObjectKey)

Declaration
public object LookupObjectByKey(ObjectKey key)
Parameters
ObjectKey key

Returns
System.Object

LookupObjectByKey<T>(ObjectKey)

Declaration
public T LookupObjectByKey<T>(ObjectKey key)
Parameters
ObjectKey key

Returns
T

Type Parameters
T

MakeDirty(Object, String)

Declaration
public void MakeDirty(object entity, string fieldName)
Parameters
System.Object entity

System.String fieldName

OnDatabaseOpen(BackendConfiguration, MetadataContainer)

Declaration
[Obsolete("Please use the 'void OnDatabaseOpen(BackendConfiguration backendConfiguration, MetadataContainer currentMetadataContainer, MetadataContainer aggregatedMetadataContainer)' overload instead.")]
protected virtual void OnDatabaseOpen(BackendConfiguration backendConfiguration, MetadataContainer metadataContainer)
Parameters
BackendConfiguration backendConfiguration

MetadataContainer metadataContainer

OnDatabaseOpen(BackendConfiguration, MetadataContainer, MetadataContainer)

Declaration
protected virtual void OnDatabaseOpen(BackendConfiguration backendConfiguration, MetadataContainer currentMetadataContainer, MetadataContainer aggregatedMetadataContainer)
Parameters
BackendConfiguration backendConfiguration

MetadataContainer currentMetadataContainer

MetadataContainer aggregatedMetadataContainer

OnReplacingMetadata(SchemaUpdateArgs)

Declaration
protected virtual void OnReplacingMetadata(SchemaUpdateArgs args)
Parameters
SchemaUpdateArgs args

Refresh(RefreshMode, IEnumerable)

Declaration
public void Refresh(RefreshMode mode, IEnumerable entities)
Parameters
RefreshMode mode

System.Collections.IEnumerable entities

Refresh(RefreshMode, Object)

Declaration
public void Refresh(RefreshMode mode, object entity)
Parameters
RefreshMode mode

System.Object entity

Refresh(RefreshMode, Object[])

Declaration
public void Refresh(RefreshMode mode, params object[] entities)
Parameters
RefreshMode mode

System.Object[] entities

ReplaceMetadata(OpenAccessContextBase, MetadataContainer, SchemaUpdateCallback)

Declaration
public static void ReplaceMetadata(OpenAccessContextBase context, MetadataContainer newMetadata, SchemaUpdateCallback callback)
Parameters
OpenAccessContextBase context

MetadataContainer newMetadata

SchemaUpdateCallback callback

ResetIncrementalGuid()

Declaration
[Obsolete("Please use the OpenAccessContextBase.KeyGenerators.ResetIncrementalGuid method.", true)]
public void ResetIncrementalGuid()

SaveChanges()

Declaration
public void SaveChanges()

SaveChanges(ConcurrencyConflictsProcessingMode)

Declaration
public virtual void SaveChanges(ConcurrencyConflictsProcessingMode failureMode)
Parameters
ConcurrencyConflictsProcessingMode failureMode

Translate(String, DbDataReader)

Declaration
public IEnumerable<object> Translate(string persistentTypeFullName, DbDataReader reader)
Parameters
System.String persistentTypeFullName

System.Data.Common.DbDataReader reader

Returns
System.Collections.Generic.IEnumerable<System.Object>

Translate<T>(DbDataReader)

Declaration
public IEnumerable<T> Translate<T>(DbDataReader reader)
Parameters
System.Data.Common.DbDataReader reader

Returns
System.Collections.Generic.IEnumerable<T>

Type Parameters
T

TryGetObjectByKey(ObjectKey, out Object)

Declaration
public bool TryGetObjectByKey(ObjectKey key, out object entity)
Parameters
ObjectKey key

System.Object entity

Returns
System.Boolean

TryGetObjectByKey<T>(ObjectKey, out T)

Declaration
public bool TryGetObjectByKey<T>(ObjectKey key, out T entity)
Parameters
ObjectKey key

T entity

Returns
System.Boolean

Type Parameters
T

Explicit Interface Implementations

IKeyGenerator.GetIncrementalGuid()

Declaration
Guid IKeyGenerator.GetIncrementalGuid()
Returns
System.Guid

Implements

IKeyGenerator.GetIncrementalGuid(Int32)

Declaration
Guid IKeyGenerator.GetIncrementalGuid(int grabSize)
Parameters
System.Int32 grabSize

Returns
System.Guid

Implements

IKeyGenerator.GetIncrementalGuidRange()

Declaration
byte IKeyGenerator.GetIncrementalGuidRange()
Returns
System.Byte

Implements

IKeyGenerator.GetIncrementalGuids(Int32)

Declaration
IEnumerable<Guid> IKeyGenerator.GetIncrementalGuids(int count)
Parameters
System.Int32 count

Returns
System.Collections.Generic.IEnumerable<System.Guid>

Implements

IKeyGenerator.GetUniqueId(UniqueIdGenerator)

Declaration
int IKeyGenerator.GetUniqueId(UniqueIdGenerator generator)
Parameters
UniqueIdGenerator generator

Returns
System.Int32

Implements

IKeyGenerator.GetUniqueIds(UniqueIdGenerator, Int32)

Declaration
IEnumerable<int> IKeyGenerator.GetUniqueIds(UniqueIdGenerator generator, int size)
Parameters
UniqueIdGenerator generator

System.Int32 size

Returns
System.Collections.Generic.IEnumerable<System.Int32>

Implements

IKeyGenerator.ResetIncrementalGuid()

Declaration
void IKeyGenerator.ResetIncrementalGuid()
Implements

IKeyGenerator.SetIncrementalGuidRange(Byte)

Declaration
void IKeyGenerator.SetIncrementalGuidRange(byte range)
Parameters
System.Byte range

Implements

ILevelOneCache.Release(Object)

Declaration
void ILevelOneCache.Release(object entity)
Parameters
System.Object entity

Implements

ILevelOneCache.ReleaseAll()

Declaration
void ILevelOneCache.ReleaseAll()
Implements

ILevelOneCache.ReleaseAll(IEnumerable<Object>)

Declaration
void ILevelOneCache.ReleaseAll(IEnumerable<object> entities)
Parameters
System.Collections.Generic.IEnumerable<System.Object> entities

Implements

ILevelTwoCache.Evict(ObjectKey)

Declaration
void ILevelTwoCache.Evict(ObjectKey objectKey)
Parameters
ObjectKey objectKey

Implements

ILevelTwoCache.EvictAll()

Declaration
void ILevelTwoCache.EvictAll()
Implements

ILevelTwoCache.EvictAll(IEnumerable<ObjectKey>)

Declaration
void ILevelTwoCache.EvictAll(IEnumerable<ObjectKey> entityKeyList)
Parameters
System.Collections.Generic.IEnumerable<ObjectKey> entityKeyList

Implements

ILevelTwoCache.EvictAll(Type)

Declaration
void ILevelTwoCache.EvictAll(Type entityType)
Parameters
System.Type entityType

Implements

ILevelTwoCache.EvictAll(Type, Boolean)

Declaration
void ILevelTwoCache.EvictAll(Type entityType, bool includeSubtypes)
Parameters
System.Type entityType

System.Boolean includeSubtypes

Implements

ILevelTwoCache.EvictAll<T>()

Declaration
void ILevelTwoCache.EvictAll<T>()
Type Parameters
T

Implements

ILevelTwoCache.EvictAll<T>(Boolean)

Declaration
void ILevelTwoCache.EvictAll<T>(bool includeSubtypes)
Parameters
System.Boolean includeSubtypes

Type Parameters
T

Implements

ILevelTwoCache.IsCached(ObjectKey)

Declaration
bool ILevelTwoCache.IsCached(ObjectKey objectKey)
Parameters
ObjectKey objectKey

Returns
System.Boolean

Implements

IOpenAccessContextOptions.EnableDataSynchronization

Declaration
bool IOpenAccessContextOptions.EnableDataSynchronization { get; set; }
Returns
System.Boolean

Implements

IOpenAccessContextOptions.IsolationLevel

Declaration
IsolationLevel? IOpenAccessContextOptions.IsolationLevel { get; set; }
Returns
System.Nullable<System.Data.IsolationLevel>

Implements

IOpenAccessContextOptions.MaintainOriginalValues

Declaration
bool IOpenAccessContextOptions.MaintainOriginalValues { get; set; }
Returns
System.Boolean

Implements

IOpenAccessContextOptions.RefreshObjectsAfterSaveChanges

Declaration
bool IOpenAccessContextOptions.RefreshObjectsAfterSaveChanges { get; set; }
Returns
System.Boolean

Implements