Interface ISerializableObjectLayerEx

Namespace

DevExpress.Xpo

Assembly

DevExpress.Xpo.v24.1.dll

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

public interface ISerializableObjectLayerEx

Methods

GetParentObjectsToDelete()

When implemented by a class, returns information on persistent objects marked for deletion in parent sessions.

SerializableObjectLayerResult<XPObjectStubCollection> GetParentObjectsToDelete()

Returns

SerializableObjectLayerResult<XPObjectStubCollection>

A SerializableObjectLayerResult instance that exposes an XPObjectStubCollection object containing information on persistent objects marked for deletion in parent sessions.

GetParentObjectsToSave()

When implemented by a class, returns information on persistent objects marked for saving in parent sessions.

SerializableObjectLayerResult<XPObjectStubCollection> GetParentObjectsToSave()

Returns

SerializableObjectLayerResult<XPObjectStubCollection>

A SerializableObjectLayerResult instance that exposes an XPObjectStubCollection object containing information on persistent objects loaded from the immediate parent session. XPObjectStubCollection elements match objects marked for saving in parent sessions.

GetParentTouchedClassInfos()

When implemented by a class, returns metadata information on persistent objects modified in parent sessions.

string[] GetParentTouchedClassInfos()

Returns

string[]

An array of strings that can be used to identify metadata information for objects modified in parent sessions relative to an object layer’s session.

IsParentObjectToDelete(XPDictionaryStub, XPObjectStub)

When implemented by a class, indicates if a specified object corresponds to a an object marked for deletion in parent sessions.

bool IsParentObjectToDelete(XPDictionaryStub dictionary, XPObjectStub theObject)

Parameters

dictionary XPDictionaryStub

An XPDictionaryStub object that is a metadata information provider.

theObject XPObjectStub

An XPObjectStub instance identifying an object layer session’s object to test.

Returns

bool

true if the object identified by the theObject corresponds to one of the objects marked for deletion in parent sessions; otherwise, false.

IsParentObjectToSave(XPDictionaryStub, XPObjectStub)

When implemented by a class, indicates if a specified object corresponds to a an object marked for saving in parent sessions.

bool IsParentObjectToSave(XPDictionaryStub dictionary, XPObjectStub theObject)

Parameters

dictionary XPDictionaryStub

An XPDictionaryStub object that is a metadata information provider.

theObject XPObjectStub

An XPObjectStub instance identifying an object layer session’s object to test.

Returns

bool

true if the object identified by the theObject corresponds to one of the objects marked for saving in parent sessions; otherwise, false.

LoadDelayedProperties(XPDictionaryStub, XPObjectStub, string[])

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

SerializableObjectLayerResult<object[]> LoadDelayedProperties(XPDictionaryStub dictionary, XPObjectStub theObject, string[] props)

Parameters

dictionary XPDictionaryStub

An XPDictionaryStub object that is a metadata information provider.

theObject XPObjectStub

A persistent object containing delayed properties specified by the props.

props string[]

An array of strings specifying the delayed theObject‘s properties whose values are loaded.

Returns

SerializableObjectLayerResult<object[]>

A SerializableObjectLayerResult instance that exposes an array of loaded property values corresponding to the props array elements.

LoadDelayedProperties(XPDictionaryStub, XPObjectStubCollection, string)

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

SerializableObjectLayerResult<object[]> LoadDelayedProperties(XPDictionaryStub dictionary, XPObjectStubCollection objects, string property)

Parameters

dictionary XPDictionaryStub

An XPDictionaryStub object that is a metadata information provider.

objects XPObjectStubCollection

An XPObjectStubCollection object which contains information on persistent objects containing the delayed property specified by the property.

property string

A string value specifying a delayed property whose values are loaded.

Returns

SerializableObjectLayerResult<object[]>

A SerializableObjectLayerResult instance that exposes an array of loaded property values corresponding to the objects collection elements.