Interface ISerializableObjectLayer

Namespace

DevExpress.Xpo

Assembly

DevExpress.Xpo.v24.1.dll

Defines essential members for object access layers created for units of work (or sessions) in distributed applications.

public interface ISerializableObjectLayer : ISerializableObjectLayerProvider

Inherited Members

ISerializableObjectLayerProvider.ObjectLayer

Properties

CanLoadCollectionObjects

When implemented by a class, indicates if an object layer can call the ISerializableObjectLayer.LoadCollectionObjects method to load collection properties.

bool CanLoadCollectionObjects { get; }

Property Value

bool

true if collections can be loaded via an object layer’s ISerializableObjectLayer.LoadCollectionObjects method call; otherwise, false.

Methods

CommitObjects(XPDictionaryStub, XPObjectStubCollection, XPObjectStubCollection, LockingOption)

When implemented by a class, commits changes made to specified objects and returns information on modified objects.

CommitObjectStubsResult[] CommitObjects(XPDictionaryStub dictionary, XPObjectStubCollection objectsForDelete, XPObjectStubCollection objectsForSave, LockingOption lockingOption)

Parameters

dictionary XPDictionaryStub

An XPDictionaryStub object that is a metadata information provider.

objectsForDelete XPObjectStubCollection

An XPObjectStubCollection object which contains information on objects marked for deletion.

objectsForSave XPObjectStubCollection

An XPObjectStubCollection object which contains information on objects marked for saving.

lockingOption LockingOption

A LockingOption enumeration value specifying whether check for optimistic locking is made.

Returns

CommitObjectStubsResult[]

An array of CommitObjectStubsResult objects containing information on modified objects.

CreateObjectType(string, string)

When implemented by a class, creates an XPObjectType record.

void CreateObjectType(string assemblyName, string typeName)

Parameters

assemblyName string

A string value which specifies the assembly name to be assigned to the XPObjectType.AssemblyName property.

typeName string

A string value which specifies the type name to be assigned to the XPObjectType.TypeName property.

GetObjectsByKey(XPDictionaryStub, GetObjectStubsByKeyQuery[])

When implemented by a class, returns information on persistent objects retrieved from a data store using queries based on specified object types and key values.

SerializableObjectLayerResult<XPObjectStubCollection[]> GetObjectsByKey(XPDictionaryStub dictionary, GetObjectStubsByKeyQuery[] queries)

Parameters

dictionary XPDictionaryStub

An XPDictionaryStub object that is a metadata information provider.

queries GetObjectStubsByKeyQuery[]

An array of GetObjectStubsByKeyQuery objects, containing data for queries that retrieve persistent objects by specified object types and key values.

Returns

SerializableObjectLayerResult<XPObjectStubCollection[]>

A SerializableObjectLayerResult instance that exposes an array of XPObjectStubCollection objects containing information on retrieved objects.

LoadCollectionObjects(XPDictionaryStub, string, XPObjectStub)

When implemented by a class, loads a collection property using specified settings.

SerializableObjectLayerResult<XPObjectStubCollection> LoadCollectionObjects(XPDictionaryStub dictionary, string refPropertyName, XPObjectStub ownerObject)

Parameters

dictionary XPDictionaryStub

An XPDictionaryStub object that is a metadata information provider.

refPropertyName string

A string value specifying the ownerObject‘s property that references a collection property.

ownerObject XPObjectStub

An XPObjectStub specifying the object that owns the collection property.

Returns

SerializableObjectLayerResult<XPObjectStubCollection>

A DevExpress.Xpo.SerializableObjectLayerResult`1<XPObjectStubCollection,> object which contains information on collection objects.

LoadObjects(XPDictionaryStub, ObjectStubsQuery[])

When implemented by a class, loads persistent objects using specified settings.

SerializableObjectLayerResult<XPObjectStubCollection[]> LoadObjects(XPDictionaryStub dictionary, ObjectStubsQuery[] queries)

Parameters

dictionary XPDictionaryStub

An XPDictionaryStub object that is a metadata information provider.

queries ObjectStubsQuery[]

An array of ObjectStubsQuery objects specifying queries that are executed to retrieve persistent objects.

Returns

SerializableObjectLayerResult<XPObjectStubCollection[]>

A SerializableObjectLayerResult instance that exposes an array of XPObjectStubCollection object collections corresponding to the queries.

Purge()

When implemented by a class, removes all objects marked for deletion.

PurgeResult Purge()

Returns

PurgeResult

A PurgeResult object containing removal statistics (the number of objects processed, purged, etc.)

SelectData(XPDictionaryStub, ObjectStubsQuery, CriteriaOperatorCollection, CriteriaOperatorCollection, CriteriaOperator)

When implemented by a class, retrieves object data from a session using specified query parameters.

object[][] SelectData(XPDictionaryStub dictionary, ObjectStubsQuery query, CriteriaOperatorCollection properties, CriteriaOperatorCollection groupProperties, CriteriaOperator groupCriteria)

Parameters

dictionary XPDictionaryStub

An XPDictionaryStub object that is a metadata information provider.

query ObjectStubsQuery

An ObjectStubsQuery object specifying a query that is executed to retrieve persistent objects.

properties CriteriaOperatorCollection

A DevExpress.Data.Filtering.CriteriaOperatorCollection object which specifies object properties to be retrieved.

groupProperties CriteriaOperatorCollection

A DevExpress.Data.Filtering.CriteriaOperatorCollection object which specifies the grouping properties.

groupCriteria CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator descendant which specifies the grouping criteria for the retrieved objects.

Returns

object[][]

A SerializableObjectLayerResult instance that exposes an array whose elements are property values corresponding to the properties of objects retrieved from the associated session.