IEstateDataStore.cs 4.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120
  1. /*
  2. * Copyright (c) Contributors, http://opensimulator.org/
  3. * See CONTRIBUTORS.TXT for a full list of copyright holders.
  4. *
  5. * Redistribution and use in source and binary forms, with or without
  6. * modification, are permitted provided that the following conditions are met:
  7. * * Redistributions of source code must retain the above copyright
  8. * notice, this list of conditions and the following disclaimer.
  9. * * Redistributions in binary form must reproduce the above copyright
  10. * notice, this list of conditions and the following disclaimer in the
  11. * documentation and/or other materials provided with the distribution.
  12. * * Neither the name of the OpenSimulator Project nor the
  13. * names of its contributors may be used to endorse or promote products
  14. * derived from this software without specific prior written permission.
  15. *
  16. * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
  17. * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18. * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19. * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
  20. * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  21. * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  22. * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  23. * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24. * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  25. * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26. */
  27. using System.Collections.Generic;
  28. using OpenMetaverse;
  29. using OpenSim.Framework;
  30. namespace OpenSim.Region.Framework.Interfaces
  31. {
  32. public interface IEstateDataStore
  33. {
  34. /// <summary>
  35. /// Initialise the data store.
  36. /// </summary>
  37. /// <param name="connectstring"></param>
  38. void Initialise(string connectstring);
  39. /// <summary>
  40. /// Load estate settings for a region.
  41. /// </summary>
  42. /// <param name="regionID"></param>
  43. /// <param name="create">If true, then an estate is created if one is not found.</param>
  44. /// <returns></returns>
  45. EstateSettings LoadEstateSettings(UUID regionID, bool create);
  46. /// <summary>
  47. /// Load estate settings for an estate ID.
  48. /// </summary>
  49. /// <param name="estateID"></param>
  50. /// <returns></returns>
  51. EstateSettings LoadEstateSettings(int estateID);
  52. /// <summary>
  53. /// Create a new estate.
  54. /// </summary>
  55. /// <returns>
  56. /// A <see cref="EstateSettings"/>
  57. /// </returns>
  58. EstateSettings CreateNewEstate();
  59. /// <summary>
  60. /// Load/Get all estate settings.
  61. /// </summary>
  62. /// <returns>An empty list if no estates were found.</returns>
  63. List<EstateSettings> LoadEstateSettingsAll();
  64. /// <summary>
  65. /// Store estate settings.
  66. /// </summary>
  67. /// <remarks>
  68. /// This is also called by EstateSettings.Save()</remarks>
  69. /// <param name="es"></param>
  70. void StoreEstateSettings(EstateSettings es);
  71. /// <summary>
  72. /// Get estate IDs.
  73. /// </summary>
  74. /// <param name="search">Name of estate to search for. This is the exact name, no parttern matching is done.</param>
  75. /// <returns></returns>
  76. List<int> GetEstates(string search);
  77. /// <summary>
  78. /// Get the IDs of all estates owned by the given user.
  79. /// </summary>
  80. /// <returns>An empty list if no estates were found.</returns>
  81. List<int> GetEstatesByOwner(UUID ownerID);
  82. /// <summary>
  83. /// Get the IDs of all estates.
  84. /// </summary>
  85. /// <returns>An empty list if no estates were found.</returns>
  86. List<int> GetEstatesAll();
  87. /// <summary>
  88. /// Link a region to an estate.
  89. /// </summary>
  90. /// <param name="regionID"></param>
  91. /// <param name="estateID"></param>
  92. /// <returns>true if the link succeeded, false otherwise</returns>
  93. bool LinkRegion(UUID regionID, int estateID);
  94. /// <summary>
  95. /// Get the UUIDs of all the regions in an estate.
  96. /// </summary>
  97. /// <param name="estateID"></param>
  98. /// <returns></returns>
  99. List<UUID> GetRegions(int estateID);
  100. /// <summary>
  101. /// Delete an estate
  102. /// </summary>
  103. /// <param name="estateID"></param>
  104. /// <returns>true if the delete succeeded, false otherwise</returns>
  105. bool DeleteEstate(int estateID);
  106. }
  107. }