Interface IObjectLayerEx

Namespace

DevExpress.Xpo

Assembly

DevExpress.Xpo.v24.1.dll

Defines members providing backward compatibility for sessions that directly accessed corresponding IDataLayer members in previous XPO versions.

public interface IObjectLayerEx : IDataLayerProvider, IXPDictionaryProvider

Inherited Members

IDataLayerProvider.DataLayer

IXPDictionaryProvider.Dictionary

Properties

AutoCreateOption

When implemented by a class, returns an DevExpress.Xpo.DB.AutoCreateOption value associated with an object layer.

AutoCreateOption AutoCreateOption { get; }

Property Value

AutoCreateOption

An DevExpress.Xpo.DB.AutoCreateOption enumeration value which specifies the action which is performed when connecting to a data store.

Connection

When implemented by a class, provides access to a IDbConnection object that is used to access a database.

IDbConnection Connection { get; }

Property Value

IDbConnection

An object which implements the IDbConnection interface.

Methods

LoadDelayedProperties(Session, IList, XPMemberInfo)

When implemented by a class, loads data to a specific property marked for delayed loading in specified objects.

ObjectDictionary<object> LoadDelayedProperties(Session session, IList objects, XPMemberInfo property)

Parameters

session Session

A Session that is used to retrieve data for delayed properties.

objects IList

A list of persistent objects containing the delayed property specified by the property.

property XPMemberInfo

An XPMemberInfo object specifying a delayed property whose values are loaded.

Returns

ObjectDictionary<object>

An DevExpress.Xpo.Helpers.ObjectDictionary`1<object,> of loaded property values that correspond to the objects list elements.

LoadDelayedProperties(Session, object, MemberPathCollection)

When implemented by a class, loads data to specific properties marked for delayed loading in a specified object.

object[] LoadDelayedProperties(Session session, object theObject, MemberPathCollection props)

Parameters

session Session

A Session that is used to retrieve data for delayed properties.

theObject object

A persistent object containing delayed properties specified by the props.

props MemberPathCollection

A MemberPathCollection object containing member paths of delayed properties whose values are loaded.

Returns

object[]

An array of loaded property values that correspond to the props collection elements.

UpdateSchema(bool, params XPClassInfo[])

When implemented by a class, updates a data store’s schema according to the class descriptions of the specified types.

UpdateSchemaResult UpdateSchema(bool doNotCreateIfFirstTableNotExist, params XPClassInfo[] types)

Parameters

doNotCreateIfFirstTableNotExist bool

true if the schema should not be created when the table that corresponds to the first item in the types array doesn’t exist in the data store; otherwise, false.

types XPClassInfo[]

An array of XPClassInfo objects specifying the types of objects for which schema should be created in the data store.

Returns

UpdateSchemaResult

An DevExpress.Xpo.DB.UpdateSchemaResult enumeration value which specifies the result of the update operation.

Events

SchemaInit

When implemented by a class, this event will occur when a data store’s schema is initialized or updated.

event SchemaInitEventHandler SchemaInit

Event Type

SchemaInitEventHandler