Interface ISerializableObjectLayerService

Namespace

DevExpress.Xpo.DB

Assembly

DevExpress.Xpo.v24.1.dll

Defines a WCF service contract to access data via SerializableObjectLayer objects.

public interface ISerializableObjectLayerService

Methods

CommitObjects(XPDictionaryStub, XPObjectStubCollection, XPObjectStubCollection, LockingOption)

When implemented by a class, executes an object layer’s ISerializableObjectLayer.CommitObjects method implementation and returns the operation result.

OperationResult<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

OperationResult<CommitObjectStubsResult[]>

An OperationResult<CommitObjectStubsResult> object denoting the operation result.

CreateObjectType(string, string)

When implemented by a class, executes an object layer’s ISerializableObjectLayer.CreateObjectType method implementation and returns the operation result.

OperationResult<object> 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.

Returns

OperationResult<object>

An OperationResult<object> object denoting the operation result.

GetCanLoadCollectionObjects()

When implemented by a class, obtains the value from an object layer’s ISerializableObjectLayer.CanLoadCollectionObjects property implementation and returns the operation result.

OperationResult<bool> GetCanLoadCollectionObjects()

Returns

OperationResult<bool>

An OperationResult<bool> object denoting the operation result.

GetObjectsByKey(XPDictionaryStub, GetObjectStubsByKeyQuery[])

When implemented by a class, executes an object layer’s ISerializableObjectLayer.GetObjectsByKey method implementation and returns the operation result.

OperationResult<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

OperationResult<SerializableObjectLayerResult<XPObjectStubCollection[]>>

An OperationResult<DevExpress.Xpo.SerializableObjectLayerResult`1[[DevExpress.Xpo.XPObjectStubCollection> object denoting the operation result.

GetParentObjectsToDelete()

When implemented by a class, executes an object layer’s ISerializableObjectLayerEx.GetParentObjectsToDelete method implementation and returns the operation result.

OperationResult<SerializableObjectLayerResult<XPObjectStubCollection>> GetParentObjectsToDelete()

Returns

OperationResult<SerializableObjectLayerResult<XPObjectStubCollection>>

An OperationResult<DevExpress.Xpo.SerializableObjectLayerResult`1[[DevExpress.Xpo.XPObjectStubCollection> object denoting the operation result.

GetParentObjectsToSave()

When implemented by a class, executes an object layer’s ISerializableObjectLayerEx.GetParentObjectsToSave method implementation and returns the operation result.

OperationResult<SerializableObjectLayerResult<XPObjectStubCollection>> GetParentObjectsToSave()

Returns

OperationResult<SerializableObjectLayerResult<XPObjectStubCollection>>

An OperationResult<DevExpress.Xpo.SerializableObjectLayerResult`1[[DevExpress.Xpo.XPObjectStubCollection> object denoting the operation result.

GetParentTouchedClassInfos()

When implemented by a class, executes an object layer’s ISerializableObjectLayerEx.GetParentTouchedClassInfos method implementation and returns the operation result.

OperationResult<string[]> GetParentTouchedClassInfos()

Returns

OperationResult<string[]>

An OperationResult<string> object denoting the operation result.

IsParentObjectToDelete(XPDictionaryStub, XPObjectStub)

When implemented by a class, executes an object layer’s ISerializableObjectLayerEx.IsParentObjectToDelete method implementation and returns the operation result.

OperationResult<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

OperationResult<bool>

An OperationResult<bool> object denoting the operation result.

IsParentObjectToSave(XPDictionaryStub, XPObjectStub)

When implemented by a class, executes an object layer’s ISerializableObjectLayerEx.IsParentObjectToSave method implementation and returns the operation result.

OperationResult<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

OperationResult<bool>

An OperationResult<bool> object denoting the operation result.

LoadCollectionObjects(XPDictionaryStub, string, XPObjectStub)

When implemented by a class, executes an object layer’s ISerializableObjectLayer.LoadCollectionObjects method implementation and returns the operation result.

OperationResult<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

OperationResult<SerializableObjectLayerResult<XPObjectStubCollection>>

An OperationResult<DevExpress.Xpo.SerializableObjectLayerResult`1[[DevExpress.Xpo.XPObjectStubCollection> object denoting the operation result.

LoadDelayedProperties(XPDictionaryStub, XPObjectStub, string[])

When implemented by a class, executes the corresponding ISerializableObjectLayerEx.LoadDelayedProperties overloaded method implementation of an object layer and returns the operation result.

OperationResult<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 delayed the theObject‘s properties whose values are loaded.

Returns

OperationResult<SerializableObjectLayerResult<object[]>>

An OperationResult<DevExpress.Xpo.SerializableObjectLayerResult`1[[System.Object> object denoting the operation result.

LoadDelayedProperty(XPDictionaryStub, XPObjectStubCollection, string)

When implemented by a class, executes the corresponding ISerializableObjectLayerEx.LoadDelayedProperties overloaded method implementation of an object layer and returns the operation result.

OperationResult<SerializableObjectLayerResult<object[]>> LoadDelayedProperty(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

OperationResult<SerializableObjectLayerResult<object[]>>

An OperationResult<DevExpress.Xpo.SerializableObjectLayerResult`1[[System.Object> object denoting the operation result.

LoadObjects(XPDictionaryStub, ObjectStubsQuery[])

When implemented by a class, executes an object layer’s ISerializableObjectLayer.LoadObjects method implementation and returns the operation result.

OperationResult<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

OperationResult<SerializableObjectLayerResult<XPObjectStubCollection[]>>

An OperationResult<DevExpress.Xpo.SerializableObjectLayerResult`1[[DevExpress.Xpo.XPObjectStubCollection> object denoting the operation result.

Purge()

When implemented by a class, executes an object layer’s ISerializableObjectLayer.Purge method implementation and returns the operation result.

OperationResult<PurgeResult> Purge()

Returns

OperationResult<PurgeResult>

An OperationResult<DevExpress.Xpo.Helpers.PurgeResult> object denoting the operation result.

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

When implemented by a class, executes an object layer’s ISerializableObjectLayer.SelectData method implementation and returns the operation result.

OperationResult<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

OperationResult<object[][]>

An OperationResult<object> object denoting the operation result.