baseline: OpenMU upstream b5a0961 (fresh source)

src/Persistence/IPersistenceContextProvider.cs

@@ -0,0 +1,86 @@
+// <copyright file="IPersistenceContextProvider.cs" company="MUnique">
+// Licensed under the MIT License. See LICENSE file in the project root for full license information.
+// </copyright>
+
+namespace MUnique.OpenMU.Persistence;
+
+using MUnique.OpenMU.DataModel.Configuration;
+using MUnique.OpenMU.DataModel.Entities;
+using MUnique.OpenMU.Interfaces;
+
+/// <summary>
+/// Provider for persistence contexts.
+/// </summary>
+public interface IPersistenceContextProvider
+{
+    /// <summary>
+    /// Gets the repository provider.
+    /// </summary>
+    IRepositoryProvider RepositoryProvider { get; }
+
+    /// <summary>
+    /// Creates a new context which doesn't use any caching.
+    /// </summary>
+    /// <returns>The newly created context.</returns>
+    IContext CreateNewContext();
+
+    /// <summary>
+    /// Creates a new context.
+    /// </summary>
+    /// <param name="gameConfiguration">The game configuration.</param>
+    /// <returns>
+    /// The newly created context.
+    /// </returns>
+    IContext CreateNewContext(GameConfiguration gameConfiguration);
+
+    /// <summary>
+    /// Creates a new context which should be used to load the configuration.
+    /// It's not tracking changes.
+    /// </summary>
+    /// <returns>
+    /// The newly created context.
+    /// </returns>
+    IConfigurationContext CreateNewConfigurationContext();
+
+    /// <summary>
+    /// Creates the new trade context which is used to exchange items in a trade.
+    /// </summary>
+    /// <returns>The newly created context.</returns>
+    IContext CreateNewTradeContext();
+
+    /// <summary>
+    /// Creates a new context which is used for accounts.
+    /// This context should only care about the objects of a player;
+    /// It should not track changes of configuration objects.
+    /// </summary>
+    /// <param name="gameConfiguration">The game configuration.</param>
+    /// <returns>
+    /// The newly created account context.
+    /// </returns>
+    IPlayerContext CreateNewPlayerContext(GameConfiguration gameConfiguration);
+
+    /// <summary>
+    /// Creates a new context which is used by the friend server.
+    /// It manages basically only <see cref="FriendViewItem"/>s.
+    /// </summary>
+    /// <returns>A new context which is used by the friend server.</returns>
+    IFriendServerContext CreateNewFriendServerContext();
+
+    /// <summary>
+    /// Creates a new context which is used by the guild server.
+    /// It manages basically only <see cref="MUnique.OpenMU.Interfaces.Guild"/>s and <see cref="GuildMember"/>s.
+    /// </summary>
+    /// <returns>A new context which is used by the guild server.</returns>
+    IGuildServerContext CreateNewGuildContext();
+
+    /// <summary>
+    /// Creates the new context which can be used to load and edit an object of <paramref name="editType"/>.
+    /// </summary>
+    /// <param name="editType">The type of object which should be handled.</param>
+    /// <param name="useCache">Flag, if the cache should be used.</param>
+    /// <param name="gameConfiguration">The game configuration.</param>
+    /// <returns>
+    /// A new context which can be used to load and edit an object of <paramref name="editType"/>.
+    /// </returns>
+    IContext CreateNewTypedContext(Type editType, bool useCache, GameConfiguration? gameConfiguration = null);
+}