Merge pull request #32 from IgniteUI/add-remote-paging-capabilities

Add remote paging capabilities

Author: zdrawku

NorthwindCRUD/Controllers/CategoriesController.cs

@@ -13,13 +13,15 @@ public class CategoriesController : ControllerBase
     {
         private readonly CategoryService categoryService;
         private readonly ProductService productService;
+        private readonly PagingService pagingService;
         private readonly IMapper mapper;
         private readonly ILogger<CategoriesController> logger;
 
-        public CategoriesController(CategoryService categoryService, ProductService productService, IMapper mapper, ILogger<CategoriesController> logger)
+        public CategoriesController(CategoryService categoryService, ProductService productService, PagingService pagingService, IMapper mapper, ILogger<CategoriesController> logger)
         {
             this.categoryService = categoryService;
             this.productService = productService;
+            this.pagingService = pagingService;
             this.mapper = mapper;
             this.logger = logger;
         }
@@ -39,6 +41,33 @@ public ActionResult<CategoryDto[]> GetAll()
             }
         }
 
+        /// <summary>
+        /// Fetches all categories or a page of categories based on the provided parameters.
+        /// </summary>
+        /// <param name="skip">The number of records to skip before starting to fetch the categories. If this parameter is not provided, fetching starts from the beginning.</param>
+        /// <param name="top">The maximum number of categories to fetch. If this parameter is not provided, all categories are fetched.</param>
+        /// <param name="orderBy">A comma-separated list of fields to order the categories by, along with the sort direction (e.g., "field1 asc, field2 desc").</param>
+        /// <returns>A PagedResultDto object containing the fetched T and the total record count.</returns>
+        [HttpGet("GetPagedCategories")]
+        public ActionResult<PagedResultDto<ProductDto>> GetPagedCategories(int? skip, int? top, string? orderBy)
+        {
+            try
+            {
+                // Retrieve all categories
+                var categories = this.categoryService.GetAll();
+
+                // Get paged data
+                var pagedResult = pagingService.GetPagedData<CategoryDb, CategoryDto>(categories, skip, top, orderBy);
+
+                return Ok(pagedResult);
+            }
+            catch (Exception error)
+            {
+                logger.LogError(error.Message);
+                return StatusCode(500);
+            }
+        }
+
         [HttpGet("{id}")]
         public ActionResult<CategoryDto> GetById(int id)
         {

NorthwindCRUD/Controllers/CustomersController.cs

@@ -13,13 +13,15 @@ public class CustomersController : Controller
     {
         private readonly CustomerService customerService;
         private readonly OrderService orderService;
+        private readonly PagingService pagingService;
         private readonly IMapper mapper;
         private readonly ILogger<CustomersController> logger;
 
-        public CustomersController(CustomerService customerService, OrderService orderService, IMapper mapper, ILogger<CustomersController> logger)
+        public CustomersController(CustomerService customerService, OrderService orderService, PagingService pagingService, IMapper mapper, ILogger<CustomersController> logger)
         {
             this.customerService = customerService;
             this.orderService = orderService;
+            this.pagingService = pagingService;
             this.mapper = mapper;
             this.logger = logger;
         }
@@ -39,6 +41,33 @@ public ActionResult<CustomerDto[]> GetAll()
             }
         }
 
+        /// <summary>
+        /// Fetches all customers or a page of customers based on the provided parameters.
+        /// </summary>
+        /// <param name="skip">The number of records to skip before starting to fetch the customers. If this parameter is not provided, fetching starts from the beginning.</param>
+        /// <param name="top">The maximum number of customers to fetch. If this parameter is not provided, all customers are fetched.</param>
+        /// <param name="orderBy">A comma-separated list of fields to order the customers by, along with the sort direction (e.g., "field1 asc, field2 desc").</param>
+        /// <returns>A PagedResultDto object containing the fetched T and the total record count.</returns>
+        [HttpGet("GetPagedCustomers")]
+        public ActionResult<PagedResultDto<CustomerDto>> GetAllCustomers(int? skip, int? top, string? orderBy)
+        {
+            try
+            {
+                // Retrieve all customers
+                var customers = this.customerService.GetAll();
+
+                // Get paged data
+                var pagedResult = pagingService.GetPagedData<CustomerDb, CustomerDto>(customers, skip, top, orderBy);
+
+                return Ok(pagedResult);
+            }
+            catch (Exception error)
+            {
+                logger.LogError(error.Message);
+                return StatusCode(500);
+            }
+        }
+
         [HttpGet("{id}")]
         public ActionResult<CustomerDto> GetById(string id)
         {

NorthwindCRUD/Controllers/EmployeesController.cs

@@ -14,13 +14,15 @@ public class EmployeesController : Controller
         private readonly EmployeeService employeeService;
         private readonly EmployeeTerritoryService employeeTerritoryService;
         private readonly OrderService ordersService;
+        private readonly PagingService pagingService;
         private readonly IMapper mapper;
         private readonly ILogger<EmployeesController> logger;
 
-        public EmployeesController(EmployeeService employeeService, EmployeeTerritoryService employeeTerritoryService, OrderService ordersService, IMapper mapper, ILogger<EmployeesController> logger)
+        public EmployeesController(EmployeeService employeeService, EmployeeTerritoryService employeeTerritoryService, OrderService ordersService, PagingService pagingService, IMapper mapper, ILogger<EmployeesController> logger)
         {
             this.employeeService = employeeService;
             this.employeeTerritoryService = employeeTerritoryService;
+            this.pagingService = pagingService;
             this.ordersService = ordersService;
             this.mapper = mapper;
             this.logger = logger;
@@ -41,6 +43,33 @@ public ActionResult<EmployeeDto[]> GetAll()
             }
         }
 
+        /// <summary>
+        /// Fetches all employees or a page of employees based on the provided parameters.
+        /// </summary>
+        /// <param name="skip">The number of records to skip before starting to fetch the employees. If this parameter is not provided, fetching starts from the beginning.</param>
+        /// <param name="top">The maximum number of employees to fetch. If this parameter is not provided, all employees are fetched.</param>
+        /// <param name="orderBy">A comma-separated list of fields to order the employees by, along with the sort direction (e.g., "field1 asc, field2 desc").</param>
+        /// <returns>A PagedResultDto object containing the fetched T and the total record count.</returns>
+        [HttpGet("GetPagedEmployees")]
+        public ActionResult<PagedResultDto<EmployeeDto>> GetAllEmployees(int? skip, int? top, string? orderBy)
+        {
+            try
+            {
+                // Retrieve all employees
+                var employees = this.employeeService.GetAll();
+
+                // Get paged data
+                var pagedResult = pagingService.GetPagedData<EmployeeDb, EmployeeDto>(employees, skip, top, orderBy);
+
+                return Ok(pagedResult);
+            }
+            catch (Exception error)
+            {
+                logger.LogError(error.Message);
+                return StatusCode(500);
+            }
+        }
+
         [HttpGet("{id}")]
         public ActionResult<EmployeeDto> GetById(int id)
         {

NorthwindCRUD/Controllers/OrdersController.cs

@@ -17,16 +17,18 @@ public class OrdersController : ControllerBase
         private readonly CustomerService customerService;
         private readonly ShipperService shipperService;
         private readonly ProductService productService;
+        private readonly PagingService pagingService;
         private readonly IMapper mapper;
         private readonly ILogger<OrdersController> logger;
 
-        public OrdersController(OrderService orderService, EmployeeService employeeService, CustomerService customerService, ShipperService shipperService, ProductService productService, IMapper mapper, ILogger<OrdersController> logger)
+        public OrdersController(OrderService orderService, EmployeeService employeeService, CustomerService customerService, ShipperService shipperService, ProductService productService, PagingService pagingService, IMapper mapper, ILogger<OrdersController> logger)
         {
             this.orderService = orderService;
             this.employeeService = employeeService;
             this.customerService = customerService;
             this.shipperService = shipperService;
             this.productService = productService;
+            this.pagingService = pagingService;
             this.mapper = mapper;
             this.logger = logger;
         }
@@ -46,6 +48,33 @@ public ActionResult<OrderDto[]> GetAll()
             }
         }
 
+        /// <summary>
+        /// Fetches all orders or a page of orders based on the provided parameters.
+        /// </summary>
+        /// <param name="skip">The number of records to skip before starting to fetch the orders. If this parameter is not provided, fetching starts from the beginning.</param>
+        /// <param name="top">The maximum number of orders to fetch. If this parameter is not provided, all orders are fetched.</param>
+        /// <param name="orderBy">A comma-separated list of fields to order the orders by, along with the sort direction (e.g., "field1 asc, field2 desc").</param>
+        /// <returns>A PagedResultDto object containing the fetched T and the total record count.</returns>
+        [HttpGet("GetPagedOrders")]
+        public ActionResult<PagedResultDto<OrderDto>> GetAllOrders(int? skip, int? top, string? orderBy)
+        {
+            try
+            {
+                // Retrieve all orders
+                var orders = this.orderService.GetAll();
+
+                // Get paged data
+                var pagedResult = pagingService.GetPagedData<OrderDb, OrderDto>(orders, skip, top, orderBy);
+
+                return Ok(pagedResult);
+            }
+            catch (Exception error)
+            {
+                logger.LogError(error.Message);
+                return StatusCode(500);
+            }
+        }
+
         [HttpGet("{id}")]
         public ActionResult<OrderDto> GetById(int id)
         {

NorthwindCRUD/Controllers/ProductsController.cs

@@ -1,5 +1,7 @@
 namespace NorthwindCRUD.Controllers
 {
+    using System.Globalization;
+    using System.Reflection;
     using AutoMapper;
     using Microsoft.AspNetCore.Authorization;
     using Microsoft.AspNetCore.Mvc;
@@ -15,15 +17,17 @@ public class ProductsController : ControllerBase
         private readonly CategoryService categoryService;
         private readonly OrderService orderService;
         private readonly SupplierService supplierService;
+        private readonly PagingService pagingService;
         private readonly IMapper mapper;
         private readonly ILogger<ProductsController> logger;
 
-        public ProductsController(ProductService productService, CategoryService categoryService, OrderService orderService, SupplierService supplierService, IMapper mapper, ILogger<ProductsController> logger)
+        public ProductsController(ProductService productService, CategoryService categoryService, OrderService orderService, SupplierService supplierService, PagingService pagingService, IMapper mapper, ILogger<ProductsController> logger)
         {
             this.productService = productService;
             this.categoryService = categoryService;
             this.orderService = orderService;
             this.supplierService = supplierService;
+            this.pagingService = pagingService;
             this.mapper = mapper;
             this.logger = logger;
         }
@@ -43,6 +47,33 @@ public ActionResult<ProductDto[]> GetAll()
             }
         }
 
+        /// <summary>
+        /// Fetches all products or a page of products based on the provided parameters.
+        /// </summary>
+        /// <param name="skip">The number of records to skip before starting to fetch the products. If this parameter is not provided, fetching starts from the beginning.</param>
+        /// <param name="top">The maximum number of products to fetch. If this parameter is not provided, all products are fetched.</param>
+        /// <param name="orderBy">A comma-separated list of fields to order the products by, along with the sort direction (e.g., "field1 asc, field2 desc").</param>
+        /// <returns>A PagedResultDto object containing the fetched T and the total record count.</returns>
+        [HttpGet("GetPagedProducts")]
+        public ActionResult<PagedResultDto<ProductDto>> GetAllProducts(int? skip, int? top, string? orderBy)
+        {
+            try
+            {
+                // Retrieve all products
+                var products = this.productService.GetAll();
+
+                // Get paged data
+                var pagedResult = pagingService.GetPagedData<ProductDb, ProductDto>(products, skip, top, orderBy);
+
+                return Ok(pagedResult);
+            }
+            catch (Exception error)
+            {
+                logger.LogError(error.Message);
+                return StatusCode(500);
+            }
+        }
+
         [HttpGet("{id}")]
         public ActionResult<ProductDto> GetById(int id)
         {

NorthwindCRUD/Controllers/RegionsController.cs

@@ -14,13 +14,15 @@ public class RegionsController : ControllerBase
     {
         private readonly RegionService regionService;
         private readonly TerritoryService territoryService;
+        private readonly PagingService pagingService;
         private readonly IMapper mapper;
         private readonly ILogger<RegionsController> logger;
 
-        public RegionsController(RegionService regionService, TerritoryService territoryService, IMapper mapper, ILogger<RegionsController> logger)
+        public RegionsController(RegionService regionService, TerritoryService territoryService, PagingService pagingService, IMapper mapper, ILogger<RegionsController> logger)
         {
             this.regionService = regionService;
             this.territoryService = territoryService;
+            this.pagingService = pagingService;
             this.mapper = mapper;
             this.logger = logger;
         }
@@ -40,6 +42,33 @@ public ActionResult<RegionDto[]> GetAll()
             }
         }
 
+        /// <summary>
+        /// Fetches all regions or a page of regions based on the provided parameters.
+        /// </summary>
+        /// <param name="skip">The number of records to skip before starting to fetch the regions. If this parameter is not provided, fetching starts from the beginning.</param>
+        /// <param name="top">The maximum number of regions to fetch. If this parameter is not provided, all regions are fetched.</param>
+        /// <param name="orderBy">A comma-separated list of fields to order the regions by, along with the sort direction (e.g., "field1 asc, field2 desc").</param>
+        /// <returns>A PagedResultDto object containing the fetched T and the total record count.</returns>
+        [HttpGet("GetPagedRegions")]
+        public ActionResult<PagedResultDto<RegionDto>> GetAllRegions(int? skip, int? top, string? orderBy)
+        {
+            try
+            {
+                // Retrieve all regions
+                var regions = this.regionService.GetAll();
+
+                // Get paged data
+                var pagedResult = pagingService.GetPagedData<RegionDb, RegionDto>(regions, skip, top, orderBy);
+
+                return Ok(pagedResult);
+            }
+            catch (Exception error)
+            {
+                logger.LogError(error.Message);
+                return StatusCode(500);
+            }
+        }
+
         [HttpGet("{id}")]
         public ActionResult<RegionDto> GetById(int id)
         {

NorthwindCRUD/Controllers/ShippersController.cs

@@ -14,13 +14,15 @@ public class ShippersController : ControllerBase
     {
         private readonly ShipperService shipperService;
         private readonly OrderService orderService;
+        private readonly PagingService pagingService;
         private readonly IMapper mapper;
         private readonly ILogger<ShippersController> logger;
 
-        public ShippersController(ShipperService shipperService, OrderService orderService, IMapper mapper, ILogger<ShippersController> logger)
+        public ShippersController(ShipperService shipperService, OrderService orderService, PagingService pagingService, IMapper mapper, ILogger<ShippersController> logger)
         {
             this.shipperService = shipperService;
             this.orderService = orderService;
+            this.pagingService = pagingService;
             this.mapper = mapper;
             this.logger = logger;
         }
@@ -40,6 +42,33 @@ public ActionResult<ShipperDto[]> GetAll()
             }
         }
 
+        /// <summary>
+        /// Fetches all shippers or a page of shippers based on the provided parameters.
+        /// </summary>
+        /// <param name="skip">The number of records to skip before starting to fetch the shippers. If this parameter is not provided, fetching starts from the beginning.</param>
+        /// <param name="top">The maximum number of shippers to fetch. If this parameter is not provided, all shippers are fetched.</param>
+        /// <param name="orderBy">A comma-separated list of fields to order the shippers by, along with the sort direction (e.g., "field1 asc, field2 desc").</param>
+        /// <returns>A PagedResultDto object containing the fetched T and the total record count.</returns>
+        [HttpGet("GetPagedShippers")]
+        public ActionResult<PagedResultDto<ShipperDto>> GetAllShippers(int? skip, int? top, string? orderBy)
+        {
+            try
+            {
+                // Retrieve all shippers
+                var shippers = this.shipperService.GetAll();
+
+                // Get paged data
+                var pagedResult = pagingService.GetPagedData<ShipperDb, ShipperDto>(shippers, skip, top, orderBy);
+
+                return Ok(pagedResult);
+            }
+            catch (Exception error)
+            {
+                logger.LogError(error.Message);
+                return StatusCode(500);
+            }
+        }
+
         [HttpGet("{id}")]
         public ActionResult<ShipperDto> GetById(int id)
         {