IAbuseReportsConnector.cs

/*
 * Copyright (c) Contributors, http://aurora-sim.org/
 * See CONTRIBUTORS.TXT for a full list of copyright holders.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the Aurora-Sim Project nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

using System.Collections.Generic;
using Aurora.Framework.Services;

namespace Aurora.Framework.DatabaseInterfaces
{
    public interface IAbuseReportsConnector : IAuroraDataPlugin
    {
        /// <summary>
        ///     Gets the abuse report associated with the number and uses the pass to authenticate.
        /// </summary>
        /// <param name="Number"></param>
        /// <param name="Password"></param>
        /// <returns></returns>
        AbuseReport GetAbuseReport(int Number, string Password);

        /// <summary>
        ///     Gets the abuse report associated with the number without authentication
        /// </summary>
        /// <param name="Number"></param>
        /// <returns></returns>
        AbuseReport GetAbuseReport(int Number);

        /// <summary>
        ///     Adds a new abuse report to the database
        /// </summary>
        /// <param name="report"></param>
        void AddAbuseReport(AbuseReport report);

        /// <summary>
        ///     Updates an abuse report and authenticates with the password.
        /// </summary>
        /// <param name="report"></param>
        /// <param name="Password"></param>
        void UpdateAbuseReport(AbuseReport report, string Password);

        /// <summary>
        ///     Updates an abuse report without authentication
        /// </summary>
        /// <param name="report"></param>
        void UpdateAbuseReport(AbuseReport report);

        /// <summary>
        ///     returns a collection of abuse reports
        /// </summary>
        /// <param name="start"></param>
        /// <param name="count"></param>
        /// <param name="active"></param>
        /// <returns></returns>
        List<AbuseReport> GetAbuseReports(int start, int count, bool active);
    }
}