IObjectSpace.GetObjects(Type, CriteriaOperator, IList<SortProperty>, Boolean) Method

Returns a sorted IList collection of objects of the specified type, retrieved to the current Object Space and filtered according to the specified criteria.

Namespace: DevExpress.ExpressApp

Assembly: DevExpress.ExpressApp.v18.2.dll

Declaration

C#

IList GetObjects(
    Type type,
    CriteriaOperator criteria,
    IList<SortProperty> sorting,
    bool inTransaction
)

VB.NET

Function GetObjects(
    type As Type,
    criteria As CriteriaOperator,
    sorting As IList(Of SortProperty),
    inTransaction As Boolean
) As IList

Parameters

Name	Type	Description
type	Type	The type of objects that are retrieved.
criteria	CriteriaOperator	A CriteriaOperator which specifies the criteria for object selection.
sorting	IList<SortProperty>	An IList<SortProperty> object that specifies sorting.
inTransaction	Boolean	true, if the filter takes unsaved changes into account; otherwise, false. Has effect in XPO only.

Returns

Type	Description
IList	A IList collection that contains the persistent objects of the specified type. Only objects that satisfy the specified criteria will be retrieved to this collection.

Remarks

The following example uses a Parametrized Action to search for a Person by LastName, and then assigns the deferred task with the nearest due date to that person.

C#

using System.Collections;
using System.Collections.Generic;
using DevExpress.Data.Filtering;
using DevExpress.ExpressApp;
using DevExpress.ExpressApp.Actions;
using DevExpress.Persistent.Base;
using DevExpress.Persistent.Base.General;
using DevExpress.Persistent.BaseImpl;
using DevExpress.Xpo;
using DevExpress.Xpo.DB;
// ...
public class AssignTasksController : ObjectViewController<ListView, MainDemo.Module.BusinessObjects.DemoTask> {
    public AssignTasksController() {
        ParametrizedAction assignTasksAction = new ParametrizedAction(
            this, "AssignTasks", PredefinedCategory.Edit, typeof(string));
        assignTasksAction.Execute += AssignTasksAction_Execute;
    }
    private void AssignTasksAction_Execute(object sender, ParametrizedActionExecuteEventArgs e) {
        IObjectSpace objectSpace = View.ObjectSpace;
        string personParamValue = e.ParameterCurrentValue as string;
        CriteriaOperator personCriteria = CriteriaOperator.Parse("Contains([LastName], ?)", personParamValue);
        Person person = (Person)objectSpace.FindObject(typeof(Person), personCriteria);
        if(person != null) {
            List<SortProperty> sorting = new List<SortProperty>();
            sorting.Add(new SortProperty("DueDate", SortingDirection.Descending));
            CriteriaOperator taskCriteria = CriteriaOperator.Parse("[Status] = ?", TaskStatus.Deferred);
            IList tasks = objectSpace.GetObjects(
                typeof(MainDemo.Module.BusinessObjects.DemoTask), taskCriteria, sorting, false);
            if(tasks.Count > 0) {
                MainDemo.Module.BusinessObjects.DemoTask task = (MainDemo.Module.BusinessObjects.DemoTask)tasks[0];
                task.AssignedTo = person;
            }
        }
    }
}

VB.NET

Imports System.Collections
Imports System.Collections.Generic
Imports DevExpress.Data.Filtering
Imports DevExpress.ExpressApp
Imports DevExpress.ExpressApp.Actions
Imports DevExpress.Persistent.Base
Imports DevExpress.Persistent.Base.General
Imports DevExpress.Persistent.BaseImpl
Imports DevExpress.Xpo
Imports DevExpress.Xpo.DB

Public Class AssignTasksController
    Inherits ObjectViewController(Of ListView, MainDemo.Module.BusinessObjects.DemoTask)
    Public Sub New()
        Dim assignTasksAction As New ParametrizedAction(Me, "AssignTasks", PredefinedCategory.Edit, GetType(String))
        AddHandler assignTasksAction.Execute, AddressOf AssignTasksAction_Execute
    End Sub
    Private Sub AssignTasksAction_Execute(ByVal sender As Object, ByVal e As ParametrizedActionExecuteEventArgs)
        Dim objectSpace As IObjectSpace = View.ObjectSpace
        Dim personParamValue As String = TryCast(e.ParameterCurrentValue, String)
        Dim personCriteria As CriteriaOperator = CriteriaOperator.Parse("Contains([LastName], ?)", personParamValue)
        Dim person As Person = CType(objectSpace.FindObject(GetType(Person), personCriteria), Person)
        If person IsNot Nothing Then
            Dim sorting As New List(Of SortProperty)()
            sorting.Add(New SortProperty("DueDate", SortingDirection.Descending))
            Dim taskCriteria As CriteriaOperator = CriteriaOperator.Parse("[Status] = ?", TaskStatus.Deferred)
            Dim tasks As IList = objectSpace.GetObjects( _
                GetType(MainDemo.Module.BusinessObjects.DemoTask), taskCriteria, sorting, False)
            If tasks.Count > 0 Then
                Dim task As MainDemo.Module.BusinessObjects.DemoTask = _
                    DirectCast(tasks(0), MainDemo.Module.BusinessObjects.DemoTask)
                task.AssignedTo = person
            End If
        End If
    End Sub
End Class

When implementing the IObjectSpace interface in the BaseObjectSpace class’s descendant, don’t implement the GetObjects method. It’s implemented in the BaseObjectSpace class. To get the specified objects, the BaseObjectSpace.GetObjects(Type type, CriteriaOperator criteria, bool inTransaction) method invokes a protected virtual CreateCollection method that does nothing and returns null. So, you should override the CreateCollection method in your descendant.