//******************************************************************************************************
//  IPagedList.cs - Gbtc
//
//  Copyright © 2016, Grid Protection Alliance.  All Rights Reserved.
//
//  Licensed to the Grid Protection Alliance (GPA) under one or more contributor license agreements. See
//  the NOTICE file distributed with this work for additional information regarding copyright ownership.
//  The GPA licenses this file to you under the MIT License (MIT), the "License"; you may
//  not use this file except in compliance with the License. You may obtain a copy of the License at:
//
//      http://opensource.org/licenses/MIT
//
//  Unless agreed to in writing, the subject software distributed under the License is distributed on an
//  "AS-IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. Refer to the
//  License for the specific language governing permissions and limitations.
//
//  Code Modification History:
//  ----------------------------------------------------------------------------------------------------
//  02/17/2016 - J. Ritchie Carroll
//       Generated original version of source code.
//
//******************************************************************************************************

using System.Collections;

namespace GSF.Collections
{
    /// <summary>
    /// Defines an interface for <see cref="PagedList{T}"/> instances that is usable
    /// regardless of any specified type.
    /// </summary>
    public interface IPagedList : IList
    {
        /// <summary>
        /// Gets total count of elements in enumeration.
        /// </summary>
        int TotalCount
        {
            get;
        }

        /// <summary>
        /// Gets calculated page count based on page size and total items count.
        /// </summary>
        int PageCount
        {
            get;
        }

        /// <summary>
        /// Gets current page number.
        /// </summary>
        int Page
        {
            get;
        }

        /// <summary>
        /// Gets current page size.
        /// </summary>
        int PageSize
        {
            get;
        }
    }
}