using xModels.Base;

namespace xModels.Dtos {
    /// <summary>
    /// Request a Page of Data Based on Query ...
    /// this can used in every Data Providers ...
    /// </summary>
    public class XQuery : XBaseDto {
        /// <summary>
        /// an string for filtering results
        /// </summary>
        /// <value></value>
        public string Filter { get; set; } = null;

        /// <summary>
        /// determines fully load object with it's relational fields or not
        /// </summary>
        /// <value></value>
        public bool ContainsDetail { get; set; } = false;

        /// <summary>
        /// specifiy sorting of items
        /// </summary>
        /// <returns></returns>
        public string SortBy { get; set; } = nameof (XBaseIntIDEntity.Id);

        /// <summary>
        /// specify sorting direction
        /// </summary>
        /// <value></value>
        public bool IsAscending { get; set; } = true;

        /// <summary>
        /// specify page number
        /// </summary>
        /// <value></value>
        public int Page { get; set; } = 1;

        /// <summary>
        /// specify page size
        /// </summary>
        /// <value></value>
        public int PageSize { get; set; }
    }
}