Artemis/src/Artemis.Core/Services/Interfaces/IDataModelService.cs

using System;
using System.Collections.Generic;
using Artemis.Core.Annotations;
using Artemis.Core.Models.Profile.Conditions;
using Artemis.Core.Plugins;
using Artemis.Core.Plugins.DataModelExpansions;
using Newtonsoft.Json;

namespace Artemis.Core.Services.Interfaces
{
    public interface IDataModelService : IArtemisService
    {
        IReadOnlyCollection<DisplayConditionOperator> RegisteredConditionOperators { get; }
        IReadOnlyCollection<DataModel> DataModelExpansions { get; }

        /// <summary>
        ///     Add an expansion to the datamodel to be available for use after the next update
        /// </summary>
        /// <param name="baseDataModelExpansion"></param>
        void AddExpansion(DataModel baseDataModelExpansion);

        /// <summary>
        ///     Remove a previously added expansion so that it is no longer available and updated
        /// </summary>
        /// <param name="baseDataModelExpansion"></param>
        void RemoveExpansion(DataModel baseDataModelExpansion);

        /// <summary>
        ///     If found, returns the data model of the provided plugin
        /// </summary>
        /// <param name="plugin">Should be a module with a data model or a data model expansion</param>
        DataModel GetPluginDataModel(Plugin plugin);

        /// <summary>
        ///     If found, returns the data model of the provided plugin
        /// </summary>
        /// <param name="pluginGuid">Should be a module with a data model or a data model expansion</param>
        DataModel GetPluginDataModelByGuid(Guid pluginGuid);

        /// <summary>
        ///     Determines whether the given plugin expands the main data model
        /// </summary>
        /// <param name="plugin"></param>
        /// <returns></returns>
        bool GetPluginExtendsDataModel(Plugin plugin);

        /// <summary>
        ///     Registers a new condition operator for use in layer conditions
        /// </summary>
        /// <param name="pluginInfo">The PluginInfo of the plugin this condition operator belongs to</param>
        /// <param name="displayConditionOperator">The condition operator to register</param>
        void RegisterConditionOperator([NotNull] PluginInfo pluginInfo, [NotNull] DisplayConditionOperator displayConditionOperator);

        /// <summary>
        ///     Removes a condition operator so it is no longer available for use in layer conditions
        /// </summary>
        /// <param name="displayConditionOperator">The layer condition operator to remove</param>
        void RemoveConditionOperator([NotNull] DisplayConditionOperator displayConditionOperator);

        List<DisplayConditionOperator> GetCompatibleConditionOperators(Type type);
        DisplayConditionOperator GetConditionOperator(Guid operatorPluginGuid, string operatorType);
        void LogPredicateDeserializationFailure(DisplayConditionPredicate displayConditionPredicate, JsonException exception);
        void LogListPredicateDeserializationFailure(DisplayConditionListPredicate displayConditionListPredicate, JsonException exception);
    }
}